Skip to content

Latest commit

 

History

History
223 lines (152 loc) · 6.48 KB

README.md

File metadata and controls

223 lines (152 loc) · 6.48 KB
Raw

ASUKA - Snackbars, Dialogs and more, the simple way.


Logo

A Simple and Clean approach to Snackbars, Dialogs, ModalSheets and more in a single provider.
Explore the docs »

· Report Bug · Request Feature


Version Pub Points Flutterando Analysis

Pub Publisher


Table of Contents
  1. About The Project
  2. Sponsors
  3. Getting Started
  4. How to Use
  5. Features
  6. Contributing
  7. Contact
  8. Acknowledgements

About The Project


Asuka package working gif


Asuka is a Dart package that aims to simplify and keep a clean approach when implementing some visual elements from Flutter like Snackbars, Dialogs and ModalSheets. With few and intuitive lines of code you can have those in your project without the hassle of having to code them from scratch, while having the option of quickly removing them if need be.

This project is distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Sponsors

Logo

(back to top)


Getting Started

To get Asuka in your project follow either of the instructions below:

a) Add Asuka as a dependency in your Pubspec.yaml:

dependencies:
  asuka: any

b) Use Dart Pub:

  dart pub add asuka

How to Use

Add the following code where you call your Material App:

import 'package:asuka/asuka.dart';

MaterialApp(
    builder: Asuka.builder,
    navigatorObservers: [
       Asuka.asukaHeroController //This line is needed for the Hero widget to work
    ],
);

Now you just have to call the named constructors for each widget that you want to use:

import 'package:asuka/asuka.dart';

Asuka.showSnackBar(SnackBar(
    content: Text("Hello World"),
));

AsukaSnackbar.success("success").show();

For more examples, please refer to the Documentation

(back to top)

Features

  • ✅ Snackbars
  • ✅ Dialog
  • ✅ BottomSheet
  • ✅ ModalBottomSheet
  • ✅ CupertinoModalPopup
  • ✅ CupertinoDialog
  • ✅ CupertinoDialogListener
  • ✅ Overlay

Right now this package has concluded all his intended features. If you have any suggestions or find something to report, see below how to contribute to it.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the appropriate tag. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Remember to include a tag, and to follow Conventional Commits and Semantic Versioning when uploading your commit and/or creating the issue.

(back to top)

Contact

Flutterando Community

(back to top)

Acknowledgements

Thank you to all the people who contributed to this project, without you, this project would not be here today.

(back to top)

Maintaned by


Built and maintained by Flutterando.