搜索插件、代码仓与 APP 分类

flutter_window_close 封面
插件详情v1.3.0

flutter_window_close

让您的 Flutter 应用有机会确认用户是否真的想要关闭应用。

WebmacOSWindowsLinux
近 30 天下载
3万
喜欢数
99
Pub 分数
160

安装插件

flutter pub add flutter_window_close

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

flutter_window_close 包使桌面平台上的 Flutter 应用能够拦截窗口关闭事件,并在退出前提示用户确认。这对于需要保存未保存数据或防止意外关闭的应用非常有用。该包提供了一个简单的 API,用于注册在用户尝试关闭窗口时运行的回调函数,使开发者能够显示自定义对话框或执行清理任务。该包支持 macOS、Windows、Linux 和 Web,非常适合需要优雅关机处理的跨平台桌面应用。

适合场景

  • 防止意外关闭应用
  • 退出前保存未保存的数据
  • 显示确认对话框
  • 桌面优雅关闭
  • 自定义退出逻辑
  • Web 和桌面兼容性

主要特点

  • 拦截窗口关闭事件
  • 支持多个桌面平台
  • 简单的回调 API
  • 跨平台桌面支持
  • 可选的确认对话框
  • Web 和原生集成

适合对象

  • 桌面 Flutter 应用
  • 未保存数据的应用
  • 面向用户的桌面应用程序
  • 需要退出控制的开发者
  • 需要确认提示的应用程序
  • 跨平台桌面项目

使用建议

  • 不适用于移动平台
  • 需要平台特定的设置
  • 可能与系统级别的关闭行为冲突
  • 仅限桌面和网页
  • 不处理从任务管理器中终止应用的情况
  • 用户体验取决于实现方式

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

flutter_window_close

2021 © Weizhong Yang a.k.a zonble

Pub example workflow License: MIT

flutter_window_close lets your Flutter app has a chance to confirm if the user wants to close your app. It works on desktop platforms including Windows, macOS and Linux.

macOS Windows Linux

Example

Getting Started

It is very common that an app would prompt a message like "Do you really want to quit" when users click on the close button, in order to notify that there are still undone tasks and the users may lose their data if they want to quit anyway. It prevents the users from losing data unwillingly.

To let a Flutter desktop app to support that, the plug-in listens to the events from the window hosting Flutter's view, and send the events to Flutter. What you need to do is to assign an anonymous function that can answer if the window should be closed. For example, you can show an alert dialog to ask what the current user is willing to do:

FlutterWindowClose.setWindowShouldCloseHandler(() async {
    return await showDialog(
        context: context,
        builder: (context) {
          return AlertDialog(
          title: const Text('Do you really want to quit?'),
          actions: [
            ElevatedButton(
            onPressed: () => Navigator.of(context).pop(true),
            child: const Text('Yes')),
            ElevatedButton(
            onPressed: () => Navigator.of(context).pop(false),
            child: const Text('No')),
          ]);
        });
});

The plugin bridges following APIs:

It does not support mobile platforms, since there is no such event for closing windows. You can use a custom WillPopScope to capture if a user is leaving your app with a back key.

macOS

There could be some issues while using the package on macOS. Each platform has its paradigm and the developer framework macOS sees window objects in a different way from Windows and Linux.

On Windows and Linux, windows are more like controllers in MVC pattern , and when it comes to Flutter, there would be always a root window in the process of an app, and our plugin could easily know which is the window to listen to. In the code level, we use GetActiveWindow while we can use gtk_widget_get_ancestor or gtk_widget_get_toplevel.

On the contrary, windows are more like views on macOS. An app can have multiple windows, and the app can stay still open event all windows are closed. We can also create an object with multiple IBOutlets to multiple windows. Flutter macOS does not tell plugins which window is the one running Flutter as well.

The plugin listens to the first window in the windows list of the singleton NSApplication object. It works if you have only one window in your macOS Flutter app. If you just create a new app using the official template for macOS, you may need not to change anything. However, if your app has multiple windows, the behavior of the plugin might be unexpectable.

Flutter Web

We can do little when a user is closing the tab or window hosting your Flutter Web app. The only way to let a user to confirm if he or she really want to close is to set the return value of the onbeforeunload event. You can use the setWebReturnValue method to set the return value.

License

The package is released under MIT license.

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目