- Notifications
You must be signed in to change notification settings - Fork63
OpenFlutter/flutter_oktoast
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A library for flutter.
A pure dart toast Library.
You can completely customize the style of toast.
| Default | Custom | GIF |
|---|---|---|
![]() | ![]() | ![]() |
Starting from the 3.x version, OKToast provides a null-safety version,the specific introduction of null-safety can be viewed indart orflutter.
The 2.3.2 version is the last version that does not support null-safety.
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.
And you can completely customize the style of toast, because now you can useshowToastWidget.
flutter pub add oktoast
import'package:oktoast/oktoast.dart';
OKToast(/// set toast style, optional child:MaterialApp());
Tips:If you happened error like:No MediaQuery widget found,you can try to use thiscodeto includeOKToast to your App.
MaterialApp( builder: (BuildContext context,Widget? widget) {returnOKToast(child: widget); },);
showToast('content');// position and second have default value, is optionalshowToastWidget(Text('hello oktoast'));
There are two reasons why you need to wrap MaterialApp
- Because this ensures that toast can be displayed in front of all other controls
- Context can be cached so that it can be invoked anywhere without passing in context
OKToast have default style, and you also can custom style or other behavior.
| name | type | need | desc |
|---|---|---|---|
| child | Widget | required | Usually Material App |
| textStyle | TextStyle | optional | |
| radius | double | optional | |
| backgroundColor | Color | optional | backroundColor |
| position | ToastPosition | optional | |
| dismissOtherOnShow | bool | optional | If true, other toasts will be dismissed. Default false. |
| movingOnWindowChange | bool | optional | If true, when the size changes, toast is moved. Default true. |
| textDirection | TextDirection | optional | |
| textPadding | EdgeInsetsGeometry | optional | Outer margin of text |
| textAlign | TextAlign | optional | When the text wraps, the align of the text. |
| handleTouch | bool | optional | Default is false, if it's true, can responed use touch event. |
| animationBuilder | OKToastAnimationBuilder | optional | Add animation to show / hide toast. |
| animationDuration | Duration | optional | The duration of animation. |
| animationCurve | Curve | optional | Curve of animation. |
| duration | Duration | optional | Default duration of toast. |
Display text on toast.
Description of params seeOKToast.
| name | type | need | desc |
|---|---|---|---|
| msg | String | required | Text of toast. |
| context | BuildContext | optional | |
| duration | Duration | optional | |
| position | ToastPosition | optional | |
| textStyle | TextStyle | optional | |
| textPadding | EdgeInsetsGeometry | optional | |
| backgroundColor | Color | optional | |
| radius | double | optional | |
| onDismiss | Function | optional | |
| textDirection | TextDirection | optional | |
| dismissOtherToast | bool | optional | |
| textAlign | TextAlign | optional | |
| animationBuilder | OKToastAnimationBuilder | optional | |
| animationDuration | Duration | optional | |
| animationCurve | Curve | optional |
Display custom widgets on toast
Description of params seeshowToast.
| name | type | need | desc |
|---|---|---|---|
| widget | Widget | required | The widget you want to display. |
| context | BuildContext | optional | |
| duration | Duration | optional | |
| position | ToastPosition | optional | |
| onDismiss | Function | optional | |
| dismissOtherToast | bool | optional | |
| textDirection | TextDirection | optional | |
| handleTouch | bool | optional | |
| animationBuilder | OKToastAnimationBuilder | optional | |
| animationDuration | Duration | optional | |
| animationCurve | Curve | optional |
Dismiss all toast.
about return type:showToast andshowToastWidget return type isToastFuture,TheToastFuture can be use to dismiss the toast.
An optional parametershowAnim is added to control whether fading animation is required for dismiss.
The praram default value isfalse.
import'package:flutter/material.dart';import'package:oktoast/oktoast.dart';// 1. import libraryvoidmain()=>runApp(MyApp());classMyAppextendsStatelessWidget {@overrideWidgetbuild(BuildContext context) {returnOKToast(// 2. wrap your app with OKToast child:MaterialApp( title:'Flutter Demo', theme:ThemeData( primarySwatch:Colors.blue, ), home:MyHomePage(), ), ); }}classMyHomePageextendsStatefulWidget {MyHomePage({Key key}):super(key: key);@override_MyHomePageStatecreateState()=>_MyHomePageState();}class_MyHomePageStateextendsState<MyHomePage> {int _counter=0;void_incrementCounter() { _counter++;// 3.1 use showToast methodshowToast("$_counter", duration:Duration(seconds:2), position:ToastPosition.bottom, backgroundColor:Colors.black.withOpacity(0.8), radius:13.0, textStyle:TextStyle(fontSize:18.0), );showToast("$_counter", duration:Duration(seconds:2), position:ToastPosition.top, backgroundColor:Colors.black.withOpacity(0.8), radius:3.0, textStyle:TextStyle(fontSize:30.0), );// 3.2 use showToastWidget method to custom widgetWidget widget=Center( child:ClipRRect( borderRadius:BorderRadius.circular(30.0), child:Container( width:40.0, height:40.0, color:Colors.grey.withOpacity(0.3), child:Icon(Icons.add, size:30.0, color:Colors.green, ), ), ), );ToastFuture toastFuture=showToastWidget( widget, duration:Duration(seconds:3), onDismiss: () {print("the toast dismiss");// the method will be called on toast dismiss. }, );// can use futureFuture.delayed(Duration(seconds:1), () { toastFuture.dismiss();// dismiss });setState(() { }); }@overrideWidgetbuild(BuildContext context) {returnScaffold( appBar:AppBar( title:Text("ktoast demo"), ), body:Stack( children:<Widget>[Center( child:ListView( children:<Widget>[Text('You have pushed the button this many times:', ),Text('$_counter', style:Theme.of(context).textTheme.display1, ),Padding( padding:constEdgeInsets.all(8.0), child:RaisedButton( onPressed: () {Navigator.push(context,MaterialPageRoute(builder: (ctx)=>MyHomePage())); }, ), ),Padding( padding:constEdgeInsets.all(8.0), child:RaisedButton( onPressed: _incrementCounter, child:Text('toast'), ), ), ], ), ), ], ), ); }}
About
Toast library for Flutter.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors10
Uh oh!
There was an error while loading.Please reload this page.


