OKToast

https://pub.dev/packages/oktoast
Admin
OKToast is a pure Flutter toast library that supports custom styles and widgets, enabling developers...
Tokens:4,288
Snippets:33
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation and Setup

Source: https://pub.dev/packages/oktoast

Instructions on how to add the oktoast package to your Flutter project and wrap your application with OKToast.

```APIDOC
## Installation

1. Add the library to your `pubspec.yaml` file:
```dart
flutter pub add oktoast
```

2. Import the library in your Dart file:
```dart
import 'package:oktoast/oktoast.dart';
```

3. Wrap your app widget with `OKToast`:
```dart
OKToast(
  child: MaterialApp(
    // Your app content
  ),
);
```

Alternatively, to avoid `No MediaQuery widget found` errors, use:
```dart
MaterialApp(
  builder: (BuildContext context, Widget? widget) {
    return OKToast(child: widget);
  },
);
```

## OKToast Properties

The `OKToast` widget accepts the following optional parameters for customization:

- **child** (Widget): Required. Usually `MaterialApp` or your root widget.
- **textStyle** (TextStyle): Optional. Custom text style for toasts.
- **radius** (double): Optional. Corner radius for the toast background.
- **backgroundColor** (Color): Optional. Background color of the toast.
- **position** (ToastPosition): Optional. Position of the toast on the screen.
- **dismissOtherOnShow** (bool): Optional. If true, other toasts will be dismissed when a new one is shown. Defaults to `false`.
- **movingOnWindowChange** (bool): Optional. If true, the toast will be moved when the window size changes. Defaults to `true`.
- **textDirection** (TextDirection): Optional. Text direction for the toast content.
- **textPadding** (EdgeInsetsGeometry): Optional. Padding around the text within the toast.
- **textAlign** (TextAlign): Optional. Text alignment when the text wraps.
- **handleTouch** (bool): Optional. If true, the toast can respond to touch events. Defaults to `false`.
- **animationBuilder** (OKToastAnimationBuilder): Optional. Builder for custom show/hide animations.
- **animationDuration** (Duration): Optional. Duration of the toast animation.
- **animationCurve** (Curve): Optional. Curve for the toast animation.
- **duration** (Duration): Optional. Default duration for toasts shown using this widget.
```

--------------------------------

### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/oktoast/install

This is an example of how the oktoast dependency will appear in your pubspec.yaml file after running `flutter pub add oktoast`.

```yaml
dependencies:
  oktoast: ^3.4.0
```

--------------------------------

### Basic OkToast Setup and Usage

Source: https://pub.dev/packages/oktoast

Demonstrates the initial setup of the OkToast widget and how to display simple toast messages with custom durations, positions, and styles. Ensure your app is wrapped with OKToast.

```dart
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'),
                  ),
                ),
              ],
            ),
          ),
        ],
      ),
    );
  }
}

```

--------------------------------

### Flutter Material Page Route Example

Source: https://pub.dev/packages/oktoast/example

This snippet shows how to navigate to a new page using MaterialPageRoute in a Flutter application.

```dart
MaterialPageRoute<void>(
              builder: (_) => const MyHomePage(),
            )
```

--------------------------------

### Flutter FloatingActionButton Example

Source: https://pub.dev/packages/oktoast/example

Shows a standard Flutter FloatingActionButton with a tooltip and an icon. This button is configured to increment a counter when pressed.

```dart
FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Add number',
        child: const Icon(Icons.add),
      )
```

--------------------------------

### Flutter ElevatedButton Example

Source: https://pub.dev/packages/oktoast/example

Demonstrates the usage of an ElevatedButton in Flutter to trigger an action when pressed. This specific button is used to dismiss a toast synchronously.

```dart
ElevatedButton(
                onPressed: _dismissToastSynchronously,
                child: const Text('Synchronously dismiss toast'),
              )
```

--------------------------------

### Initialize OKToast in Flutter App

Source: https://pub.dev/packages/oktoast/example

Wrap the MaterialApp with OKToast to enable toast functionality throughout the application.

