一个纯 Dart 的 Flutter 提示库。

oktoast

一个纯Dart的Toast库。

您可以完全自定义提示的样式。

版本

3.x.x

从3.x版本开始，oktoast提供了null-safety版本，null-safety的具体介绍可以查看 dart 或 flutter。

2.3.2版本是不支持null-safety的最后一个版本。

关于1.X.X版本

如果您使用oktoast 1.X.X，请使用1.X分支，并阅读版本自述文件。

建议迁移到2.X.X版本。新版本不需要BuildContext。

而且您可以完全自定义Toast的样式，因为现在您可以使用showToastWidget。

用法

1.将库添加到pubspec.yaml

最新版本:

dependencies:
  oktoast: ^3.0.0 # such as version, you need use the latest version of pub.

2.在dart文件中导入库

import 'package:oktoast/oktoast.dart';

3.包装您的应用Widget

OKToast(
  /// set toast style, optional
  child:MaterialApp()
);

提示
如果您遇到类似这样的错误: No MediaQuery widget found

您可以尝试使用下面的 代码 将oktoast包含到您的App中。

MaterialApp(builder: (context, widget) {
  return OKToast(
    child: widget,
  );
});

4.调用方法showToast

showToast("content");

// position and second have default value, is optional

showToastWidget(Text('hello oktoast'));

解释

您需要包装MaterialApp的两个原因

1. 因为这可以确保Toast显示在所有其他控件的最前面
2. Context可以被缓存，因此可以在任何地方调用而无需传递context

属性

OKToast参数

oktoast具有默认样式，您也可以自定义样式或其他行为。

方法showToast

在Toast上显示文本。

参数说明请参阅OKToast。

方法showToastWidget

在Toast上显示自定义Widget

参数说明请参阅showToast。

方法dismissAllToast

关闭所有Toast。

showToast和showToastWidget的返回值

关于返回类型
showToast和showToastWidget的返回类型是ToastFuture，
ToastFuture可用于关闭Toast。

所有关闭Toast的方法

添加了可选参数showAnim来控制关闭时是否需要淡入动画。

该参数的默认值为false。

示例

import 'package:flutter/material.dart';
import 'package:oktoast/oktoast.dart'; // 1. import library

void main() => runApp( MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return OKToast(
      //2. wrap your app with OKToast
      child:  MaterialApp(
        title: 'Flutter Demo',
        theme:  ThemeData(
          primarySwatch: Colors.blue,
        ),
        home:  MyHomePage(),
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key}) : super(key: key);

  @override
  _MyHomePageState createState() =>  _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    _counter++;

    // 3.1 use showToast method
    showToast(
      "$_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 widget
    Widget 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 future
    Future.delayed(Duration(seconds: 1), () {
      toastFuture.dismiss(); // dismiss
    });

    setState(() {

    });
  }

  @override
  Widget build(BuildContext context) {
    return  Scaffold(
      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: const EdgeInsets.all(8.0),
                  child: RaisedButton(
                    onPressed: () {
                      Navigator.push(context,
                          MaterialPageRoute(builder: (ctx) => MyHomePage()));
                    },
                  ),
                ),
                Padding(
                  padding: const EdgeInsets.all(8.0),
                  child: RaisedButton(
                    onPressed: _incrementCounter,
                    child: Text('toast'),
                  ),
                ),
              ],
            ),
          ),
        ],
      ),
    );
  }
}

GitHub

https://github.com/OpenFlutter/flutter_oktoast