Getting Started

Installation

To use Newton, simply add it as a dependency in your pubspec.yaml file:

dependencies:
  newton_particles: ^0.2.2

Then, run flutter pub get to fetch the package.

Usage

1. Import the Newton package:

import 'package:newton_particles/newton_particles.dart';

2. Create a Newton widget and add it to your Flutter UI with the desired effects:

Newton(
    // Add any kind of effects to your UI
    // For example:
    activeEffects: [
        RelativisticEffectConfiguration(
            gravity: Gravity.earthGravity,
            maxAngle: 90,
            maxEndScale: 1,
            maxFadeOutThreshold: .8,
            maxOriginOffset: const Offset(1, 0),
            maxParticleLifespan: const Duration(seconds: 10),
            maxVelocity: Velocity.stationary,
            minAngle: 90,
            minParticleLifespan: const Duration(seconds: 7),
            minEndScale: 1,
            minFadeOutThreshold: .6,
            minVelocity: Velocity.stationary,
            origin: Offset.zero,
            particleConfiguration: const ParticleConfiguration(
                shape: CircleShape(),
                size: Size(5, 5),
            ),
        )
    ],
)

Try our effect configurator to tweak your effect.

Example

For a quick start, here's an example of creating a simple rain effect using Newton:

import 'package:flutter/material.dart';
import 'package:newton_particles/newton_particles.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Newton Rain Example')),
        body: Newton(
          activeEffects: [
            RelativisticEffectConfiguration(
                gravity: Gravity.earthGravity,
                maxAngle: 90,
                maxEndScale: 1,
                maxFadeOutThreshold: .8,
                maxOriginOffset: const Offset(1, 0),
                maxParticleLifespan: const Duration(seconds: 10),
                maxVelocity: Velocity.stationary,
                minAngle: 90,
                minParticleLifespan: const Duration(seconds: 7),
                minEndScale: 1,
                minFadeOutThreshold: .6,
                minVelocity: Velocity.stationary,
                origin: Offset.zero,
                particleConfiguration: const ParticleConfiguration(
                  shape: CircleShape(),
                  size: Size(5, 5),
                ),
            ),
          ],
        ),
      ),
    );
  }
}