BotToast ❤ #

一个真正意义上的flutter Toast库! #

🐶特点 #

• 真正意义上的Toast,可以在任何你需要的时候调用,不会有任何限制! (这是他最重要的特点,跟别的Toast库不同的地方)

• 功能丰富,支持显示通知,文本,加载,附属等类型Toast

• 支持在弹出各种自定义Toast,或者说你可以弹出任何Widget,只要它符合flutter代码的要求即可

• Api简单易用,基本上没有必要参数(包括BuildContext),基本上都是可选参数

• 纯flutter实现,不容易带来兼容问题

🐼例子 #

在线例子(Online demo) (Web效果可能有偏差,真实效果请以手机端为准)

🐺效果图 #

Notification	Attached

Loading	Text

🐮快速使用 #

1. pubspec.yaml文件里添加依赖

dependencies:
     bot_toast: 1.0.3

2. 导入BotToast库

import 'package:bot_toast/bot_toast.dart';

3. 初始化BotToast

///像这样,BotToast将会自动去初始化
MaterialApp(
      title: 'BotToast Demo',
      navigatorObservers: [BotToastNavigatorObserver()],//1.注册路由观察者
      home: BotToastInit(  //2.初始化BotToast
          child: XxxxPage()
      ),
    );

4. 使用BotToast

BotToast.showText(text:"xxxx");  //弹出一个文本框;

BotToast.showSimpleNotification(title: "init"); //弹出简单通知Toast

BotToast.showLoading(); //弹出一个加载动画

//弹出一个定位Toast
BotToast.showAttachedWidget(
    attachedWidget: (_) => Card(
          child: Padding(
            padding: const EdgeInsets.all(8.0),
            child: Icon(
              Icons.favorite,
              color: Colors.redAccent,
            ),
          ),
        ),
    duration: Duration(seconds: 2),
    target: Offset(520, 520));

🐨注意事项 #

• 如果你项目有多个[Navigator],请将该BotToastNavigatorObserver添加到[Navigator.observers]

• [ToastBuilder]方法生成widget时,请确保生成的Widget背景不会吸收点击事件,例如[Scaffold],[Material]都会默认占满整个父空间, 并且会吸收事件(就算透明也是这种情况),具体例子可看[material.dart->_RenderInkFeatures class->hitTestSelf method] 如果真的要生成,可以考虑使用[IgnorePointer],如果没有遵守规则,将会时某些功能失效例如[allowClick]功能就会失效

• 如果你在项目中使用了[MaterialApp.navigatorKey]参数请在改变[MaterialApp.navigatorKey]时请调用reInit重新初始化

  @override
  void initState() {
    Future.delayed(Duration(seconds: 1), //模拟点击改变GlobalKey<NavigatorState>
        (){
          setState(() {
            navigatorState=GlobalKey<NavigatorState>();
            BotToast.reInit(()=>navigatorState.currentState);
          });
        }
    );
    super.initState();
  }

更详细的实现细节请看bot_toast是怎样炼成的

🐹主要Api文档 #

区域图

  _________________________________
|          MainContent            |
|                                 |
|                                 |
|      ___________________        |
|     |                   |       |
|     |    ToastContent   |       |
|     |___________________|       |
|_________________________________|

通用参数说明

1.BotToast.showSimpleNotification

显示简单的通知Toast

2.BotToast.showNotification

显示一个标准的通知Toast

3.BotToast.showCustomNotification

显示一个自定义的通知Toast

4.BotToast.showAttachedWidget

显示一个定位Toast,该方法可以在某个Widget(一般是Button)或者给定一个offset周围显示

5.BotToast.showText

显示一个标准文本Toast

6.BotToast.showCustomText

显示一个自定义的文本Toast

7.BotToast.showLoading

显示一个标准的加载Toast

8.BotToast.showCustomLoading

显示一个自定义的加载Toast

9.BotToast.showEnhancedWidget

显示一个增强Toast,该方法可以让Toast自带很多特性,例如定时关闭,点击屏幕自动关闭,离开当前Route关闭等等

10.BotToast.showWidget

显示一个Widget在屏幕上,该Widget可以跨多个页面存在