add bindWidget feature

Author: xdd666t

example/lib/main.dart

@@ -62,22 +62,42 @@ class SmartDialogPage extends StatelessWidget {
     print('--------------------------');
   }
 
-  void _show() {
-    SmartDialog.show(builder: (_) {
-      return Container(
-        height: 80,
-        width: 180,
-        decoration: BoxDecoration(
-          color: Colors.black,
-          borderRadius: BorderRadius.circular(10),
-        ),
-        alignment: Alignment.center,
-        child: Text(
-          'easy custom dialog',
-          style: TextStyle(color: Colors.white),
-        ),
+  void _show() async {
+    //关闭多个相同tag dialog
+    tagDialog(String tag) {
+      SmartDialog.show(
+        tag: tag,
+        builder: (_) {
+          return Container(
+            height: 80,
+            width: 180,
+            decoration: BoxDecoration(
+              color: Colors.black,
+              borderRadius: BorderRadius.circular(10),
+            ),
+            alignment: Alignment.center,
+            child: Text(
+              'easy custom dialog',
+              style: TextStyle(color: Colors.white),
+            ),
+          );
+        },
       );
-    });
+    }
+    var tag = "1";
+    for (var i = 0; i < 3; i++) {
+      tagDialog(tag);
+      await Future.delayed(Duration(milliseconds: 300));
+    }
+    SmartDialog.dismiss(tag: tag, status: SmartStatus.allDialog);
+
+    //穿透遮罩
+    SmartDialog.show(
+      usePenetrate: true,
+      builder: (_) {
+        return Container(height: 80, width: 180, color: Colors.black);
+      },
+    );
   }
 
   void _showAttach(BuildContext ctx) {

lib/src/compatible/compatible_smart_dialog.dart

@@ -142,6 +142,7 @@ class CompatibleSmartDialog {
       permanent: false,
       useSystem: useSystem ?? false,
       bindPage: false,
+      bindWidget: null,
     );
   }
 
@@ -304,6 +305,7 @@ class CompatibleSmartDialog {
       permanent: false,
       useSystem: useSystem ?? false,
       bindPage: false,
+      bindWidget: null,
     );
   }
 

lib/src/custom/custom_dialog.dart

@@ -5,6 +5,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_smart_dialog/src/data/dialog_info.dart';
 import 'package:flutter_smart_dialog/src/data/smart_tag.dart';
 import 'package:flutter_smart_dialog/src/helper/dialog_proxy.dart';
+import 'package:flutter_smart_dialog/src/helper/monitor_widget_helper.dart';
 import 'package:flutter_smart_dialog/src/helper/route_record.dart';
 import 'package:flutter_smart_dialog/src/util/view_utils.dart';
 import 'package:flutter_smart_dialog/src/widget/attach_dialog_widget.dart';
@@ -56,6 +57,7 @@ class CustomDialog extends BaseDialog {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
     if (!_handleMustOperate(
       tag: displayTime != null ? _getTimeKey(displayTime) : tag,
@@ -66,6 +68,7 @@ class CustomDialog extends BaseDialog {
       permanent: permanent,
       useSystem: useSystem,
       bindPage: bindPage,
+      bindWidget: bindWidget,
     )) return Future.value(null);
     return mainDialog.show<T>(
       widget: widget,
@@ -116,6 +119,7 @@ class CustomDialog extends BaseDialog {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
     if (!_handleMustOperate(
       tag: displayTime != null ? _getTimeKey(displayTime) : tag,
@@ -126,6 +130,7 @@ class CustomDialog extends BaseDialog {
       permanent: permanent,
       useSystem: useSystem,
       bindPage: bindPage,
+      bindWidget: bindWidget,
     )) return Future.value(null);
     return mainDialog.showAttach<T>(
       targetContext: targetContext,
@@ -177,6 +182,7 @@ class CustomDialog extends BaseDialog {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
     // debounce
     if (!_checkDebounce(debounce, type)) return false;
@@ -190,6 +196,7 @@ class CustomDialog extends BaseDialog {
       permanent: permanent,
       useSystem: useSystem,
       bindPage: bindPage,
+      bindWidget: bindWidget,
     );
 
     SmartDialog.config.custom.isExist = DialogType.custom == type;
@@ -205,7 +212,12 @@ class CustomDialog extends BaseDialog {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
+    if (bindWidget != null) {
+      tag = tag ?? "${bindPage.hashCode}";
+    }
+
     if (keepSingle) {
       DialogInfo? dialogInfo = _getDialog(tag: SmartTag.keepSingle);
       if (dialogInfo == null) {
@@ -218,6 +230,7 @@ class CustomDialog extends BaseDialog {
           useSystem: useSystem,
           bindPage: bindPage,
           route: RouteRecord.curRoute,
+          bindWidget: bindWidget,
         );
         _pushDialog(dialogInfo);
         mainDialogSingle = mainDialog;
@@ -237,6 +250,7 @@ class CustomDialog extends BaseDialog {
       useSystem: useSystem,
       bindPage: bindPage,
       route: RouteRecord.curRoute,
+      bindWidget: bindWidget,
     );
     _pushDialog(dialogInfo);
   }
@@ -248,6 +262,10 @@ class CustomDialog extends BaseDialog {
     } else {
       proxy.dialogQueue.addLast(dialogInfo);
     }
+    if (dialogInfo.bindWidget != null) {
+      MonitorWidgetHelper.instance.monitorDialogQueue.add(dialogInfo);
+    }
+
     // insert the dialog carrier into the page
     ViewUtils.addSafeUse(() {
       Overlay.of(DialogProxy.contextOverlay)!.insert(
@@ -356,6 +374,9 @@ class CustomDialog extends BaseDialog {
     //handle close dialog
     var proxy = DialogProxy.instance;
     proxy.dialogQueue.remove(info);
+    if (info.bindWidget != null) {
+      MonitorWidgetHelper.instance.monitorDialogQueue.remove(info);
+    }
 
     //check if the queue contains a custom dialog or attach dialog
     proxy.config.custom.isExist = false;
@@ -410,8 +431,12 @@ class CustomDialog extends BaseDialog {
     //handle normal dialog
     for (var i = dialogQueue.length - 1; i >= 0; i--) {
       if (dialogQueue.isEmpty) break;
-      if (type == DialogType.dialog || list[i].type == type) {
-        info = list[i];
+      var item = list[i];
+      if (!item.dialog.mainDialog.visible) {
+        continue;
+      }
+      if (type == DialogType.dialog || item.type == type) {
+        info = item;
         break;
       }
     }

lib/src/custom/main_dialog.dart

@@ -20,7 +20,7 @@ class MainDialog {
   final SmartOverlayEntry overlayEntry;
   final _uniqueKey = UniqueKey();
 
-  bool offstage = false;
+  bool visible = true;
   BaseController? _controller;
   Completer? _completer;
   VoidCallback? _onDismiss;
@@ -201,5 +201,5 @@ class MainDialog {
     );
   }
 
-  Widget getWidget() => Offstage(offstage: offstage, child: _widget);
+  Widget getWidget() => Offstage(offstage: !visible, child: _widget);
 }

lib/src/data/base_dialog.dart

@@ -15,4 +15,14 @@ class BaseDialog {
 
   /// get Widget : must implement
   Widget getWidget() => mainDialog.getWidget();
+
+  void appear(){
+    mainDialog.visible = true;
+    overlayEntry.markNeedsBuild();
+  }
+
+  void hide() {
+    mainDialog.visible = false;
+    overlayEntry.markNeedsBuild();
+  }
 }

lib/src/data/dialog_info.dart

@@ -13,6 +13,7 @@ class DialogInfo {
     required this.useSystem,
     required this.bindPage,
     required this.route,
+    required this.bindWidget,
   });
 
   final BaseDialog dialog;
@@ -21,7 +22,7 @@ class DialogInfo {
 
   final DialogType type;
 
-  final String? tag;
+  String? tag;
 
   final bool permanent;
 
@@ -30,4 +31,6 @@ class DialogInfo {
   final bool bindPage;
 
   final Route<dynamic>? route;
+
+  final BuildContext? bindWidget;
 }

lib/src/helper/dialog_proxy.dart

@@ -73,6 +73,7 @@ class DialogProxy {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
     CustomDialog? dialog;
     var entry = SmartOverlayEntry(
@@ -100,6 +101,7 @@ class DialogProxy {
       permanent: permanent,
       useSystem: useSystem,
       bindPage: bindPage,
+      bindWidget: bindWidget,
     );
   }
 
@@ -129,6 +131,7 @@ class DialogProxy {
     required bool permanent,
     required bool useSystem,
     required bool bindPage,
+    required BuildContext? bindWidget,
   }) {
     CustomDialog? dialog;
     var entry = SmartOverlayEntry(
@@ -161,6 +164,7 @@ class DialogProxy {
       permanent: permanent,
       useSystem: useSystem,
       bindPage: bindPage,
+      bindWidget: bindWidget,
     );
   }
 

lib/src/helper/monitor_widget_helper.dart

@@ -0,0 +1,60 @@
+import 'dart:collection';
+
+import 'package:flutter/rendering.dart';
+import 'package:flutter_smart_dialog/flutter_smart_dialog.dart';
+import 'package:flutter_smart_dialog/src/util/log.dart';
+import 'package:flutter_smart_dialog/src/util/view_utils.dart';
+
+import '../data/dialog_info.dart';
+
+class MonitorWidgetHelper {
+  factory MonitorWidgetHelper() => instance;
+  static MonitorWidgetHelper? _instance;
+
+  static MonitorWidgetHelper get instance =>
+      _instance ??= MonitorWidgetHelper._internal();
+
+  late Queue<DialogInfo> monitorDialogQueue;
+
+  bool prohibitMonitor = false;
+
+  MonitorWidgetHelper._internal() {
+    monitorDialogQueue = ListQueue();
+
+    schedulerBinding.addPersistentFrameCallback((timeStamp) {
+      if (monitorDialogQueue.isEmpty || prohibitMonitor) {
+        return;
+      }
+
+      prohibitMonitor = true;
+      var removeList = <DialogInfo>[];
+      monitorDialogQueue.forEach((item) {
+        try {
+          var context = item.bindWidget;
+          if (context == null) {
+            throw Error();
+          }
+
+          var renderObject = context.findRenderObject();
+          var viewport = RenderAbstractViewport.of(renderObject);
+          var revealedOffset = viewport?.getOffsetToReveal(renderObject!, 0.0);
+          if (revealedOffset?.rect.hasNaN ?? false) {
+            item.dialog.hide();
+          } else {
+            item.dialog.appear();
+          }
+        } catch (e) {
+          removeList.add(item);
+          SmartLog.d(
+            "The element(hashcode: ${item.bindWidget.hashCode}) is recycled and"
+            " the 'bindWidget' dialog dismiss automatically",
+          );
+        }
+      });
+      for (var i = removeList.length; i > 0; i--) {
+        SmartDialog.dismiss(tag: removeList[i - 1].tag);
+      }
+      prohibitMonitor = false;
+    });
+  }
+}

lib/src/helper/route_record.dart

@@ -54,7 +54,7 @@ class RouteRecord {
           }
         } else {
           // deal with bindPage and permanent dialog
-          if (info.dialog.mainDialog.offstage || info.permanent) {
+          if (!info.dialog.mainDialog.visible || info.permanent) {
             shouldHandle = false;
           }
         }
@@ -71,8 +71,7 @@ class RouteRecord {
     if (curRoute == null || DialogProxy.instance.dialogQueue.isEmpty) return;
     for (var item in DialogProxy.instance.dialogQueue) {
       if (item.route == curRoute && item.bindPage) {
-        item.dialog.mainDialog.offstage = true;
-        item.dialog.overlayEntry.markNeedsBuild();
+        item.dialog.hide();
       }
     }
   }
@@ -81,8 +80,7 @@ class RouteRecord {
     if (curRoute == null || DialogProxy.instance.dialogQueue.isEmpty) return;
     for (var item in DialogProxy.instance.dialogQueue) {
       if (item.route == curRoute && item.bindPage) {
-        item.dialog.mainDialog.offstage = false;
-        item.dialog.overlayEntry.markNeedsBuild();
+        item.dialog.appear();
       }
     }
   }