/overlay_support

a flutter toast and notification library

Primary LanguageDartApache License 2.0Apache-2.0

overlay_support

Pub Pub CI codecov

Provider support for overlay, make it easy to build toast and In-App notification.

this library support ALL platform

Interaction

If you want to see the ui effect of this library, just click here https://boyan01.github.io/overlay_support/#/

How To Use

  1. add dependencies into you project pubspec.yaml file

    dependencies:
        overlay_support: latest_version
    • the latest version is Pub
    • For project without migrate to null safety, please use version overlay_support: 1.0.5-hotfix1
  2. wrap your AppWidget with OverlaySupport

  return OverlaySupport.global(child: MaterialApp());
  1. show toast or simple notifications
import 'package:overlay_support/overlay_support.dart';

void onClick() {
    // popup a toast.
    toast('Hello world!');

    // show a notification at top of screen.
    showSimpleNotification(
        Text("this is a message from simple notification"),
        background: Colors.green);
}

more instructions check here : example/README.md

License

see License File

End

if you have some suggestion or advice, please open an issue to let me known. This will greatly help the improvement of the usability of this project. Thanks.