https://github.com/sososdk/flash

⚡️A highly customizable, powerful and easy-to-use alerting library for Flutter.
https://github.com/sososdk/flash

dialog flashbar flutter snackbar toast

Last synced: 2 days ago
JSON representation

⚡️A highly customizable, powerful and easy-to-use alerting library for Flutter.

• Host: GitHub
• URL: https://github.com/sososdk/flash
• Owner: sososdk
• License: apache-2.0
• Created: 2019-08-02T05:45:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T09:32:32.000Z (5 months ago)
• Last Synced: 2024-08-01T12:26:15.099Z (3 months ago)
• Topics: dialog, flashbar, flutter, snackbar, toast
• Language: Dart
• Homepage: https://sososdk.github.io/flash
• Size: 18.4 MB
• Stars: 467
• Watchers: 6
• Forks: 69
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flash

⚡️A highly customizable, powerful and easy-to-use alerting library for

Flutter.

Website: [https://sososdk.github.io/flash](https://sososdk.github.io/flash)

### Specs

[![pub](https://img.shields.io/pub/v/flash.svg?style=flat)](https://pub.dev/packages/flash)

This library allows you to show messages or alerts in your app **quickly

and easily**. It can be used as an alternative to `Snackbar` or `Toast`

or `Dialog` and offers a plethora of useful features and customization

options for you to play with.

It has been written **100% in Dart**. ❤️

![](./doc/images/banner.png)

# Table of Contents

* [Getting started](#getting-started)

* [Sample Project](#sample-project)

* [Usage](#usage)

* [Contribution](#contribution)

* [License](#license)

### Spread Some :heart:

[![GitHub followers](https://img.shields.io/github/followers/sososdk.svg?style=social&label=Follow)](https://github.com/sososdk)

# Getting started

In the `pubspec.yaml` of your flutter project, add the following dependency:

```yaml

dependencies:

  ...

  flash: ^3.1.0

```

In your library add the following import:

```dart

import 'package:flash/flash.dart';

```

# Sample Project

We have an exhaustive [sample project](./example) demonstrating almost

every feature of the library.

# Usage

It is recommended to check the sample project to get a complete

understanding of all the features offered by the library.

![basic](https://raw.githubusercontent.com/sososdk/tool/master/flash/basic.gif)

![top](https://raw.githubusercontent.com/sososdk/tool/master/flash/top.gif)

![bottom](https://raw.githubusercontent.com/sososdk/tool/master/flash/bottom.gif)

![toast](https://raw.githubusercontent.com/sososdk/tool/master/flash/toast.gif)

![dialog](https://raw.githubusercontent.com/sososdk/tool/master/flash/dialog.gif)

# Contribution

I highly encourage the community to step forward and improve this

library further. You can fix any reported bug, propose or implement new

features, write tests, etc.

Here is a quick list of things to remember

* Check the open issues before creating a new one,

* Help me in reducing the number of open issues by fixing any existing

  bugs,

* Check the roadmap to see if you can help in implementing any new

  feature,

* You can contribute by writing unit and integration tests for this

  library,

* If you have any new idea that aligns with the goal of this library,

  feel free to raise a feature request and discuss it.

# License

```

Copyright 2019 sososdk

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.