🔖 ## 3.1.3 (#86)

Author: AlexV525

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 3.1.3
+
+- Throw a more precise error if the `OKToast` widget is not wrapped correctly.
+- Bind `ToastFuture` with `OverlayEntry` mounted state.
+
 ## 3.1.2
 
 - Deliver overlay insertion into microtask.

README.md

@@ -23,7 +23,7 @@ You can completely customize the style of toast.
 
 ### 3.x.x
 
-Starting from the 3.x version, OkToast provides a null-safety version,
+Starting from the 3.x version, OKToast provides a null-safety version,
 the specific introduction of null-safety can be viewed in [dart][dart-safe] or [flutter][flutter-safe].
 
 [flutter-safe]: https://flutter.dev/docs/null-safety
@@ -33,7 +33,7 @@ The 2.3.2 version is the last version that does not support null-safety.
 
 ### About version 1.x
 
-if you use OkToast 1.x, Please use the 1.x branch, and read version readme.
+if you use OKToast 1.x, Please use the 1.x branch, and read version readme.
 
 Proposed migration to 2.x version. The new version does not require buildContext.
 
@@ -47,7 +47,7 @@ latest version: [![pub package](https://img.shields.io/pub/v/oktoast.svg)](https
 
 ```yaml
 dependencies:
-  oktoast: ^3.0.0 # such as version, you need use the latest version of pub.
+  oktoast: ^latest_version
 ```
 
 ### 2. Import library in dart file
@@ -65,23 +65,23 @@ OKToast(
 );
 ```
 
-tips:
-If you happened error like: `No MediaQuery widget found`
-
-you can try to use next [code](https://github.com/OpenFlutter/flutter_oktoast/issues/53#issuecomment-628431625) to include `oktoast` to your App.
+Tips:
+If you happened error like: `No MediaQuery widget found`,
+you can try to use this [code](https://github.com/OpenFlutter/flutter_oktoast/issues/53#issuecomment-628431625)
+to include `OKToast` to your App.
 
 ```dart
-MaterialApp(builder: (context, widget) {
-  return OKToast(
-    child: widget,
-  );
-});
+MaterialApp(
+  builder: (BuildContext context, Widget? widget) {
+    return OKToast(child: widget);
+  },
+);
 ```
 
 ### 4. Call method `showToast`
 
 ```dart
-showToast("content");
+showToast('content');
 
 // position and second have default value, is optional
 
@@ -99,7 +99,7 @@ There are two reasons why you need to wrap MaterialApp
 
 ### OKToast params
 
-oktoast have default style, and you also can custom style or other behavior.
+OKToast have default style, and you also can custom style or other behavior.
 
 |         name         |          type           |   need   |                             desc                              |
 | :------------------: | :---------------------: | :------: | :-----------------------------------------------------------: |
@@ -191,7 +191,7 @@ class MyApp extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return OKToast(
-      //2. wrap your app with OKToast
+      // 2. wrap your app with OKToast
       child:  MaterialApp(
         title: 'Flutter Demo',
         theme:  ThemeData(

lib/src/core/toast.dart

@@ -44,6 +44,9 @@ ToastFuture showToast(
   BoxConstraints? constraints,
   EdgeInsetsGeometry? margin = const EdgeInsets.all(50),
 }) {
+  if (context == null) {
+    _throwIfNoContext(_contextMap.values, 'showToast');
+  }
   context ??= _contextMap.values.first;
 
   final _ToastTheme theme = _ToastTheme.of(context);
@@ -94,6 +97,9 @@ ToastFuture showToastWidget(
   Duration? animationDuration,
   Curve? animationCurve,
 }) {
+  if (context == null) {
+    _throwIfNoContext(_contextMap.values, 'showToastWidget');
+  }
   context ??= _contextMap.values.first;
   final _ToastTheme theme = _ToastTheme.of(context);
 
@@ -150,14 +156,40 @@ ToastFuture showToastWidget(
     });
   }
 
-  Future<void>.microtask(() {
+  ToastManager().addFuture(future);
+
+  void _insertOverlayEntry() {
     Overlay.of(context!)?.insert(entry);
-    ToastManager().addFuture(future);
-  });
+  }
+
+  if (!context.debugDoingBuild && context.owner?.debugBuilding != true) {
+    _insertOverlayEntry();
+  } else {
+    WidgetsBinding.instance?.addPostFrameCallback((_) {
+      if (!future.dismissed) {
+        _insertOverlayEntry();
+      }
+    });
+  }
 
   return future;
 }
 
 void dismissAllToast({bool showAnim = false}) {
   ToastManager().dismissAll(showAnim: showAnim);
 }
+
+void _throwIfNoContext(Iterable<BuildContext> contexts, String methodName) {
+  final List<DiagnosticsNode> information = <DiagnosticsNode>[
+    ErrorSummary('No OKToast widget found.'),
+    ErrorDescription(
+      '$methodName requires an OKToast widget ancestor '
+      'for correct operation.',
+    ),
+    ErrorHint(
+      'The most common way to add an OKToast to an application '
+      'is to wrap a OKToast upon a WidgetsApp(MaterialApp/CupertinoApp).',
+    ),
+  ];
+  throw FlutterError.fromParts(information);
+}

lib/src/core/toast_future.dart

@@ -7,18 +7,35 @@ class ToastFuture {
     this._onDismiss,
     this._containerKey,
     this.animationDuration,
-  );
+  ) {
+    _entry.addListener(_mountedListener);
+  }
 
   final OverlayEntry _entry;
   final VoidCallback? _onDismiss;
   final GlobalKey<__ToastContainerState> _containerKey;
   final Duration animationDuration;
 
   Timer? timer;
-  bool _isShow = true;
+  bool _isShow = false;
+  bool _dismissed = false;
+
+  bool get mounted => _isShow;
+
+  bool get dismissed => _dismissed;
+
+  void _mountedListener() {
+    _isShow = _entry.mounted;
+  }
+
+  void _removeEntry() {
+    _entry.removeListener(_mountedListener);
+    _entry.remove();
+  }
 
   void dismiss({bool showAnim = false}) {
     if (!_isShow) {
+      _dismissed = true;
       return;
     }
     _isShow = false;
@@ -27,11 +44,12 @@ class ToastFuture {
 
     if (showAnim) {
       _containerKey.currentState?.showDismissAnim();
-      Future<void>.delayed(animationDuration, _entry.remove);
+      Future<void>.delayed(animationDuration, _removeEntry);
     } else {
-      _entry.remove();
+      _removeEntry();
     }
 
     timer?.cancel();
+    _dismissed = true;
   }
 }

pubspec.yaml

@@ -1,8 +1,8 @@
 name: oktoast
-description: A pure flutter toast library  Support custom style/widget. Easy to use. You can use this library to achieve the same effect as Android toast.
+description: A pure flutter toast library, support custom style/widget, easy achieve the same effect with native toasts.
 email: [email protected]
 homepage: https://github.com/OpenFlutter/flutter_oktoast
-version: 3.1.2
+version: 3.1.3
 
 environment:
   sdk: '>=2.12.0 <3.0.0'