https://github.com/boyan01/overlay_support

a flutter toast and notification library
https://github.com/boyan01/overlay_support

flutter flutter-package notifications overlay overlay-support toast

Last synced: 2 days ago
JSON representation

a flutter toast and notification library

• Host: GitHub
• URL: https://github.com/boyan01/overlay_support
• Owner: boyan01
• License: apache-2.0
• Created: 2019-01-16T12:42:34.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T01:39:02.000Z (over 1 year ago)
• Last Synced: 2025-01-13T07:05:23.961Z (9 days ago)
• Topics: flutter, flutter-package, notifications, overlay, overlay-support, toast
• Language: Dart
• Homepage:
• Size: 12.8 MB
• Stars: 386
• Watchers: 5
• Forks: 101
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# overlay_support

[![Pub](https://img.shields.io/pub/v/overlay_support.svg)](https://pub.dev/packages/overlay_support)

[![Pub](https://img.shields.io/pub/v/overlay_support.svg?include_prereleases)](https://pub.dev/packages/overlay_support)

[![CI](https://github.com/boyan01/overlay_support/workflows/CI/badge.svg)](https://github.com/boyan01/overlay_support/actions)

[![codecov](https://codecov.io/gh/boyan01/overlay_support/branch/master/graph/badge.svg)](https://codecov.io/gh/boyan01/overlay_support)

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/#/](https://boyan01.github.io/overlay_support/#/)

## How To Use

1. add dependencies into you project `pubspec.yaml` file

    ```yaml

    dependencies:

        overlay_support: latest_version

    ```

   * the latest version is [![Pub](https://img.shields.io/pub/v/overlay_support.svg)](https://pub.dev/packages/overlay_support)

   * For project without migrate to null safety, please use version `overlay_support: 1.0.5-hotfix1`

2. wrap your AppWidget with `OverlaySupport`

```dart #build()

  return OverlaySupport.global(child: MaterialApp());

```

3. show toast or simple notifications

```dart

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](./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.