add onBack feature, delete CompatibleSmartDialog, delete SmartConfigCustom/SmartConfigAttach/SmartConfigLoading backDismiss

Author: xdd666t

CHANGELOG.md

@@ -1,6 +1,11 @@
 # [4.9.8+x]
 * SmartDialog.config.checkExist() adjust to SmartDialog.checkExist()
 * Fix [#209](https://github.com/fluttercandies/flutter_smart_dialog/issues/209)
+* Revert the initialization implementation
+* Add onBack feature
+* Break change
+  * Delete CompatibleSmartDialog
+  * Delete SmartConfigCustom/SmartConfigAttach/SmartConfigLoading backDismiss
 
 * # [4.9.7+x]
 * optimize bindWidget, when bindWidget is not null, bindPage will be automatically set to false.

lib/src/compatible/compatible_smart_dialog.dart

@@ -1,5 +1,4 @@
 import 'package:flutter_smart_dialog/flutter_smart_dialog.dart';
-import 'package:flutter_smart_dialog/src/compatible/smart_config_compatible.dart';
 
 import '../kit/dialog_kit.dart';
 
@@ -48,12 +47,6 @@ class SmartConfig {
     return DialogKit.instance.checkExist(tag: tag, dialogTypes: dialogTypes);
   }
 
-  /// Compatible with older versions
-  ///
-  /// 兼容老版本配置
-  @Deprecated("5.0 will be deleted and is not recommended for continued use")
-  SmartConfigCompatible compatible = SmartConfigCompatible();
-
   /// whether custom dialog，attach and loading  exist on the screen
   ///
   /// 自定义dialog，attach或loading，是否存在在界面上

lib/src/compatible/smart_config_compatible.dart

@@ -26,6 +26,7 @@ class SmartConfigAttach {
       SmartNonAnimationType.highlightMask_nonAnimation,
     ],
     this.attachAlignmentType = SmartAttachAlignmentType.center,
+    this.backType = SmartBackType.normal,
     this.isExist = false,
   });
 
