KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

bot_toast

★ 847 Open GitHub ↗

A very easy-to-use flutter popup library. Including toast, loading, etc.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

[![](https://img.shields.io/pub/v/bot_toast.svg?label=bot_toast&logo=https%3A%2F%2Fpub.flutter-io.cn%2Fpackages%2Fbot_toast)](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
--------|-------|--------
![Notification](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/notification.gif)|![Attached](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/attached.gif)|![CustomAnimation](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/custom_animation.gif)

Loading|Text|CustomWidget
--------|-------|----------
![Loading](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/loading.gif)|![Text](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/text.gif)|![CustomWidget](https://raw.githubusercontent.com/MMMzq/bot_toast/master/doc/gif/custom_widget.gif)

### 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(),
  )
```

<br>

###  Documentation
[API Documentation](API.md)

bot_toast

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README