window_manager
This plugin allows Flutter desktop apps to resizing and repositioning the window.
English | 简体中文
- window_manager
- Platform Support
- Quick Start
- Who's using it?
- API
- WindowManager
- Methods
- close
- isPreventClose
- setPreventClose
- focus
- blur
macoswindows - isFocused
macoswindows - show
- hide
- isVisible
- isMaximized
- maximize
- unmaximize
- isMinimized
- minimize
- restore
- isFullScreen
- setFullScreen
- setAspectRatio
- setBackgroundColor
- getBounds
- setBounds
- getPosition
- setAlignment
- center
- setPosition
- getSize
- setSize
- setMinimumSize
- setMaximumSize
- isResizable
- setResizable
- isMovable
macos - setMovable
macos - isMinimizable
macoswindows - setMinimizable
macoswindows - isClosable
macoswindows - setClosable
macoswindows - isAlwaysOnTop
- setAlwaysOnTop
- getTitle
- setTitle
- setTitleBarStyle
macoswindows - getTitleBarHeight
macoswindows - setSkipTaskbar
- setProgressBar
macos - hasShadow
macos - setHasShadow
macos - getOpacity
macoswindows - setOpacity
macoswindows - startDragging
- Methods
- WindowListener
- WindowManager
- License
Platform Support
| Linux | macOS | Windows |
|---|---|---|
Quick Start
Installation
Add this to your package's pubspec.yaml file:
dependencies:
window_manager: ^0.1.7Or
dependencies:
window_manager:
git:
url: https://github.com/leanflutter/window_manager.git
ref: mainUsage
import 'package:flutter/material.dart';
import 'package:window_manager/window_manager.dart';
void main() async {
WidgetsFlutterBinding.ensureInitialized();
// Must add this line.
await windowManager.ensureInitialized();
// Use it only after calling `hiddenWindowAtLaunch`
windowManager.waitUntilReadyToShow().then((_) async{
// Hide window title bar
await windowManager.setTitleBarStyle('hidden');
await windowManager.setSize(Size(800, 600));
await windowManager.center();
await windowManager.show();
await windowManager.setSkipTaskbar(false);
});
runApp(MyApp());
}
Please see the example app of this plugin for a full example.
Listening events
import 'package:flutter/cupertino.dart';
import 'package:window_manager/window_manager.dart';
class HomePage extends StatefulWidget {
@override
_HomePageState createState() => _HomePageState();
}
class _HomePageState extends State<HomePage> with WindowListener {
@override
void initState() {
windowManager.addListener(this);
super.initState();
}
@override
void dispose() {
windowManager.removeListener(this);
super.dispose();
}
@override
Widget build(BuildContext context) {
// ...
}
@override
void onWindowEvent(String eventName) {
print('[WindowManager] onWindowEvent: $eventName');
}
@override
void onWindowClose() {
// do something
}
@override
void onWindowFocus() {
// do something
}
@override
void onWindowBlur() {
// do something
}
@override
void onWindowMaximize() {
// do something
}
@override
void onWindowUnmaximize() {
// do something
}
@override
void onWindowMinimize() {
// do something
}
@override
void onWindowRestore() {
// do something
}
@override
void onWindowResize() {
// do something
}
@override
void onWindowMove() {
// do something
}
@override
void onWindowEnterFullScreen() {
// do something
}
@override
void onWindowLeaveFullScreen() {
// do something
}
}Quit on close
If you need to use the hide method, you need to disable QuitOnClose.
macOS
Change the file macos/Runner/AppDelegate.swift as follows:
import Cocoa
import FlutterMacOS
@NSApplicationMain
class AppDelegate: FlutterAppDelegate {
override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool {
- return true
+ return false
}
}Windows
Change the file windows/runner/main.cpp as follows:
int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev,
_In_ wchar_t *command_line, _In_ int show_command) {
// ...
- window.SetQuitOnClose(true);
+ window.SetQuitOnClose(false);
// ...
return EXIT_SUCCESS;
}Confirm before closing
import 'package:flutter/cupertino.dart';
import 'package:window_manager/window_manager.dart';
class HomePage extends StatefulWidget {
@override
_HomePageState createState() => _HomePageState();
}
class _HomePageState extends State<HomePage> with WindowListener {
@override
void initState() {
windowManager.addListener(this);
super.initState();
}
void _init() async {
// Add this line to override the default close handler
await windowManager.setPreventClose(true);
setState(() {});
}
@override
void dispose() {
windowManager.removeListener(this);
super.dispose();
}
@override
Widget build(BuildContext context) {
// ...
}
@override
void onWindowClose() async {
bool _isPreventClose = await windowManager.isPreventClose();
if (_isPreventClose) {
showDialog(
context: context,
builder: (_) {
return AlertDialog(
title: Text('Are you sure you want to close this window?'),
actions: [
TextButton(
child: Text('No'),
onPressed: () {
Navigator.of(context).pop();
},
),
TextButton(
child: Text('Yes'),
onPressed: () {
Navigator.of(context).pop();
exit(0);
},
),
],
);
},
);
}
}
}Hidden at launch
macOS
Change the file macos/Runner/MainFlutterWindow.swift as follows:
import Cocoa
import FlutterMacOS
+import window_manager
class MainFlutterWindow: NSWindow {
override func awakeFromNib() {
let flutterViewController = FlutterViewController.init()
let windowFrame = self.frame
self.contentViewController = flutterViewController
self.setFrame(windowFrame, display: true)
RegisterGeneratedPlugins(registry: flutterViewController)
super.awakeFromNib()
}
+ override public func order(_ place: NSWindow.OrderingMode, relativeTo otherWin: Int) {
+ super.order(place, relativeTo: otherWin)
+ hiddenWindowAtLaunch()
+ }
}
Windows
Change the file windows/runner/win32_window.cpp as follows:
bool Win32Window::CreateAndShow(const std::wstring& title,
const Point& origin,
const Size& size) {
...
HWND window = CreateWindow(
- window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE,
+ window_class, title.c_str(),
+ WS_OVERLAPPEDWINDOW, // do not add WS_VISIBLE since the window will be shown later
Scale(origin.x, scale_factor), Scale(origin.y, scale_factor),
Scale(size.width, scale_factor), Scale(size.height, scale_factor),
nullptr, nullptr, GetModuleHandle(nullptr), this);Make sure to call setState once on the onWindowFocus event.
import 'package:flutter/cupertino.dart';
import 'package:window_manager/window_manager.dart';
class HomePage extends StatefulWidget {
@override
_HomePageState createState() => _HomePageState();
}
class _HomePageState extends State<HomePage> with WindowListener {
@override
void initState() {
windowManager.addListener(this);
super.initState();
}
@override
void dispose() {
windowManager.removeListener(this);
super.dispose();
}
@override
Widget build(BuildContext context) {
// ...
}
@override
void onWindowFocus() {
// Make sure to call once.
setState(() {});
// do something
}
}
Who's using it?
- AuthPass - Password Manager based on Flutter for all platforms. Keepass 2.x (kdbx 3.x) compatible.
- Biyi (比译) - A convenient translation and dictionary app written in dart / Flutter.
- BlueBubbles - BlueBubbles is an ecosystem of apps bringing iMessage to Android, Windows, and Linux
- Yukino - Yukino lets you read manga or stream anime ad-free from multiple sources.
- LunaSea - A self-hosted controller for mobile and macOS built using the Flutter framework.
API
WindowManager
Methods
close
Try to close the window.
isPreventClose
Check if is intercepting the native close signal.
setPreventClose
Set if intercept the native close signal. May useful when combine with the onclose event listener. This will also prevent the manually triggered close event.
focus
Focuses on the window.
blur macos windows
Removes focus from the window.
isFocused macos windows
Returns bool - Whether window is focused.
show
Shows and gives focus to the window.
hide
Hides the window.
isVisible
Returns bool - Whether the window is visible to the user.
isMaximized
Returns bool - Whether the window is maximized.
maximize
Maximizes the window.
unmaximize
Unmaximizes the window.
isMinimized
Returns bool - Whether the window is minimized.
minimize
Minimizes the window. On some platforms the minimized window will be shown in the Dock.
restore
Restores the window from minimized state to its previous state.
isFullScreen
Returns bool - Whether the window is in fullscreen mode.
setFullScreen
Sets whether the window should be in fullscreen mode.
setAspectRatio
This will make a window maintain an aspect ratio.
setBackgroundColor
Sets the background color of the window.
getBounds
Returns Rect - The bounds of the window as Object.
setBounds
Resizes and moves the window to the supplied bounds.
getPosition
Returns Offset - Contains the window's current position.
setAlignment
Move the window to a position aligned with the screen.
center
Moves window to the center of the screen.
setPosition
Moves window to position.
getSize
Returns Size - Contains the window's width and height.
setSize
Resizes the window to width and height.
setMinimumSize
Sets the minimum size of window to width and height.
setMaximumSize
Sets the maximum size of window to width and height.
isResizable
Returns bool - Whether the window can be manually resized by the user.
setResizable
Sets whether the window can be manually resized by the user.
isMovable macos
Returns bool - Whether the window can be moved by user.
setMovable macos
Sets whether the window can be moved by user.
isMinimizable macos windows
Returns bool - Whether the window can be manually minimized by the user.
setMinimizable macos windows
Sets whether the window can be manually minimized by user.
isClosable macos windows
Returns bool - Whether the window can be manually closed by user.
setClosable macos windows
Sets whether the window can be manually closed by user.
isAlwaysOnTop
Returns bool - Whether the window is always on top of other windows.
setAlwaysOnTop
Sets whether the window should show always on top of other windows.
getTitle
Returns String - The title of the native window.
setTitle
Changes the title of native window to title.
setTitleBarStyle macos windows
Changes the title bar style of native window.
getTitleBarHeight macos windows
Returns int - The title bar height of the native window.
setSkipTaskbar
Makes the window not show in the taskbar / dock.
setProgressBar macos
Sets progress value in progress bar. Valid range is [0, 1.0].
hasShadow macos
Returns bool - Whether the window has a shadow.
setHasShadow macos
Sets whether the window should have a shadow.
getOpacity macos windows
Returns double - between 0.0 (fully transparent) and 1.0 (fully opaque). On Linux, always returns 1.
setOpacity macos windows
Sets the opacity of the window.
startDragging
Starts a window drag based on the specified mouse-down event.
WindowListener
Methods
onWindowClose
Emitted when the window is going to be closed.
onWindowFocus
Emitted when the window gains focus.
onWindowBlur
Emitted when the window loses focus.
onWindowMaximize
Emitted when window is maximized.
onWindowUnmaximize
Emitted when the window exits from a maximized state.
onWindowMinimize
Emitted when the window is minimized.
onWindowRestore
Emitted when the window is restored from a minimized state.
onWindowResize
Emitted after the window has been resized.
onWindowMove
Emitted when the window is being moved to a new position.
onWindowEnterFullScreen
Emitted when the window enters a full-screen state.
onWindowLeaveFullScreen
Emitted when the window leaves a full-screen state.
onWindowEvent
Emitted all events.