Merge pull request #12 from MMMzq/dev

Dev

Author: MMMzq

CHANGELOG.md

@@ -1,3 +1,19 @@
+## [2.1.0]
+* bug fix: see [#11](https://github.com/MMMzq/bot_toast/issues/11)
+
+* 移除`BotToastInit`的`key`参数
+
+* `BotToast.init`方法变为私有方法不再公开
+
+* 重构了初始化的方式
+
+* Remove the `key` parameter of `BotToastInit`
+
+* `BotToast.init` method becomes private and no longer public
+
+* Refactored the way to initialize
+
+
 ## [2.0.0+2]
 * Update document
 

README.md

@@ -51,7 +51,7 @@ Loading|Text|CustomWidget
 #### 1. add dependencies into you project pubspec.yaml file
 ``` dart
 dependencies:
-     bot_toast: ^2.0.0
+     bot_toast: ^2.1.0
 ```
 
 #### 2. import BotToast lib

README_zh.md

@@ -55,7 +55,7 @@ Loading|Text|CustomWidget
 #### 1. pubspec.yaml文件里添加依赖
 ``` dart
 dependencies:
-     bot_toast: ^2.0.0
+     bot_toast: ^2.1.0
 ```
 
 #### 2. 导入BotToast库

lib/bot_toast.dart

@@ -1,6 +1,6 @@
 library bot_toast;
 
 export 'src/basis.dart';
-export 'src/bot_toast_init.dart';
+export 'src/bot_toast_init.dart' show BotToastInit;
 export 'src/toast.dart';
 export 'src/toast_navigator_observer.dart';

lib/src/bot_toast_init.dart

@@ -1,32 +1,43 @@
 import 'package:flutter/material.dart';
 
-import 'toast.dart';
+final GlobalKey<_BotToastInitState> botToastInitKey =
+GlobalKey<_BotToastInitState>();
 
 class BotToastInit extends StatefulWidget {
-
   final Widget child;
 
-  const BotToastInit({Key key, this.child}) : super(key: key);
+  BotToastInit({@required this.child})
+      : assert(child != null),
+        super(key: botToastInitKey);
 
   @override
   _BotToastInitState createState() => _BotToastInitState();
 }
 
 class _BotToastInitState extends State<BotToastInit> {
+  bool _needInit;
+
+  bool get needInit => _needInit;
+
+  void reset() {
+    _needInit = false;
+  }
+
   @override
   Widget build(BuildContext context) {
+    _needInit = true;
     return widget.child;
   }
 
   @override
   void initState() {
-    BotToast.init(context);
+    _needInit = true;
     super.initState();
   }
 
   @override
   void didUpdateWidget(BotToastInit oldWidget) {
-    BotToast.init(context);
+    _needInit = true;
     super.didUpdateWidget(oldWidget);
   }
 }

lib/src/toast.dart

@@ -4,6 +4,7 @@ import 'dart:ui';
 import 'package:flutter/material.dart';
 import 'package:flutter/scheduler.dart';
 import 'basis.dart';
+import 'bot_toast_init.dart';
 import 'bot_toast_manager.dart';
 import 'key_board_safe_area.dart';
 import 'toast_navigator_observer.dart';
@@ -42,6 +43,7 @@ class BotToast {
   static const String loadKey = '_loadKey';
   static const String attachedKey = '_attachedKey';
   static const String defaultKey = '_defaultKey';
+  static Completer<void> _initCompleter;
 
   static final Map<String, List<CancelFunc>> cacheCancelFunc = {
     textKey: [],
@@ -51,27 +53,34 @@ class BotToast {
     defaultKey: [],
   };
 
-  ///一般这种情况只会出现在pop所有路由再推一个路由出现,同时根[MaterialApp.navigatorKey]改变就会出现问题,所以只能手动reInit
-  static void init(BuildContext context) {
+
+  static void _init(BuildContext context) {
     assert(BotToastNavigatorObserver.debugInitialization, """
     Please initialize properly!
     Example:
     BotToastInit(
       child: MaterialApp(
         title: 'BotToast Demo',
         navigatorObservers: [BotToastNavigatorObserver()],
-        home: EnterPage()
+        home: XxxPage()
       ),
     );
     """);
+    _initCompleter=Completer<void>();
     _safeRun(() {
       void visitor(Element element) {
+        assert((){
+          if(element.widget is Localizations && ((element as StatefulElement).state as dynamic).locale==null){
+            return false;
+          }
+          return true;
+        }(), 'Initialization error : locale==null');
         if (element.widget is Navigator) {
           if (_navigatorState == null ||
               _managerState.currentState == null ||
               _navigatorState != (element as StatefulElement).state) {
             _navigatorState = (element as StatefulElement).state;
-            _init();
+            _doInit();
           }
         } else {
           element.visitChildElements(visitor);
@@ -88,15 +97,16 @@ class BotToast {
          BotToastInit(
                child: MaterialApp(
                  navigatorObservers: [BotToastNavigatorObserver()],
-                 home: EnterPage(),
+                 home: XxxPage(),
                ),
              );
       ''');
+      _initCompleter.complete();
     });
   }
 
   ///这里需要监听didPush是因为,当Navigator的Route集合为空再推一个Route会导致这个页面覆盖_BotToastManager上面,挡住了Toast,因此要手动移动到最后
-  static void _init() {
+  static void _doInit() {
     _managerState = GlobalKey<BotToastManagerState>();
     BotToastNavigatorObserverProxy observerProxy;
     final overlayEntry = OverlayEntry(
@@ -805,39 +815,38 @@ class BotToast {
     final CancelFunc cancelFunc = () {
       remove(uniqueKey, gk);
     };
-    _safeRun(() {
-      /*
-      如果currentState为空说明此时BotToast还没初始化完成,此时的状态是处理showWidget和init方法都是是在同一帧里,
-      因此要把showWidget方法放在下一帧处理
-      */
-      if (_managerState.currentState == null) {
-        _safeRun(() {
-          _managerState.currentState
-              .insert(gk, uniqueKey, toastBuilder(cancelFunc));
-        });
-      } else {
+    ()async{
+      assert(botToastInitKey.currentState !=
+          null, 'Please wait for BotToastInit to be attached to the Widget tree and then call');
+      if(botToastInitKey.currentState.needInit){
+        botToastInitKey.currentState.reset();
+        _init(botToastInitKey.currentContext);
+        assert(!_initCompleter.isCompleted);
+      }
+      await _initCompleter.future;
+      _safeRun(() {
         _managerState.currentState
             .insert(gk, uniqueKey, toastBuilder(cancelFunc));
-      }
-    });
+      });
+    }();
     return cancelFunc;
   }
 
   static void remove(UniqueKey key, [String groupKey]) {
     _safeRun(() {
-      _managerState.currentState.remove(groupKey ?? defaultKey, key);
+      _managerState.currentState?.remove(groupKey ?? defaultKey, key);
     });
   }
 
   static void removeAll([String groupKey]) {
     _safeRun(() {
-      _managerState.currentState.removeAll(groupKey ?? defaultKey);
+      _managerState.currentState?.removeAll(groupKey ?? defaultKey);
     });
   }
 
   static void cleanAll() {
     _safeRun(() {
-      _managerState.currentState.cleanAll();
+      _managerState.currentState?.cleanAll();
     });
   }
 

lib/src/toast_navigator_observer.dart

@@ -18,16 +18,6 @@ class BotToastNavigatorObserverProxy {
 }
 
 ///如果你项目有多个[Navigator],请将该BotToastNavigatorObserver添加到[Navigator.observers]
-///可以参考[BotToast.init]方法添加
-///或者在创建[Navigator]时直接添加
-///    Example:
-///    MaterialApp(
-///      navigatorObservers: [BotToastNavigatorObserver()],
-///      title: 'Flutter Demo',
-///      home: ToastWidget(
-///        child: XxxxPage(title: 'Flutter Demo Home Page'),
-///      ),
-///    );
 class BotToastNavigatorObserver extends NavigatorObserver {
   static final List<BotToastNavigatorObserverProxy> _leavePageCallbacks = [];
 
@@ -44,11 +34,12 @@ class BotToastNavigatorObserver extends NavigatorObserver {
     assert(debugInitialization, """
     Please initialize!
     Example:
-    MaterialApp(
-      title: 'BotToast Demo',
+    BotToastInit(
+      child:MaterialApp(
+      title: 'Xxxx Demo',
       navigatorObservers: [BotToastNavigatorObserver()],
-      home: BotToastInit(child: EnterPage()),
-    );
+      home: XxxxPage(),
+    ));
     """);
     assert(botToastNavigatorObserverProxy != null);
     _leavePageCallbacks.add(botToastNavigatorObserverProxy);

pubspec.yaml

@@ -4,7 +4,7 @@ author: MMMzq<vivask770@163.com>
 homepage: https://github.com/MMMzq/bot_toast
 email: vivask770@163.com
 
-version: 2.0.0+2
+version: 2.1.0
 
 environment:
   sdk: ">=2.1.0 <3.0.0"