jaechon-yu / particles_flutter Goto Github PK

View Code? Open in Web Editor NEW

Easy way to add particles animation in Flutter project.

License: BSD 2-Clause "Simplified" License

C++ 6.40% Objective-C 0.05% Kotlin 0.17% Dart 81.21% Swift 3.29% Makefile 5.43% HTML 0.26% Batchfile 3.18%

particles_flutter's Introduction

Flutter Particles

Easy way to add particles animation in Flutter project.

Getting Started

Note: Make sure your Flutter environment is setup.

Installation

In the command terminal, run the following commands:

$ git clone https://github.com/rajajain08/particles_flutter.git

For Web

$ cd particles_flutter/particles_web/
$ flutter packages pub global run webdev serve

Checkout web here.

For Desktop(eg:macOs)

$ cd particles_flutter/particles_web/
$ flutter run -d macOS

For iOS and Android: Follow this readme.

How to use

You can use CircularParticle widget and change any of it's value according to your needs.

CircularParticle(
          key: UniqueKey(),
          awayRadius: 80,
          numberOfParticles: 200,
          speedOfParticles: 1,
          height: screenHeight,
          width: screenWidth,
          onTapAnimation: true,
          particleColor: Colors.white.withAlpha(150),
          awayAnimationDuration: Duration(milliseconds: 600),
          maxParticleSize: 8,
          isRandSize: true,
          isRandomColor: true,
          randColorList: [
            Colors.red.withAlpha(210),
            Colors.white.withAlpha(210),
            Colors.yellow.withAlpha(210),
            Colors.green.withAlpha(210)
          ],
          awayAnimationCurve: Curves.easeInOutBack,
          enableHover: true,
          hoverColor: Colors.white,
          hoverRadius: 90,
          connectDots: false, //not recommended
        ),

Contributions

Feel free to contribute to this project.

If you find a bug or want a feature, but don't know how to fix/implement it, please fill an issue.
If you fixed a bug or implemented a new feature, please send a pull request.

If you want to contact me, Please send me a short DM on Twitter.

Recommend Projects