atmospheric_particles 0.3.5

A lightweight and customizable Flutter package for creating beautiful particle animations and atmospheric effects in the background of any widget.

atmospheric_particles

A lightweight, highly customizable Flutter package for creating beautiful particle animations in the background of any widget.

Features

• Highly Customizable: Control particle color, size, count, and speed.
• Directional Control: Set minimum and maximum velocities for both horizontal and vertical axes.
• Directional Fade: Apply a fade effect from the top, bottom, left, or right.
• Lightweight: Simple and efficient, designed to wrap any widget without performance issues.
• Easy to Use: Get started immediately with beautiful default parameters.

Getting Started

1. Installation

Add the package to your pubspec.yaml file:

dependencies:
  atmospheric_particles: ^0.3.5

Or, run this command in your terminal:

flutter pub add atmospheric_particles

2. Import

Import the package into your Dart file:

import 'package:atmospheric_particles/atmospheric_particles.dart';

Usage

The AtmosphericParticles widget can be wrapped around any widget. It works best inside a SizedBox or Container to give it explicit dimensions.

Basic Example

This will create a particle field using the beautiful default parameters.

SizedBox(
  height: 200,
  width: double.infinity,
  child: AtmosphericParticles(
    child: Center(
      child: Text(
        'Hello Particles!',
        style: TextStyle(fontSize: 24, color: Colors.white),
      ),
    ),
  ),
)

Advanced Customization Example

You can customize nearly every aspect of the particle field.

// ... inside your build method
SizedBox(
  height: 100,
  width: double.infinity,
  child: AtmosphericParticles(
    particleColor: Colors.blue,
    particleRadius: 3,
    particleCount: 100,
    fadeDirection: FadeDirection.bottom,
    minVerticalVelocity: -30,
    maxVerticalVelocity: -10,
    minHorizontalVelocity: -30,
    maxHorizontalVelocity: -10,
    child: const Center(child: Text('Customized Particles')),
  ),
),

Widget Properties (API)

Property	Type	Description
child	Widget	The widget to display in front of the particle field.
fadeDirection	FadeDirection	The direction of the opacity gradient. Can be FadeDirection.top, bottom, left, right, or none. Defaults to FadeDirection.none.
particleColor	Color	The color of the particles. Defaults to Colors.purple with opacity.
particleCount	int	The total number of particles to render. Defaults to 200.
minParticleRadius	double	The minimum radius of each particle. Defaults to 2.
maxParticleRadius	double	The maximum radius of each particle. Defaults to 2.
minVerticalVelocity	double	The minimum upward speed. (Use negative values for upward motion). Defaults to -100.
maxVerticalVelocity	double	The maximum upward speed. (Use negative values for upward motion). Defaults to -20.
minHorizontalVelocity	double	The minimum horizontal speed. (Negative for left, positive for right). Defaults to 10.
maxHorizontalVelocity	double	The maximum horizontal speed. (Negative for left, positive for right). Defaults to 30.
particlesInFront	bool	Whether the particles should be rendered in front of the child widget. Defaults to false.
trailLength	int	The number of historical positions to store for each particle, creating a trail effect. Defaults to 0 (no trail).

Additional Information

Have Suggestions or Find a Bug?

If you have any suggestions or encounter a bug, we'd love to hear from you!

• Visit the GitHub Repository: For the source code, to see existing issues, or to learn more about the project: atmospheric_particles on GitHub
• Open an Issue on GitHub: This is the preferred method for tracking bugs and feature requests.
• Email me at [e-mail]

License

This package is licensed under the The 3-Clause BSD License.