```dart
import 'dart:async';

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

import 'miui10_anim.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return buildApp();
  }

  // 2-A: Wrap MaterialApp with OKToast.
  Widget buildWrapperApp() {
    return OKToast(
      // 2-A: wrap your app with OKToast
      child: MaterialApp(
        title: 'Demo for OKToast',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: const MyHomePage(),
      ),
    );
  }

  // 2-B: Or wrap child of the builder method.
  Widget buildApp() {
    return MaterialApp(
      home: const MyHomePage(),
      builder: (_, Widget? child) => OKToast(
        textStyle: const TextStyle(fontSize: 19.0, color: Colors.white),
        backgroundColor: Colors.grey,
        animationCurve: Curves.easeIn,
        animationBuilder: const Miui10AnimBuilder().call,
        animationDuration: const Duration(milliseconds: 200),
        duration: const Duration(seconds: 3),
        child: child!,
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

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

  void _incrementCounter() {
    _counter++;
    setState(() {});
  }

  void _showToast() {
    // 3-A use showToast method
    showToast(
      '$_counter',
      position: ToastPosition.bottom,
      backgroundColor: Colors.black.withOpacity(0.8),
      radius: 13.0,
      textStyle: const TextStyle(fontSize: 18.0, color: Colors.white),
      animationBuilder: const Miui10AnimBuilder().call,
    );

    showToast(
      '$_counter',
      duration: const Duration(milliseconds: 3500),
      position: ToastPosition.top,
      backgroundColor: Colors.black.withOpacity(0.8),
      radius: 3.0,
      textStyle: const TextStyle(fontSize: 30.0, color: Colors.white),
    );

    // 3-B use showToastWidget method
    final 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: const Icon(
            Icons.add,
            size: 30.0,
            color: Colors.green,
          ),
        ),
      ),
    );
    final ToastFuture toastFuture = showToastWidget(
      widget,
      duration: const Duration(seconds: 3),
      onDismiss: () {
        // The method will be called on toast dismiss.
        debugPrint('Toast has been dismissed.');
      },
    );

    // can use future
    Future<void>.delayed(const Duration(seconds: 2), () {
      toastFuture.dismiss(); // dismiss
    });
  }

  ToastFuture? _persistToast;

  void _showPersistToast() {
    _persistToast = showToastWidget(
      Center(
        child: ElevatedButton(
          onPressed: () => _persistToast?.dismiss(),
          child: const Text('Click this button to dismiss'),
        ),
      ),
      duration: Duration.zero,
      handleTouch: true,
    );
  }

  void _dismissToastSynchronously() {
    final ToastFuture toast = showToast('Synchronously dismiss');
    toast.dismiss();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Example for OKToast')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Center(
              child: Text('You have pushed the button this many times:'),
            ),
            Center(
              child: Text(
                '$_counter',
                style: const TextStyle(
                  fontSize: 20.0,
                  fontWeight: FontWeight.w600,
                ),
              ),
            ),
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: ElevatedButton(
                onPressed: _showToast,
                child: const Text('Show toast'),
              ),
            ),
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: ElevatedButton(
                onPressed: _showPersistToast,
                child: const Text('Show a persist toast'),
              ),
            ),
            Padding(
              padding: const EdgeInsets.all(8.0),
              child: ElevatedButton(
                child: const Text('Toast during pushing to a new page'),
                onPressed: () {
                  _showToast();
                  Navigator.push(
                    context,

```

--------------------------------

### Import oktoast library

Source: https://pub.dev/packages/oktoast

Import the oktoast library into your Dart file to use its functionalities.

```dart
import 'package:oktoast/oktoast.dart';

```

--------------------------------

### Alternative OKToast wrapping for context issues

Source: https://pub.dev/packages/oktoast

If you encounter 'No MediaQuery widget found' errors, use this alternative method to wrap your MaterialApp with OKToast within the builder to ensure context is properly established.

```dart
MaterialApp(
  builder: (BuildContext context, Widget? widget) {
    return OKToast(child: widget);
  },
);

```

--------------------------------

### Displaying Toasts

Source: https://pub.dev/packages/oktoast

Methods for displaying text toasts and custom widget toasts.

