window_manager

Description:

window manager

window_manager #

This plugin allows Flutter desktop apps to resizing and repositioning the window.

English | 简体中文




Platform Support
Quick Start

Installation
Usage

Listening events
Quit on close

macOS


Confirm before closing
Hidden at launch

Linux
macOS
Windows






Articles
Who's using it?
API

WindowManager

Methods

waitUntilReadyToShow
destroy
close
isPreventClose
setPreventClose
focus
blur macos windows
isFocused macos windows
show
hide
isVisible
isMaximized
maximize
unmaximize
isMinimized
minimize
restore
isFullScreen
setFullScreen
isDockable windows
isDocked windows
dock windows
undock windows
setAspectRatio
setBackgroundColor
setAlignment
center
getBounds
setBounds
getSize
setSize
getPosition
setPosition
setMinimumSize
setMaximumSize
isResizable
setResizable
isMovable macos
setMovable macos
isMinimizable macos windows
setMinimizable macos windows
isClosable windows
isMaximizable macos windows
setMaximizable
setClosable macos windows
isAlwaysOnTop
setAlwaysOnTop
isAlwaysOnBottom
setAlwaysOnBottom linux windows
getTitle
setTitle
setTitleBarStyle
getTitleBarHeight
isSkipTaskbar
setSkipTaskbar
setProgressBar macos windows
setIcon windows
isVisibleOnAllWorkspaces macos
setVisibleOnAllWorkspaces macos
setBadgeLabel macos
hasShadow macos windows
setHasShadow macos windows
getOpacity
setOpacity
setBrightness
setIgnoreMouseEvents
startDragging
startResizing linux windows
grabKeyboard linux
ungrabKeyboard linux




WindowListener

Methods

onWindowClose
onWindowFocus
onWindowBlur
onWindowMaximize
onWindowUnmaximize
onWindowMinimize
onWindowRestore
onWindowResize
onWindowResized macos windows
onWindowMove
onWindowMoved macos windows
onWindowEnterFullScreen
onWindowLeaveFullScreen
onWindowDocked windows
onWindowUndocked windows
onWindowEvent






Contributors
License


Platform Support #



Linux
macOS
Windows




✔️
✔️
✔️



Quick Start #
Installation #
Add this to your package's pubspec.yaml file:
dependencies:
window_manager: ^0.4.2
copied to clipboard
Or
dependencies:
window_manager:
git:
url: https://github.com/leanflutter/window_manager.git
ref: main
copied to clipboard
Usage #
import 'package:flutter/material.dart';
import 'package:window_manager/window_manager.dart';

void main() async {
WidgetsFlutterBinding.ensureInitialized();
// Must add this line.
await windowManager.ensureInitialized();

WindowOptions windowOptions = WindowOptions(
size: Size(800, 600),
center: true,
backgroundColor: Colors.transparent,
skipTaskbar: false,
titleBarStyle: TitleBarStyle.hidden,
);
windowManager.waitUntilReadyToShow(windowOptions, () async {
await windowManager.show();
await windowManager.focus();
});

runApp(MyApp());
}

copied to clipboard

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() {
super.initState();
windowManager.addListener(this);
}

@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
}
}
copied to clipboard
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
}
}
copied to clipboard
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() {
super.initState();
windowManager.addListener(this);
_init();
}

@override
void dispose() {
windowManager.removeListener(this);
super.dispose();
}

void _init() async {
// Add this line to override the default close handler
await windowManager.setPreventClose(true);
setState(() {});
}

@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();
await windowManager.destroy();
},
),
],
);
},
);
}
}
}
copied to clipboard
Hidden at launch
Linux
Change the file linux/my_application.cc as follows:

...

// Implements GApplication::activate.
static void my_application_activate(GApplication* application) {

...

gtk_window_set_default_size(window, 1280, 720);
- gtk_widget_show(GTK_WIDGET(window));
+ gtk_widget_realize(GTK_WIDGET(window));

g_autoptr(FlDartProject) project = fl_dart_project_new();
fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments);

FlView* view = fl_view_new(project);
gtk_widget_show(GTK_WIDGET(view));
gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view));

fl_register_plugins(FL_PLUGIN_REGISTRY(view));

gtk_widget_grab_focus(GTK_WIDGET(view));
}

...

copied to clipboard
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()
+ }
}

copied to clipboard
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);
copied to clipboard
Since flutter 3.7 new windows project
Change the file windows/runner/flutter_window.cpp as follows:
bool FlutterWindow::OnCreate() {
...
flutter_controller_->engine()->SetNextFrameCallback([&]() {
- this->Show();
+ "" //delete this->Show()
});
copied to clipboard
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() {
super.initState();
windowManager.addListener(this);
}

@override
void dispose() {
windowManager.removeListener(this);
super.dispose();
}

@override
Widget build(BuildContext context) {
// ...
}

@override
void onWindowFocus() {
// Make sure to call once.
setState(() {});
// do something
}
}

