notice: 'antiShake' renamed 'debounce'

Author: xdd666t

CHANGELOG.md

@@ -1,3 +1,7 @@
+# [3.3.x]
+
+- notice: 'antiShake' renamed 'debounce'
+
 # [3.2.x]
 
 - Major update！
@@ -17,7 +21,7 @@
 - support open multi dialog
 - Monitor back and pop event, then close dialog reasonably
 - Initialization is more concise
-- Add anti-shake function
+- Add debounce feature
 - Add close all dialog status
 - Adjustment comment
 - Add four toast display logic

README.md

@@ -167,8 +167,8 @@ SmartDialog.config
   ..animationDuration = Duration(milliseconds: 260)
   ..isUseAnimation = true
   ..isLoading = true
-  ..antiShake = false
-  ..antiShakeTime = Duration(milliseconds: 300);
+  ..debounce = false
+  ..debounceTime = Duration(milliseconds: 300);
 ```
 
 # Attach Chapter

lib/src/custom/custom_dialog.dart

@@ -37,7 +37,7 @@ class CustomDialog extends BaseDialog {
     required bool isLoading,
     required Color maskColor,
     required bool clickBgDismiss,
-    required bool antiShake,
+    required bool debounce,
     required Widget? maskWidget,
     required VoidCallback? onDismiss,
     required String? tag,
@@ -49,7 +49,7 @@ class CustomDialog extends BaseDialog {
       tag: tag,
       backDismiss: backDismiss,
       keepSingle: keepSingle,
-      antiShake: antiShake,
+      debounce: debounce,
       type: DialogType.custom,
     );
     return mainDialog.show(
@@ -81,7 +81,7 @@ class CustomDialog extends BaseDialog {
     required bool isLoading,
     required Color maskColor,
     required bool clickBgDismiss,
-    required bool antiShake,
+    required bool debounce,
     required Widget? maskWidget,
     required Positioned highlight,
     required HighlightBuilder? highlightBuilder,
@@ -95,7 +95,7 @@ class CustomDialog extends BaseDialog {
       tag: tag,
       backDismiss: backDismiss,
       keepSingle: keepSingle,
-      antiShake: antiShake,
+      debounce: debounce,
       type: DialogType.attach,
     );
     return mainDialog.showAttach(
@@ -148,11 +148,11 @@ class CustomDialog extends BaseDialog {
     required String? tag,
     required bool backDismiss,
     required bool keepSingle,
-    required bool antiShake,
+    required bool debounce,
     required DialogType type,
   }) {
     // debounce
-    if (!_checkDebounce(antiShake)) return;
+    if (!_checkDebounce(debounce)) return;
 
     //handle dialog stack
     _handleDialogStack(
@@ -216,14 +216,14 @@ class CustomDialog extends BaseDialog {
     );
   }
 
-  bool _checkDebounce(bool antiShake) {
-    if (!antiShake) return true;
+  bool _checkDebounce(bool debounce) {
+    if (!debounce) return true;
 
     var proxy = DialogProxy.instance;
     var now = DateTime.now();
     var isShake = proxy.dialogLastTime != null &&
         now.difference(proxy.dialogLastTime!) <
-            SmartDialog.config.antiShakeTime;
+            SmartDialog.config.debounceTime;
     proxy.dialogLastTime = now;
     if (isShake) return false;
 

lib/src/custom/custom_toast.dart

@@ -23,15 +23,15 @@ class CustomToast extends BaseDialog {
     required Color maskColor,
     required Widget? maskWidget,
     required Duration time,
-    required bool antiShake,
+    required bool debounce,
     required SmartToastType type,
     required Widget widget,
   }) async {
     // debounce
-    if (antiShake) {
+    if (debounce) {
       var now = DateTime.now();
       var isShake = _lastTime != null &&
-          now.difference(_lastTime!) < SmartDialog.config.antiShakeTime;
+          now.difference(_lastTime!) < SmartDialog.config.debounceTime;
       _lastTime = now;
       if (isShake) return;
     }

lib/src/helper/config.dart

@@ -65,22 +65,22 @@ class Config {
   /// 点击遮罩，是否关闭dialog（默认：true）：true（点击遮罩关闭dialog），false（不关闭）
   bool clickBgDismiss = true;
 
-  /// debounce function，it works on toast and dialog：default（false）;
-  /// you can use the [antiShakeTime] param to set the debounce time
+  /// debounce feature，it works on toast and dialog：default（false）;
+  /// you can use the [debounceTime] param to set the debounce time
   ///
   /// 防抖功能（debounce），它作用于toast和dialog上：默认（false）;
-  /// 可以通过[antiShakeTime]参数设置防抖时间
-  bool antiShake = false;
-  Duration antiShakeTime = Duration(milliseconds: 300);
+  /// 可以通过[debounceTime]参数设置防抖时间
+  bool debounce = false;
+  Duration debounceTime = Duration(milliseconds: 300);
 
   /// whether loading and custom dialog exist on the screen
   ///
-  /// loading和自定义dialog，是否存在在界面上
+  /// loading，自定义dialog和attach，是否存在在界面上
   bool isExist = false;
 
   /// whether custom dialog exist on the screen
   ///
-  /// 自定义dialog是否存在在界面上
+  /// 自定义dialog和attach是否存在在界面上
   bool isExistMain = false;
 
   /// whether loading exist on the screen

lib/src/helper/dialog_proxy.dart

@@ -57,7 +57,7 @@ class DialogProxy {
     required Color maskColor,
     required bool clickBgDismiss,
     required Widget? maskWidget,
-    required bool antiShake,
+    required bool debounce,
     required VoidCallback? onDismiss,
     required String? tag,
     required bool backDismiss,
@@ -79,7 +79,7 @@ class DialogProxy {
       maskWidget: maskWidget,
       clickBgDismiss: clickBgDismiss,
       onDismiss: onDismiss,
-      antiShake: antiShake,
+      debounce: debounce,
       tag: tag,
       backDismiss: backDismiss,
       keepSingle: keepSingle,
@@ -100,7 +100,7 @@ class DialogProxy {
     required Widget? maskWidget,
     required Positioned highlight,
     required HighlightBuilder? highlightBuilder,
-    required bool antiShake,
+    required bool debounce,
     required VoidCallback? onDismiss,
     required String? tag,
     required bool backDismiss,
@@ -126,7 +126,7 @@ class DialogProxy {
       highlightBuilder: highlightBuilder,
       clickBgDismiss: clickBgDismiss,
       onDismiss: onDismiss,
-      antiShake: antiShake,
+      debounce: debounce,
       tag: tag,
       backDismiss: backDismiss,
       keepSingle: keepSingle,
@@ -166,7 +166,7 @@ class DialogProxy {
     required Color maskColor,
     required Widget? maskWidget,
     required Duration time,
-    required bool antiShake,
+    required bool debounce,
     required SmartToastType type,
     required Widget widget,
   }) async {
@@ -179,7 +179,7 @@ class DialogProxy {
       maskColor: maskColor,
       maskWidget: maskWidget,
       time: time,
-      antiShake: antiShake,
+      debounce: debounce,
       type: type,
       widget: ToastHelper(child: widget),
     );

lib/src/smart_dialog.dart

@@ -87,7 +87,7 @@ class SmartDialog {
   ///
   /// [maskWidgetTemp]：highly customizable mask
   ///
-  /// [antiShakeTemp]：anti-shake function（debounce）
+  /// [debounceTemp]：debounce feature
   ///
   /// [onDismiss]：the callback will be invoked when the dialog is closed
   ///
@@ -120,7 +120,7 @@ class SmartDialog {
   ///
   /// [maskWidgetTemp]：可高度定制遮罩
   ///
-  /// [antiShakeTemp]：防抖功能（debounce）
+  /// [debounceTemp]：防抖功能（debounce）
   ///
   /// [onDismiss]：在dialog被关闭的时候，该回调将会被触发
   ///
@@ -141,7 +141,7 @@ class SmartDialog {
     Duration? animationDurationTemp,
     Color? maskColorTemp,
     Widget? maskWidgetTemp,
-    bool? antiShakeTemp,
+    bool? debounceTemp,
     VoidCallback? onDismiss,
     String? tag,
     bool? backDismiss,
@@ -157,7 +157,7 @@ class SmartDialog {
       animationDuration: animationDurationTemp ?? config.animationDuration,
       maskColor: maskColorTemp ?? config.maskColor,
       maskWidget: maskWidgetTemp ?? config.maskWidget,
-      antiShake: antiShakeTemp ?? config.antiShake,
+      debounce: debounceTemp ?? config.debounce,
       onDismiss: onDismiss,
       tag: tag,
       backDismiss: backDismiss ?? true,
@@ -191,7 +191,7 @@ class SmartDialog {
   ///
   /// [maskWidgetTemp]：highly customizable mask
   ///
-  /// [antiShakeTemp]：anti-shake function（debounce）
+  /// [debounceTemp]：debounce feature
   ///
   /// [highlight]：highlight feature, dissolve the mask of a specific area
   ///
@@ -234,7 +234,7 @@ class SmartDialog {
   ///
   /// [maskWidgetTemp]：可高度定制遮罩
   ///
-  /// [antiShakeTemp]：防抖功能（debounce）
+  /// [debounceTemp]：防抖功能（debounce）
   ///
   /// [highlight]：高亮功能，溶解特定区域的遮罩
   ///
@@ -262,7 +262,7 @@ class SmartDialog {
     Duration? animationDurationTemp,
     Color? maskColorTemp,
     Widget? maskWidgetTemp,
-    bool? antiShakeTemp,
+    bool? debounceTemp,
     Positioned? highlight,
     HighlightBuilder? highlightBuilder,
     VoidCallback? onDismiss,
@@ -284,7 +284,7 @@ class SmartDialog {
       animationDuration: animationDurationTemp ?? config.animationDuration,
       maskColor: maskColorTemp ?? config.maskColor,
       maskWidget: maskWidgetTemp ?? config.maskWidget,
-      antiShake: antiShakeTemp ?? config.antiShake,
+      debounce: debounceTemp ?? config.debounce,
       highlight: highlight ?? Positioned(child: Container()),
       highlightBuilder: highlightBuilder,
       onDismiss: onDismiss,
@@ -399,7 +399,7 @@ class SmartDialog {
   ///
   /// [time]：toast display time on the screen(Use the 'widget' param, this param will be invalid)
   ///
-  /// [antiShakeTemp]：anti-shake function（debounce）
+  /// [debounceTemp]：debounce feature
   ///
   /// [type]：provider multiple display logic，
   /// please refer to [SmartToastType] comment for detailed description
@@ -428,7 +428,7 @@ class SmartDialog {
   ///
   /// [time]：toast在屏幕上的显示时间
   ///
-  /// [antiShakeTemp]：防抖功能（debounce）
+  /// [debounceTemp]：防抖功能（debounce）
   ///
   /// [type]：提供多种显示逻辑，详细描述请查看 [SmartToastType] 注释
   ///
@@ -444,7 +444,7 @@ class SmartDialog {
     Widget? maskWidgetTemp,
     AlignmentGeometry alignment = Alignment.bottomCenter,
     Duration? time,
-    bool? antiShakeTemp,
+    bool? debounceTemp,
     SmartToastType? type,
     Widget? widget,
   }) async {
@@ -457,7 +457,7 @@ class SmartDialog {
       maskColor: maskColorTemp ?? config.maskColor,
       maskWidget: maskWidgetTemp ?? config.maskWidget,
       time: time ?? Duration(milliseconds: 2000),
-      antiShake: antiShakeTemp ?? config.antiShake,
+      debounce: debounceTemp ?? config.debounce,
       type: type ?? SmartToastType.normal,
       widget: widget ?? ToastWidget(msg: msg, alignment: alignment),
     );

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: 3.2.3
+version: 3.3.0
 homepage: https://github.com/fluttercandies/flutter_smart_dialog
 publish_to: https://pub.dartlang.org