awesome_toast

A beautiful, customizable toast notification system for Flutter with automatic stacking, smooth animations, and full navigation persistence.

Features

  • Customizable: Easily customize the look and feel of your toasts.
  • Stacking: Toasts automatically stack to avoid cluttering the UI.
  • Animations: Smooth animations for a great user experience.
  • Navigation Persistence: Toasts persist across navigation events.
  • Easy to Use: Simple API for showing toasts.

Getting Started

To use this package, add awesome_toast as a dependency in your pubspec.yaml file.

dependencies:
  awesome_toast: ^1.0.0

Then, wrap your MaterialApp with a ToastProvider:

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

void main() {
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return ToastProvider(
      child: MaterialApp(
        title: 'Awesome Toast Demo',
        home: DemoScreen(),
      ),
    );
  }
}

Now you can show toasts from anywhere in your app:

ToastService.instance.success('Success', 'This is a success toast.');

Configuration

You can customize the default behavior and appearance of toasts by providing a ToastStackConfig to the ToastProvider.

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

  @override
  Widget build(BuildContext context) {
    return ToastProvider(
      config: ToastStackConfig(
        position: ToastPosition.topCenter,
        stackThreshold: 3,
        width: null,
        defaultDuration: Duration(seconds: 5),
        showProgressByDefault: false,
        curve: Curves.easeInOutQuart,
        maxWidth: 340,
        titleTextStyle: const TextStyle(
            fontSize: 18, fontWeight: FontWeight.bold, color: Colors.black),
        messageStyle: const TextStyle(fontSize: 14, color: Colors.black),
        actionLabelStyle: const TextStyle(
            fontSize: 14, fontWeight: FontWeight.bold, color: Colors.blue),
        progressColor: Colors.blue,
        progressBackgroundColor: Colors.grey,
        progressStrokeWidth: 2,
      ),
      child: MaterialApp(
        title: 'Awesome Toast Demo',
        home: DemoScreen(),
      ),
    );
  }
}

Contributing

Contributions are welcome! Please feel free to submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Libraries

awesome_toast