GitLocker: The Coding Marketplace

Description:

bot toast

BotToast 🤖 #
A really easy to use flutter toast library!

Language: English | 中文简体 #

Overview
Online Demo
Example
Renderings
Getting started
3.0 version
Documentation

Overview #

In the true sense of Toast, you can call it whenever you need it, without any restrictions!

Feature-rich, support for displaying notifications, text, loading, attachments, etc. Toast

Support for popping up various custom Toasts, or you can pop up any Widget as long as it meets the requirements of the flutter code.

API is simple and easy to use

Pure flutter implementation

Supports global configuration

Online Demo #
Online demo (Web effects may be biased, the actual effect is subject to the mobile phone)
Example #
Sample project
Renderings #

Notification
Attached
CustomAnimation

Loading
Text
CustomWidget

Getting started #
1. Add dependencies into you project pubspec.yaml file
dependencies:
bot_toast: ^4.1.0 #null safety
copied to clipboard
2. Import BotToast Lib
import 'package:bot_toast/bot_toast.dart';
copied to clipboard
3. Initialization BotToast
MaterialApp(
title: 'BotToast Demo',
builder: BotToastInit(), //1. call BotToastInit
navigatorObservers: [BotToastNavigatorObserver()], //2. registered route observer
home: XxxxPage(),
)
copied to clipboard
or
//Warning: Don't arbitrarily adjust the position of calling the BotToastInit function
final botToastBuilder = BotToastInit(); //1. call BotToastInit
MaterialApp(
title: 'BotToast Demo',
builder: (context, child) {
child = myBuilder(context,child); //do something
child = botToastBuilder(context,child);
return child;
},
navigatorObservers: [BotToastNavigatorObserver()], //2. registered route observer
home: XxxxPage(),
)
copied to clipboard
4. Use BotToast
var cancel = BotToast.showText(text:"xxxx"); //popup a text toast;
...
cancel(); //close
copied to clipboard
var cancel = BotToast.showSimpleNotification(title: "init"); // popup a notification toast;
...
cancel(); //close
copied to clipboard
var cancel = BotToast.showLoading(); //popup a loading toast
...
cancel(); //close
copied to clipboard
//popup a attachments toast
var cancel = BotToast.showAttachedWidget(
attachedBuilder: (_) => Card(
child: Padding(
padding: const EdgeInsets.all(8.0),
child: Icon(
Icons.favorite,
color: Colors.redAccent,
),
),
),
duration: Duration(seconds: 2),
target: Offset(520, 520));
...
cancel(); //close
copied to clipboard
//custom api
var cancel = BotToast.showCustomNotification(...)
var cancel = BotToast.showCustomText(...)
var cancel = BotToast.showCustomLoading(...)
var cancel = BotToast.showAnimationWidget(...)
...
cancel(); //close
copied to clipboard
5. Modify Global Configuration
/// For example: Globally change the animation duration for standard notifications to 1 second.
BotToast.defaultOption.notification.animationDuration = const Duration(seconds: 1);

/// For more default options, refer to the following configurations:
/// [BotToast.defaultOption.simpleNotification] corresponds to the default values of [showSimpleNotification].
/// [BotToast.defaultOption.notification] corresponds to the default values of [showNotification].
/// [BotToast.defaultOption.customNotification] corresponds to the default values of [showCustomNotification].
/// [BotToast.defaultOption.text] corresponds to the default values of [showText].
/// [BotToast.defaultOption.customText] corresponds to the default values of [showCustomText].
/// [BotToast.defaultOption.loading] corresponds to the default values of [showLoading].
/// [BotToast.defaultOption.customLoading] corresponds to the default values of [showCustomLoading].
/// [BotToast.defaultOption.attached] corresponds to the default values of [showAttachedWidget].
/// [BotToast.defaultOption.animation] corresponds to the default values of [showAnimationWidget].
/// [BotToast.defaultOption.enhanced] corresponds to the default values of [showEnhancedWidget].
copied to clipboard
3.0 version #
Major changes:

Reimplemented the underlying initialization logic, the code is simpler and more general, and no longer depends on Navigator

Modify the initialization method

2.x version upgrade to 3.x version
change:
//2.x.x version initialization method
BotToastInit(
child:MaterialApp(
title: 'BotToast Demo',
navigatorObservers: [BotToastNavigatorObserver()],
home: XxxxPage(),
)
);
copied to clipboard
to:
//3.x.x version initialization method
MaterialApp(
title: 'BotToast Demo',
builder: BotToastInit(),
navigatorObservers: [BotToastNavigatorObserver()],
home: XxxxPage(),
)
copied to clipboard

Documentation #
API Documentation