Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MMMzq/bot_toast
A very easy-to-use flutter popup library. Including toast, loading, etc.
https://github.com/MMMzq/bot_toast
attachments custom-toast flutter flutter-toast loading notification toast
Last synced: 6 days ago
JSON representation
A very easy-to-use flutter popup library. Including toast, loading, etc.
- Host: GitHub
- URL: https://github.com/MMMzq/bot_toast
- Owner: MMMzq
- License: apache-2.0
- Created: 2019-06-29T15:38:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-29T17:59:39.000Z (5 months ago)
- Last Synced: 2024-07-31T22:05:06.655Z (3 months ago)
- Topics: attachments, custom-toast, flutter, flutter-toast, loading, notification, toast
- Language: Dart
- Homepage:
- Size: 29.1 MB
- Stars: 817
- Watchers: 9
- Forks: 105
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - bot_toast - to-use flutter popup library. Including toast, loading, etc. | MMMzq | 828 | (Dart)
README
BotToast đ¤
=========
A really easy to use flutter toast library!
[](https://pub.dev/packages/bot_toast)
### Language: English | [ä¸æįŽäŊ](README_zh.md)
* [Overview](#Overview)
* [Online Demo](#Online-Demo)
* [Example](#Example)
* [Renderings](#Renderings)
* [Getting started](#Getting-started)
* [3.0 version](#30-version)
* [Documentation](#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](https://mmmzq.github.io/bot_toast/#/)** (Web effects may be biased, the actual effect is subject to the mobile phone)
### Example
**[Sample project](example)**
### Renderings
Notification|Attached|CustomAnimation
--------|-------|--------
||
Loading|Text|CustomWidget
--------|-------|----------
||
### Getting started
#### 1. Add dependencies into you project pubspec.yaml file
``` yaml
dependencies:
bot_toast: ^4.1.0 #null safety
```
#### 2. Import BotToast Lib
``` dart
import 'package:bot_toast/bot_toast.dart';
```
#### 3. Initialization BotToast
``` dart
MaterialApp(
title: 'BotToast Demo',
builder: BotToastInit(), //1. call BotToastInit
navigatorObservers: [BotToastNavigatorObserver()], //2. registered route observer
home: XxxxPage(),
)
```
or
``` dart
//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(),
)
```
#### 4. Use BotToast
``` dart
var cancel = BotToast.showText(text:"xxxx"); //popup a text toast;
...
cancel(); //close
```
```dart
var cancel = BotToast.showSimpleNotification(title: "init"); // popup a notification toast;
...
cancel(); //close
```
```dart
var cancel = BotToast.showLoading(); //popup a loading toast
...
cancel(); //close
```
```dart
//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
```
```dart
//custom api
var cancel = BotToast.showCustomNotification(...)
var cancel = BotToast.showCustomText(...)
var cancel = BotToast.showCustomLoading(...)
var cancel = BotToast.showAnimationWidget(...)
...
cancel(); //close
```
#### 5. Modify Global Configuration
``` dart
/// 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].
```
### 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:
``` dart
//2.x.x version initialization method
BotToastInit(
child:MaterialApp(
title: 'BotToast Demo',
navigatorObservers: [BotToastNavigatorObserver()],
home: XxxxPage(),
)
);
```
to:
``` dart
//3.x.x version initialization method
MaterialApp(
title: 'BotToast Demo',
builder: BotToastInit(),
navigatorObservers: [BotToastNavigatorObserver()],
home: XxxxPage(),
)
```
### Documentation
[API Documentation](API.md)