copied to clipboard
Articles #

Click the dock icon to restore after closing the window
Making the app single-instanced

Who's using it? #

Airclap - Send any file to any device. cross platform, ultra fast and easy to use.
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
LunaSea - A self-hosted controller for mobile and macOS built using the Flutter framework.
Linwood Butterfly - Open source note taking app written in Flutter
RustDesk - Yet another remote desktop software, written in Rust. Works out of the box, no configuration required.
Ubuntu Desktop Installer - This project is a modern implementation of the Ubuntu Desktop installer.
UniControlHub - Seamlessly bridge your Desktop and Mobile devices

API #

WindowManager #
Methods
waitUntilReadyToShow
Wait until ready to show.
destroy
Force closing the window.
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. vertically simulates aero snap, only works on Windows
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.
isDockable windows
Returns bool - Whether the window is dockable or not.
isDocked windows
Returns bool - Whether the window is docked.
dock windows
Docks the window. only works on Windows
undock windows
Undocks the window. only works on Windows
setAspectRatio
This will make a window maintain an aspect ratio.
setBackgroundColor
Sets the background color of the window.
setAlignment
Move the window to a position aligned with the screen.
center
Moves window to the center of the screen.
getBounds
Returns Rect - The bounds of the window as Object.
setBounds
Resizes and moves the window to the supplied bounds.
getSize
Returns Size - Contains the window's width and height.
setSize
Resizes the window to width and height.
getPosition
Returns Offset - Contains the window's current position.
setPosition
Moves window to position.
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 windows
Returns bool - Whether the window can be manually closed by user.
isMaximizable macos windows
Returns bool - Whether the window can be manually maximized by the user.
setMaximizable
Sets whether the window can be manually maximized by the 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.
isAlwaysOnBottom
Returns bool - Whether the window is always below other windows.
setAlwaysOnBottom linux windows
Sets whether the window should show always below other windows.
getTitle
Returns String - The title of the native window.
setTitle
Changes the title of native window to title.
setTitleBarStyle
Changes the title bar style of native window.
getTitleBarHeight
Returns int - The title bar height of the native window.
isSkipTaskbar
Returns bool - Whether skipping taskbar is enabled.
setSkipTaskbar
Makes the window not show in the taskbar / dock.
setProgressBar macos windows
Sets progress value in progress bar. Valid range is [0, 1.0].
setIcon windows
Sets window/taskbar icon.
isVisibleOnAllWorkspaces macos
Returns bool - Whether the window is visible on all workspaces.
setVisibleOnAllWorkspaces macos
Sets whether the window should be visible on all workspaces.
Note: If you need to support dragging a window on top of a fullscreen
window on another screen, you need to modify MainFlutterWindow
to inherit from NSPanel
class MainFlutterWindow: NSPanel {
// ...
}
copied to clipboard
setBadgeLabel macos
Set/unset label on taskbar(dock) app icon
Note that it's required to request access at your AppDelegate.swift like this:
UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .badge])
hasShadow macos windows
Returns bool - Whether the window has a shadow. On Windows, always returns true unless window is frameless.
setHasShadow macos windows
Sets whether the window should have a shadow. On Windows, doesn't do anything unless window is frameless.
getOpacity
Returns double - between 0.0 (fully transparent) and 1.0 (fully opaque).
setOpacity
Sets the opacity of the window.
setBrightness
Sets the brightness of the window.
setIgnoreMouseEvents
Makes the window ignore all mouse events.
All mouse events happened in this window will be passed to the window below this window, but if this window has focus, it will still receive keyboard events.
startDragging
Starts a window drag based on the specified mouse-down event.
startResizing linux windows
Starts a window resize based on the specified mouse-down & mouse-move event.
grabKeyboard linux
Grabs the keyboard.
ungrabKeyboard linux
Ungrabs the keyboard.
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.
onWindowResized macos windows
Emitted once when the window has finished being resized.
onWindowMove
Emitted when the window is being moved to a new position.
onWindowMoved macos windows
Emitted once when the window is 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.
onWindowDocked windows
Emitted when the window entered a docked state.
onWindowUndocked windows
Emitted when the window leaves a docked state.
onWindowEvent
Emitted all events.

Contributors #






LiJianying💻
A Arif A S💻
J-P Nurmi💻
Dixeran💻
nikitatg💻
Kristen McWilliam💻
Kingtous💻


Prome💻
Bin💻
youxiachai💻
Allen Xu💻
CodeDoctor💻
Jean-Christophe Binet💻
Jon Salmon💻


Karol Wrótniak💻
LAIIIHZ💻
Mikhail Kulesh💻
Prateek Sunal💻
Ricardo Boss💻






Add your contributions








License #
MIT