```APIDOC
## Method `showToast`

Displays a text message as a toast.

### Parameters

- **msg** (String): Required. The text content of the toast.
- **context** (BuildContext): Optional. The context to display the toast in. If not provided, it will try to find one.
- **duration** (Duration): Optional. How long the toast should be displayed. Overrides the default duration set in `OKToast`.
- **position** (ToastPosition): Optional. The position of the toast on the screen. Overrides the default position.
- **textStyle** (TextStyle): Optional. Custom text style for this specific toast.
- **textPadding** (EdgeInsetsGeometry): Optional. Padding for the text.
- **backgroundColor** (Color): Optional. Background color for this toast.
- **radius** (double): Optional. Corner radius for this toast.
- **onDismiss** (Function): Optional. Callback function executed when the toast is dismissed.
- **textDirection** (TextDirection): Optional. Text direction for this toast.
- **dismissOtherToast** (bool): Optional. If true, dismisses other toasts before showing this one. Overrides `dismissOtherOnShow`.
- **textAlign** (TextAlign): Optional. Text alignment for this toast.
- **animationBuilder** (OKToastAnimationBuilder): Optional. Custom animation builder for this toast.
- **animationDuration** (Duration): Optional. Animation duration for this toast.
- **animationCurve** (Curve): Optional. Animation curve for this toast.

### Request Example

```dart
showToast('This is a simple toast message');

showToast(
  'Another toast with custom duration and position',
  duration: Duration(seconds: 3),
  position: ToastPosition.bottom,
);
```

## Method `showToastWidget`

Displays a custom widget as a toast.

### Parameters

- **widget** (Widget): Required. The widget to display as the toast.
- **context** (BuildContext): Optional. The context to display the toast in.
- **duration** (Duration): Optional. How long the toast should be displayed.
- **position** (ToastPosition): Optional. The position of the toast.
- **onDismiss** (Function): Optional. Callback function executed when the toast is dismissed.
- **dismissOtherToast** (bool): Optional. If true, dismisses other toasts before showing this one.
- **textDirection** (TextDirection): Optional. Text direction for the toast.
- **handleTouch** (bool): Optional. If true, the toast can respond to touch events.
- **animationBuilder** (OKToastAnimationBuilder): Optional. Custom animation builder for this toast.
- **animationDuration** (Duration): Optional. Animation duration for this toast.
- **animationCurve** (Curve): Optional. Animation curve for this toast.

### Request Example

```dart
showToastWidget(Text('Hello, oktoast!'));

showToastWidget(
  Container(child: Icon(Icons.favorite)),
  duration: Duration(seconds: 2),
  position: ToastPosition.center,
);
```

## Method `dismissAllToast`

Dismisses all currently displayed toasts.

### Request Example

```dart
dismissAllToast();
```

## Return Value

Both `showToast` and `showToastWidget` return a `ToastFuture` object, which can be used to manually dismiss the toast.
```

--------------------------------

### Show a simple text toast

Source: https://pub.dev/packages/oktoast

Use the `showToast` method to display a basic text message as a toast. This method accepts the message string and has optional parameters for duration, position, and styling.

```dart
showToast('content');

```

--------------------------------

### Wrap app widget with OKToast

Source: https://pub.dev/packages/oktoast

Wrap your root application widget, typically MaterialApp, with OKToast to enable toast functionality throughout the app. This ensures toasts are displayed correctly and context is available.

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

```

--------------------------------

### Show a custom widget toast

Source: https://pub.dev/packages/oktoast

Utilize the `showToastWidget` method to display any custom Flutter widget as a toast. This provides maximum flexibility for toast content and appearance. Optional parameters for duration, position, and animation are available.

```dart
showToastWidget(Text('hello oktoast'));

```

--------------------------------

### Add oktoast Dependency to Flutter Project

Source: https://pub.dev/packages/oktoast/install

Run this command in your terminal to add the oktoast package to your Flutter project's dependencies. This command automatically updates your pubspec.yaml file.

```bash
$ flutter pub add oktoast
```

--------------------------------

### Import oktoast Package in Dart Code

Source: https://pub.dev/packages/oktoast/install

After adding the dependency, import the oktoast package into your Dart files using this import statement to access its functionalities.

```dart
import 'package:oktoast/oktoast.dart';
```

--------------------------------

### Dismiss all toasts

Source: https://pub.dev/packages/oktoast

Call the `dismissAllToast` method to programmatically dismiss all currently displayed toasts.

```dart
dismissAllToast();

```
Tokens:
Raw