Migrate to PopScope from WillPopScope

mono0926 · mono0926 · commit acc5097d533a · 2023-11-17T12:33:44.000+09:00
diff --git a/example/lib/pages/alert_page.dart b/example/lib/pages/alert_page.dart
@@ -34,13 +34,13 @@ class AlertPage extends StatelessWidget {
             },
           ),
           ListTile(
-            title: const Text('OK Dialog (onWillPop: false)'),
+            title: const Text('OK Dialog (canPop: false)'),
             onTap: () async {
               final result = await showOkAlertDialog(
                 context: context,
                 title: 'Title',
                 message: 'This is message.',
-                onWillPop: () => Future.value(false),
+                canPop: false,
               );
               assert(result == OkCancelResult.ok);
               logger.info(result);
diff --git a/lib/src/alert_dialog/show_alert_dialog.dart b/lib/src/alert_dialog/show_alert_dialog.dart
@@ -28,7 +28,8 @@ Future<T?> showAlertDialog<T>({
   bool useRootNavigator = true,
   VerticalDirection actionsOverflowDirection = VerticalDirection.up,
   bool fullyCapitalizedForMaterial = true,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   AdaptiveDialogBuilder? builder,
   Widget? macOSApplicationIcon,
   RouteSettings? routeSettings,
@@ -51,7 +52,8 @@ Future<T?> showAlertDialog<T>({
       actions: actions.convertToSheetActions(),
       style: style,
       useRootNavigator: useRootNavigator,
-      onWillPop: onWillPop,
+      canPop: canPop,
+      onPopInvoked: onPopInvoked,
       builder: builder,
       routeSettings: routeSettings,
     );
@@ -70,8 +72,9 @@ Future<T?> showAlertDialog<T>({
         useRootNavigator: useRootNavigator,
         routeSettings: routeSettings,
         builder: (context) {
-          final dialog = WillPopScope(
-            onWillPop: onWillPop,
+          final dialog = PopScope(
+            canPop: canPop,
+            onPopInvoked: onPopInvoked,
             child: CupertinoAlertDialog(
               title: titleText,
               content: messageText,
@@ -106,8 +109,9 @@ Future<T?> showAlertDialog<T>({
         routeSettings: routeSettings,
         builder: (context) {
           final Widget dialog = MacThemeWrapper(
-            child: WillPopScope(
-              onWillPop: onWillPop,
+            child: PopScope(
+              canPop: canPop,
+              onPopInvoked: onPopInvoked,
               child: MacosAlertDialog(
                 title: titleText ?? const SizedBox.shrink(),
                 message: messageText ?? const SizedBox.shrink(),
@@ -134,8 +138,9 @@ Future<T?> showAlertDialog<T>({
           barrierDismissible: barrierDismissible,
         ),
         builder: (context) {
-          final dialog = WillPopScope(
-            onWillPop: onWillPop,
+          final dialog = PopScope(
+            canPop: canPop,
+            onPopInvoked: onPopInvoked,
             child: AlertDialog(
               title: titleText,
               content: messageText,
diff --git a/lib/src/alert_dialog/show_confirmation_dialog.dart b/lib/src/alert_dialog/show_confirmation_dialog.dart
@@ -32,7 +32,8 @@ Future<T?> showConfirmationDialog<T>({
   bool useRootNavigator = true,
   bool shrinkWrap = true,
   bool fullyCapitalizedForMaterial = true,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   AdaptiveDialogBuilder? builder,
   RouteSettings? routeSettings,
   bool toggleable = true,
@@ -64,7 +65,8 @@ Future<T?> showConfirmationDialog<T>({
               contentMaxHeight: contentMaxHeight,
               shrinkWrap: shrinkWrap,
               fullyCapitalized: fullyCapitalizedForMaterial,
-              onWillPop: onWillPop,
+              canPop: canPop,
+              onPopInvoked: onPopInvoked,
               toggleable: toggleable,
             );
             return builder == null ? dialog : builder(context, dialog);
@@ -78,7 +80,8 @@ Future<T?> showConfirmationDialog<T>({
           actions: actions.convertToSheetActions(),
           style: style,
           useRootNavigator: useRootNavigator,
-          onWillPop: onWillPop,
+          canPop: canPop,
+          onPopInvoked: onPopInvoked,
           builder: builder,
           routeSettings: routeSettings,
         );
@@ -97,7 +100,8 @@ class _ConfirmationMaterialDialog<T> extends StatefulWidget {
     @required this.contentMaxHeight,
     required this.shrinkWrap,
     required this.fullyCapitalized,
-    required this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
     required this.toggleable,
   });
 
@@ -111,7 +115,8 @@ class _ConfirmationMaterialDialog<T> extends StatefulWidget {
   final double? contentMaxHeight;
   final bool shrinkWrap;
   final bool fullyCapitalized;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
   final bool toggleable;
 
   @override
@@ -137,8 +142,8 @@ class _ConfirmationMaterialDialogState<T>
     final cancelLabel = widget.cancelLabel;
     final okLabel = widget.okLabel;
     final message = widget.message;
-    return WillPopScope(
-      onWillPop: widget.onWillPop,
+    return PopScope(
+      canPop: widget.canPop,
       child: Dialog(
         child: Column(
           mainAxisSize: MainAxisSize.min,
diff --git a/lib/src/alert_dialog/show_ok_alert_dialog.dart b/lib/src/alert_dialog/show_ok_alert_dialog.dart
@@ -21,7 +21,8 @@ Future<OkCancelResult> showOkAlertDialog({
   bool useRootNavigator = true,
   VerticalDirection actionsOverflowDirection = VerticalDirection.up,
   bool fullyCapitalizedForMaterial = true,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   AdaptiveDialogBuilder? builder,
   RouteSettings? routeSettings,
 }) async {
@@ -39,7 +40,8 @@ Future<OkCancelResult> showOkAlertDialog({
     useRootNavigator: useRootNavigator,
     actionsOverflowDirection: actionsOverflowDirection,
     fullyCapitalizedForMaterial: fullyCapitalizedForMaterial,
-    onWillPop: onWillPop,
+    canPop: canPop,
+    onPopInvoked: onPopInvoked,
     builder: builder,
     actions: [
       AlertDialogAction(
diff --git a/lib/src/alert_dialog/show_ok_cancel_alert_dialog.dart b/lib/src/alert_dialog/show_ok_cancel_alert_dialog.dart
@@ -30,7 +30,8 @@ Future<OkCancelResult> showOkCancelAlertDialog({
   bool useRootNavigator = true,
   VerticalDirection actionsOverflowDirection = VerticalDirection.up,
   bool fullyCapitalizedForMaterial = true,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   AdaptiveDialogBuilder? builder,
   RouteSettings? routeSettings,
 }) async {
@@ -53,7 +54,8 @@ Future<OkCancelResult> showOkCancelAlertDialog({
     useRootNavigator: useRootNavigator,
     actionsOverflowDirection: actionsOverflowDirection,
     fullyCapitalizedForMaterial: fullyCapitalizedForMaterial,
-    onWillPop: onWillPop,
+    canPop: canPop,
+    onPopInvoked: onPopInvoked,
     builder: builder,
     actions: [
       AlertDialogAction(
diff --git a/lib/src/modal_action_sheet/cupertino_modal_action_sheet.dart b/lib/src/modal_action_sheet/cupertino_modal_action_sheet.dart
@@ -15,29 +15,32 @@ class CupertinoModalActionSheet<T> extends StatelessWidget {
     this.title,
     this.message,
     this.cancelLabel,
-    this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
   });
 
   final ActionCallback<T> onPressed;
   final List<SheetAction<T>> actions;
   final String? title;
   final String? message;
   final String? cancelLabel;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
 
   @override
   Widget build(BuildContext context) {
     final mediaQuery = MediaQuery.of(context);
     final title = this.title;
     final message = this.message;
-    return WillPopScope(
-      onWillPop: onWillPop,
+    return PopScope(
+      canPop: canPop,
+      onPopInvoked: onPopInvoked,
       child: MediaQuery(
         data: mediaQuery.copyWith(
           // `CupertinoAlertDialog` overrides textScaleFactor
           // to keep larger than 1, but `CupertinoActionSheet` doesn't.
           // https://twitter.com/_mono/status/1266997626693509126
-          textScaleFactor: max(1, mediaQuery.textScaleFactor),
+          textScaler: TextScaler.linear(max(1, mediaQuery.textScaleFactor)),
         ),
         child: CupertinoActionSheet(
           title: title == null ? null : Text(title),
diff --git a/lib/src/modal_action_sheet/material_modal_action_sheet.dart b/lib/src/modal_action_sheet/material_modal_action_sheet.dart
@@ -11,15 +11,17 @@ class MaterialModalActionSheet<T> extends StatelessWidget {
     this.title,
     this.message,
     this.materialConfiguration,
-    this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
   });
 
   final ActionCallback<T> onPressed;
   final List<SheetAction<T>> actions;
   final String? title;
   final String? message;
   final MaterialModalActionSheetConfiguration? materialConfiguration;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
 
   @override
   Widget build(BuildContext context) {
@@ -86,8 +88,9 @@ class MaterialModalActionSheet<T> extends StatelessWidget {
               children: children,
             ),
           );
-    return WillPopScope(
-      onWillPop: onWillPop,
+    return PopScope(
+      canPop: canPop,
+      onPopInvoked: onPopInvoked,
       child: body,
     );
   }
diff --git a/lib/src/modal_action_sheet/modal_action_sheet.dart b/lib/src/modal_action_sheet/modal_action_sheet.dart
@@ -23,7 +23,8 @@ Future<T?> showModalActionSheet<T>({
   bool isDismissible = true,
   bool useRootNavigator = true,
   MaterialModalActionSheetConfiguration? materialConfiguration,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   AdaptiveDialogBuilder? builder,
   RouteSettings? routeSettings,
 }) {
@@ -48,7 +49,8 @@ Future<T?> showModalActionSheet<T>({
               message: message,
               actions: actions,
               materialConfiguration: materialConfiguration,
-              onWillPop: onWillPop,
+              canPop: canPop,
+              onPopInvoked: onPopInvoked,
             );
             return builder == null ? sheet : builder(context, sheet);
           },
@@ -64,7 +66,8 @@ Future<T?> showModalActionSheet<T>({
               message: message,
               actions: actions,
               cancelLabel: cancelLabel,
-              onWillPop: onWillPop,
+              canPop: canPop,
+              onPopInvoked: onPopInvoked,
             );
             return builder == null ? sheet : builder(context, sheet);
           },
diff --git a/lib/src/text_input_dialog/ios_text_input_dialog.dart b/lib/src/text_input_dialog/ios_text_input_dialog.dart
@@ -15,7 +15,8 @@ class IOSTextInputDialog extends StatefulWidget {
     this.isDestructiveAction = false,
     this.style = AdaptiveStyle.adaptive,
     this.useRootNavigator = true,
-    this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
     this.autoSubmit = false,
   });
   @override
@@ -29,7 +30,8 @@ class IOSTextInputDialog extends StatefulWidget {
   final bool isDestructiveAction;
   final AdaptiveStyle style;
   final bool useRootNavigator;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
   final bool autoSubmit;
 }
 
@@ -110,8 +112,8 @@ class _IOSTextInputDialogState extends State<IOSTextInputDialog> {
     }
 
     final validationMessage = _validationMessage;
-    return WillPopScope(
-      onWillPop: widget.onWillPop,
+    return PopScope(
+      canPop: widget.canPop,
       child: CupertinoAlertDialog(
         title: title == null ? null : Text(title),
         content: Column(
diff --git a/lib/src/text_input_dialog/macos_text_input_dialog.dart b/lib/src/text_input_dialog/macos_text_input_dialog.dart
@@ -18,7 +18,8 @@ class MacOSTextInputDialog extends StatefulWidget {
     this.isDestructiveAction = false,
     this.style = AdaptiveStyle.adaptive,
     this.useRootNavigator = true,
-    this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
     this.autoSubmit = false,
   });
   @override
@@ -32,7 +33,8 @@ class MacOSTextInputDialog extends StatefulWidget {
   final bool isDestructiveAction;
   final AdaptiveStyle style;
   final bool useRootNavigator;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
   final bool autoSubmit;
 }
 
diff --git a/lib/src/text_input_dialog/material_text_input_dialog.dart b/lib/src/text_input_dialog/material_text_input_dialog.dart
@@ -16,7 +16,8 @@ class MaterialTextInputDialog extends StatefulWidget {
     this.actionsOverflowDirection = VerticalDirection.up,
     this.useRootNavigator = true,
     this.fullyCapitalized = true,
-    this.onWillPop,
+    required this.canPop,
+    required this.onPopInvoked,
     this.autoSubmit = false,
   });
   @override
@@ -33,7 +34,8 @@ class MaterialTextInputDialog extends StatefulWidget {
   final VerticalDirection actionsOverflowDirection;
   final bool useRootNavigator;
   final bool fullyCapitalized;
-  final WillPopCallback? onWillPop;
+  final bool canPop;
+  final PopInvokedCallback? onPopInvoked;
   final bool autoSubmit;
 }
 
@@ -91,8 +93,8 @@ class _MaterialTextInputDialogState extends State<MaterialTextInputDialog> {
         color: widget.isDestructiveAction ? colorScheme.error : null,
       ),
     );
-    return WillPopScope(
-      onWillPop: widget.onWillPop,
+    return PopScope(
+      canPop: widget.canPop,
       child: Form(
         key: _formKey,
         child: AlertDialog(
diff --git a/lib/src/text_input_dialog/show_text_answer_dialog.dart b/lib/src/text_input_dialog/show_text_answer_dialog.dart
@@ -21,7 +21,8 @@ Future<bool> showTextAnswerDialog({
   bool useRootNavigator = true,
   VerticalDirection actionsOverflowDirection = VerticalDirection.up,
   bool fullyCapitalizedForMaterial = true,
-  WillPopCallback? onWillPop,
+  bool canPop = true,
+  PopInvokedCallback? onPopInvoked,
   bool autoSubmit = false,
   bool isCaseSensitive = true,
   AdaptiveDialogBuilder? builder,
@@ -40,7 +41,8 @@ Future<bool> showTextAnswerDialog({
     style: adaptiveStyle,
     actionsOverflowDirection: actionsOverflowDirection,
     fullyCapitalizedForMaterial: fullyCapitalizedForMaterial,
-    onWillPop: onWillPop,
+    canPop: canPop,
+    onPopInvoked: onPopInvoked,
     autoSubmit: autoSubmit,
     builder: builder,
   );
@@ -64,7 +66,8 @@ Future<bool> showTextAnswerDialog({
     barrierDismissible: barrierDismissible,
     useRootNavigator: useRootNavigator,
     fullyCapitalizedForMaterial: fullyCapitalizedForMaterial,
-    onWillPop: onWillPop,
+    canPop: canPop,
+    onPopInvoked: onPopInvoked,
     builder: builder,
   );
   return result == OkCancelResult.ok
@@ -86,7 +89,8 @@ Future<bool> showTextAnswerDialog({
           useRootNavigator: useRootNavigator,
           actionsOverflowDirection: actionsOverflowDirection,
           fullyCapitalizedForMaterial: fullyCapitalizedForMaterial,
-          onWillPop: onWillPop,
+          canPop: canPop,
+          onPopInvoked: onPopInvoked,
           autoSubmit: autoSubmit,
           builder: builder,
         )
diff --git a/lib/src/text_input_dialog/show_text_input_dialog.dart b/lib/src/text_input_dialog/show_text_input_dialog.dart