@@ -112,6 +113,7 @@ class SmartConfigAttach {
   ///
   /// true（返回事件将关闭loading，但是不会关闭页面），false（返回事件不会关闭loading，也不会关闭页面），
   /// 你仍然可以使用dismiss方法来关闭dialog
+  @Deprecated("please use backType")
   final bool backDismiss;
 
   /// Bind the dialog to the current page, the bound page is not on the top of the stack,
@@ -144,6 +146,12 @@ class SmartConfigAttach {
   /// attach dialog选择不同alignment属性时的对齐效果, 具体说明请参照[SmartAttachAlignmentType]
   final SmartAttachAlignmentType attachAlignmentType;
 
+  /// For different processing types of return events,
+  /// please refer to the description of [SmartBackType] for details
+  ///
+  /// 对于返回事件不同的处理类型, 具体可参照[SmartBackType]说明
+  final SmartBackType backType;
+
   /// whether attach dialog(showAttach()) exist on the screen
   ///
   /// attach dialog(showAttach())，是否存在在界面上

lib/src/config/smart_config.dart

@@ -24,6 +24,7 @@ class SmartConfigCustom {
     this.nonAnimationTypes = const [
       SmartNonAnimationType.routeClose_nonAnimation,
     ],
+    this.backType = SmartBackType.normal,
     this.isExist = false,
   });
 
@@ -110,6 +111,7 @@ class SmartConfigCustom {
   ///
   /// true（返回事件将关闭loading，但是不会关闭页面），false（返回事件不会关闭loading，也不会关闭页面），
   /// 你仍然可以使用dismiss方法来关闭dialog
+  @Deprecated("please use backType")
   final bool backDismiss;
 
   /// Bind the dialog to the current page, the bound page is not on the top of the stack,
@@ -136,6 +138,12 @@ class SmartConfigCustom {
   /// 对于不同的场景, 可动态关闭弹窗动画, 具体请参照[SmartNonAnimationType]
   final List<SmartNonAnimationType> nonAnimationTypes;
 
+  /// For different processing types of return events,
+  /// please refer to the description of [SmartBackType] for details
+  ///
+  /// 对于返回事件不同的处理类型, 具体可参照[SmartBackType]说明
+  final SmartBackType backType;
+
   /// whether custom dialog(show()) exist on the screen
   ///
   /// 自定义dialog(show())，是否存在在界面上

lib/src/config/smart_config_attach.dart

@@ -14,7 +14,6 @@ class SmartConfigLoading {
     this.usePenetrate = false,
     this.maskColor = const Color.fromRGBO(0, 0, 0, 0.46),
     this.maskWidget,
-    this.backDismiss = true,
     this.clickMaskDismiss = false,
     this.leastLoadingTime = const Duration(milliseconds: 0),
     this.awaitOverType = SmartAwaitOverType.dialogDismiss,
@@ -23,6 +22,7 @@ class SmartConfigLoading {
       SmartNonAnimationType.routeClose_nonAnimation,
       SmartNonAnimationType.continueLoading_nonAnimation,
     ],
+    this.backType = SmartBackType.normal,
     this.isExist = false,
   });
 
@@ -84,14 +84,6 @@ class SmartConfigLoading {
   /// 遮罩Widget，可高度自定义你自己的遮罩背景：[usePenetrate]设置为true，该参数失效
   final Widget? maskWidget;
 
-  /// true（the back event will close the loading but not close the page），
-  /// false（the back event not close the loading and not close page），
-  /// you still can use the dismiss method to close the loading
-  ///
-  /// true（返回事件将关闭loading，但是不会关闭页面），false（返回事件不会关闭loading，也不会关闭页面），
-  /// 你仍然可以使用dismiss方法来关闭loading
-  final bool backDismiss;
-
   /// true（dialog will be closed after click background），false（not close）
   ///
   /// true（点击遮罩关闭dialog），false（不关闭）
@@ -119,6 +111,12 @@ class SmartConfigLoading {
   /// 对于不同的场景, 可动态关闭弹窗动画, 具体请参照[SmartNonAnimationType]
   final List<SmartNonAnimationType> nonAnimationTypes;
 
+  /// For different processing types of return events,
+  /// please refer to the description of [SmartBackType] for details
+  ///
+  /// 对于返回事件不同的处理类型, 具体可参照[SmartBackType]说明
+  final SmartBackType backType;
+
   /// whether loading(showLoading()) exist on the screen
   ///
   /// loading(showLoading())是否存在在界面上

lib/src/config/smart_config_custom.dart

@@ -15,6 +15,7 @@ import '../data/animation_param.dart';
 import '../data/base_dialog.dart';
 import '../data/notify_info.dart';
 import '../kit/debounce_utils.dart';
+import '../kit/typedef.dart';
 import '../smart_dialog.dart';
 import '../widget/helper/smart_overlay_entry.dart';
 
@@ -39,21 +40,21 @@ class CustomDialog extends BaseDialog {
     required VoidCallback? onMask,
     required Duration? displayTime,
     required String? tag,
-    required bool backDismiss,
     required bool keepSingle,
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
     required BuildContext? bindWidget,
     required Rect? ignoreArea,
+    required SmartBackType? backType,
+    required SmartOnBack? onBack,
   }) {
     if (DebounceUtils.instance.banContinue(DebounceType.custom, debounce)) {
       return Future.value(null);
     }
 
     final dialogInfo = _handleMustOperate(
       tag: tag,
-      backDismiss: backDismiss,
       keepSingle: keepSingle,
       debounce: debounce,
       type: DialogType.custom,
@@ -62,6 +63,8 @@ class CustomDialog extends BaseDialog {
       bindPage: bindPage,
       bindWidget: bindWidget,
       displayTime: displayTime,
+      backType: backType,
+      onBack: onBack,
     );
     return mainDialog.show<T>(
       widget: widget,
@@ -116,20 +119,20 @@ class CustomDialog extends BaseDialog {
     required VoidCallback? onDismiss,
     required Duration? displayTime,
     required String? tag,
-    required bool backDismiss,
     required bool keepSingle,
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
     required BuildContext? bindWidget,
+    required SmartBackType? backType,
+    required SmartOnBack? onBack,
   }) {
     if (DebounceUtils.instance.banContinue(DebounceType.attach, debounce)) {
       return Future.value(null);
     }
 
     final dialogInfo = _handleMustOperate(
       tag: tag,
-      backDismiss: backDismiss,
       keepSingle: keepSingle,
       debounce: debounce,
       type: DialogType.attach,
@@ -138,6 +141,8 @@ class CustomDialog extends BaseDialog {
       bindPage: bindPage,
       bindWidget: bindWidget,
       displayTime: displayTime,
+      backType: backType,
+      onBack: onBack,
     );
     return mainDialog.showAttach<T>(
       targetContext: targetContext,
@@ -197,7 +202,6 @@ class CustomDialog extends BaseDialog {
 
   DialogInfo _handleMustOperate({
     required String? tag,
-    required bool backDismiss,
     required bool keepSingle,
     required bool debounce,
     required DialogType type,
@@ -206,6 +210,8 @@ class CustomDialog extends BaseDialog {
     required bool bindPage,
     required BuildContext? bindWidget,
     required Duration? displayTime,
+    required SmartBackType? backType,
+    required SmartOnBack? onBack,
   }) {
     SmartDialog.config.custom.isExist = DialogType.custom == type;
     SmartDialog.config.attach.isExist = DialogType.attach == type;
@@ -216,14 +222,15 @@ class CustomDialog extends BaseDialog {
       if (singleDialogInfo == null) {
         singleDialogInfo = DialogInfo(
           dialog: this,
-          backDismiss: backDismiss,
           type: type,
           tag: tag ?? SmartTag.keepSingle,
           permanent: permanent,
           useSystem: useSystem,
           bindPage: bindPage,
           route: RouteRecord.curRoute,
           bindWidget: bindWidget,
+          backType: backType,
+          onBack: onBack,
         );
         _pushDialog(singleDialogInfo);
       }
@@ -235,14 +242,15 @@ class CustomDialog extends BaseDialog {
       // handle dialog stack
       dialogInfo = DialogInfo(
         dialog: this,
-        backDismiss: backDismiss,
         type: type,
         tag: tag,
         permanent: permanent,
         useSystem: useSystem,
         bindPage: bindPage,
         route: RouteRecord.curRoute,
         bindWidget: bindWidget,
+        backType: backType,
+        onBack: onBack,
       );
       _pushDialog(dialogInfo);
     }
@@ -419,11 +427,6 @@ class CustomDialog extends BaseDialog {
       }
     }
 
-    //handle prohibiting back event
-    if (info != null && (!info.backDismiss && closeType == CloseType.back)) {
-      return null;
-    }
-
     return info;
   }
 }