add SmartDialogController

Author: xdd666t

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Add SmartAwaitOverType
 - Fix [#56](https://github.com/fluttercandies/flutter_smart_dialog/issues/56)
 - Fix [#60](https://github.com/fluttercandies/flutter_smart_dialog/issues/60)
+- Add SmartDialogController
 
 # [4.0.3]
 

docs/Attach Chapter.md

@@ -314,13 +314,13 @@ SmartDialog.showAttach(
 
 The above two business scenarios are very common. Sometimes, we need to be above or below the target widget or a specific area without being covered by a mask.
 
-If you do it yourself, you can do it, but it will be cumbersome; now you can easily achieve this using the `highlight` parameter in `showAttach`
+If you do it yourself, you can do it, but it will be cumbersome; now you can easily achieve this using the `highlightBuilder` parameter in `showAttach`
 
 > **Guide Actions**
 
 Guidance operations are still very common in apps, and you need to specify the area to highlight, and then introduce its functions
 
-- Using the `highlight` parameter in `showAttach` can also easily achieve this requirement, see the effect
+- Using the `highlightBuilder` parameter in `showAttach` can also easily achieve this requirement, see the effect
   - The code is also a little bit more, if you are interested, please check: [flutter_use](https://github.com/xdd666t/flutter_use)
 
 ![attachGuide](https://cdn.jsdelivr.net/gh/xdd666t/MyData@master/pic/flutter/blog/20220103224816.gif)

lib/flutter_smart_dialog.dart

@@ -10,3 +10,4 @@ export 'src/config/smart_config_toast.dart';
 /// dialog
 export 'src/init_dialog.dart';
 export 'src/smart_dialog.dart';
+export 'src/widget/dialog_scope.dart' show SmartDialogController;

lib/src/smart_dialog.dart

@@ -7,6 +7,7 @@ import 'config/smart_config.dart';
 import 'config/enum_config.dart';
 import 'helper/dialog_proxy.dart';
 import 'widget/attach_dialog_widget.dart';
+import 'widget/dialog_scope.dart';
 
 class SmartDialog {
   /// Compatible with older versions
@@ -23,6 +24,8 @@ class SmartDialog {
   ///
   /// [builder]：the custom dialog
   ///
+  /// [controller]：this controller can be used to refresh the layout of the custom dialog
+  ///
   /// [alignment]：control the location of the dialog
   ///
   /// [clickMaskDismiss]：true（the dialog will be closed after click mask），false（not close）
@@ -71,6 +74,8 @@ class SmartDialog {
   ///
   /// [builder]：自定义 dialog
   ///
+  /// [controller]：可使用该控制器来刷新自定义的dialog的布局
+  ///
   /// [alignment]：控制弹窗的位置
   ///
   /// [clickMaskDismiss]：true（点击遮罩后，将关闭dialog），false（不关闭）
@@ -111,6 +116,7 @@ class SmartDialog {
   /// 绑定页面被关闭,被绑定在该页面上的dialog也将被移除
   static Future<T?> show<T>({
     required WidgetBuilder builder,
+    SmartDialogController? controller,
     AlignmentGeometry? alignment,
     bool? clickMaskDismiss,
     bool? usePenetrate,
@@ -143,7 +149,10 @@ class SmartDialog {
     );
 
     return DialogProxy.instance.show<T>(
-      widget: Builder(builder: (context) => builder(context)),
+      widget: DialogScope(
+        controller: controller,
+        builder: (context) => builder(context),
+      ),
       alignment: alignment ?? config.custom.alignment,
       clickMaskDismiss: clickMaskDismiss ?? config.custom.clickMaskDismiss,
       animationType: animationType ?? config.custom.animationType,
@@ -170,6 +179,8 @@ class SmartDialog {
   ///
   /// [builder]：the custom dialog
   ///
+  /// [controller]：this controller can be used to refresh the layout of the custom dialog
+  ///
   /// [target]：target offset，when the target is set to value，
   /// the targetContext param will be invalid
   ///
@@ -226,6 +237,8 @@ class SmartDialog {
   ///
   /// [builder]：自定义 dialog
   ///
+  /// [controller]：可使用该控制器来刷新自定义的dialog的布局
+  ///
   /// [target]：target offset，当target被设置数据，targetContext参数将失效
   ///
   /// [alignment]：控制弹窗的位置
@@ -271,6 +284,7 @@ class SmartDialog {
   static Future<T?> showAttach<T>({
     required BuildContext? targetContext,
     required WidgetBuilder builder,
+    SmartDialogController? controller,
     Offset? target,
     AlignmentGeometry? alignment,
     bool? clickMaskDismiss,
@@ -311,7 +325,10 @@ class SmartDialog {
     var highlight = highlightBuilder;
     return DialogProxy.instance.showAttach<T>(
       targetContext: targetContext,
-      widget: Builder(builder: (context) => builder(context)),
+      widget: DialogScope(
+        controller: controller,
+        builder: (context) => builder(context),
+      ),
       target: target,
       alignment: alignment ?? config.attach.alignment,
       clickMaskDismiss: clickMaskDismiss ?? config.attach.clickMaskDismiss,
@@ -338,6 +355,8 @@ class SmartDialog {
   ///
   /// [msg]：loading msg (Use the [builder] param, this param will be invalid)
   ///
+  /// [controller]：this controller can be used to refresh the layout of the custom loading
+  ///
   /// [clickMaskDismiss]：true（loading will be closed after click mask），false（not close）
   ///
   /// [animationType]：For details, please refer to the [SmartAnimationType] comment
@@ -364,6 +383,8 @@ class SmartDialog {
   ///
   /// [msg]：loading 的信息（使用[builder]参数，该参数将失效）
   ///
+  /// [controller]：可使用该控制器来刷新自定义的loading的布局
+  ///
   /// [clickMaskDismiss]：true（点击遮罩后，将关闭loading），false（不关闭）
   ///
   /// [animationType]：具体可参照[SmartAnimationType]注释
@@ -384,6 +405,7 @@ class SmartDialog {
   /// [builder]：自定义loading
   static Future<T?> showLoading<T>({
     String msg = 'loading...',
+    SmartDialogController? controller,
     bool? clickMaskDismiss,
     SmartAnimationType? animationType,
     bool? usePenetrate,
@@ -404,7 +426,10 @@ class SmartDialog {
       maskWidget: maskWidget ?? config.loading.maskWidget,
       backDismiss: backDismiss ?? config.loading.backDismiss,
       widget: builder != null
-          ? Builder(builder: (context) => builder(context))
+          ? DialogScope(
+              controller: controller,
+              builder: (context) => builder(context),
+            )
           : DialogProxy.instance.loadingBuilder(msg),
     );
   }
@@ -413,6 +438,8 @@ class SmartDialog {
   ///
   /// [msg]：msg presented to users (Use the [builder] param to customize the toast, this param will be invalid)
   ///
+  ///  [controller]：this controller can be used to refresh the layout of the custom toast
+  ///
   /// [displayTime]：toast display time on the screen
   ///
   /// [alignment]：control the location of the dialog
@@ -447,6 +474,8 @@ class SmartDialog {
   ///
   /// [msg]：呈现给用户的信息（使用[builder]参数自定义toast，该参数将失效）
   ///
+  /// [controller]：可使用该控制器来刷新自定义的toast的布局
+  ///
   /// [displayTime]：toast在屏幕上的显示时间
   ///
   /// [alignment]：控制弹窗的位置
@@ -474,6 +503,7 @@ class SmartDialog {
   /// [builder]：自定义toast
   static Future<void> showToast(
     String msg, {
+    SmartDialogController? controller,
     Duration? displayTime,
     AlignmentGeometry? alignment,
     bool? clickMaskDismiss,
@@ -502,7 +532,10 @@ class SmartDialog {
       displayType: displayType ?? config.toast.displayType,
       consumeEvent: consumeEvent ?? config.toast.consumeEvent,
       widget: builder != null
-          ? Builder(builder: (context) => builder(context))
+          ? DialogScope(
+              controller: controller,
+              builder: (context) => builder(context),
+            )
           : DialogProxy.instance.toastBuilder(msg),
     );
   }

lib/src/widget/dialog_scope.dart

@@ -0,0 +1,42 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_smart_dialog/src/util/view_utils.dart';
+
+part 'smart_dialog_controller.dart';
+
+class DialogScope extends StatefulWidget {
+  const DialogScope({
+    Key? key,
+    required this.controller,
+    required this.builder,
+  }) : super(key: key);
+
+  final SmartDialogController? controller;
+
+  final WidgetBuilder builder;
+
+  @override
+  State<DialogScope> createState() => _DialogScopeState();
+}
+
+class _DialogScopeState extends State<DialogScope> {
+  @override
+  void initState() {
+    widget.controller?._setListener(() {
+      ViewUtils.addSafeUse(() => setState(() {}));
+    });
+
+    super.initState();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return widget.builder(context);
+  }
+
+  @override
+  void dispose() {
+    widget.controller?._dismiss();
+
+    super.dispose();
+  }
+}

lib/src/widget/smart_dialog_controller.dart

@@ -0,0 +1,21 @@
+part of 'dialog_scope.dart';
+
+/// SmartDialog Controller
+class SmartDialogController {
+  VoidCallback? _callback;
+
+  /// refresh dialog
+  ///
+  /// 刷新dialog
+  void refresh() {
+    _callback?.call();
+  }
+
+  void _setListener(VoidCallback? voidCallback) {
+    _callback = voidCallback;
+  }
+
+  void _dismiss() {
+    _callback = null;
+  }
+}

pubspec.yaml

@@ -3,7 +3,7 @@ description:
   An elegant Flutter Dialog solution,
   Easily implement Toast, Loading and custom Dialog,
   Make the use of the dialog easier!
-version: 4.3.2+1
+version: 4.3.5
 homepage: https://github.com/fluttercandies/flutter_smart_dialog
 #flutter pub publish --server=https://pub.dartlang.org