Table of Contents #

• Features
• Demo Examples
• Getting Started
  • Installation
  • Basic Usage
• Configuration Properties
• Presets & Effects
• Emoji Groups
• Advanced Usage
• Performance
• Example App
• Contributing
• License

Features #

• 🌨️ Realistic snow fall animation
• 🎄 Support for custom emojis (snowflakes, Christmas-themed, etc.)
• ⚡ Smooth performance with multiple animation styles
• 🎮 Customizable controls for speed, density, and wind effects
• 🏔️ Optional snow accumulation at the bottom
• 🎯 Easy to implement with minimal setup
• 📱 Works on all Flutter platforms

Demo Examples #

'Default Snow'	'Christmas Magic'	'Winter Wonderland'

Getting Started #

Installation #

Add snow_fall_animation to your pubspec.yaml:

dependencies:
  snow_fall_animation: ^0.0.1+2

Or install via command line:

flutter pub add snow_fall_animation

Basic Usage #

import 'package:snow_fall_animation/snow_fall_animation.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Stack(
        children: [
          // Your background
          Container(
            decoration: BoxDecoration(
              gradient: LinearGradient(
                begin: Alignment.topCenter,
                end: Alignment.bottomCenter,
                colors: [
                  Colors.blue[900]!,
                  Colors.blue[700]!,
                ],
              ),
            ),
          ),

          // Snow fall animation
          SnowFallAnimation(
            config: SnowfallConfig(
              numberOfSnowflakes: 200,
              speed: 1.0,
              useEmoji: true,
              customEmojis: ['❄️', '❅', '❆'],
            ),
          ),

          // Your content
          YourContent(),
        ],
      ),
    );
  }
}

Configuration Properties #

SnowfallConfig Properties #

Presets & Effects #

Animation Effects #

Preset Configurations #

// Christmas Magic
SnowfallConfig
(
numberOfSnowflakes: 200,
speed: 1.0,
customEmojis: ['❄️', '🎅', '🎄', '🎁', '⭐'],
windForce: 0.5,
)

// Winter Wonderland
SnowfallConfig(
numberOfSnowflakes: 250,
speed: 1.2,
customEmojis: ['❄️', '⛄', '🦌', '✨', '⭐'],
windForce: 1.0,
)

// Cozy Christmas
SnowfallConfig(
numberOfSnowflakes: 120,
speed: 0.5,
customEmojis: ['❄️', '🕯️', '🧦', '🍪', '🥛'],
windForce:
0.2
,
)

Emoji Groups #

Available Emojis #

Advanced Usage #

Customization Bottom Sheet #

showCustomizationBottomSheet
(
context: context,
config: currentConfig,
onConfigChanged: (newConfig) {
setState(() {
config = newConfig;
});
},
);

Dynamic Configuration #

class _MyHomePageState extends State<MyHomePage> {
  late SnowfallConfig _config;

  @override
  void initState() {
    super.initState();
    _config = const SnowfallConfig(
      numberOfSnowflakes: 200,
      speed: 1.0,
      customEmojis: ['❄️', '🎅', '🎄'],
    );
  }

  void _updateConfig(SnowfallConfig newConfig) {
    setState(() {
      _config = newConfig;
    });
  }

// ... rest of the implementation
}

Performance #

Optimization Tips #

1. Keep numberOfSnowflakes between 100-300 for best performance
2. Disable unnecessary effects (enableRandomOpacity, enableSnowDrift) if not needed
3. Use basic shapes instead of emojis for better performance
4. Adjust cleanup cycle timing based on your needs

Platform-Specific Notes #

• Web: Keep number of snowflakes lower for better performance
• Mobile: Works well with default settings
• Desktop: Can handle higher numbers of snowflakes

Example App #

The plugin includes a complete example app. To run:

1. Clone the repository
2. Navigate to example directory:

cd example

3. Run the app:

flutter run

The example app demonstrates:

• Different preset configurations
• Custom emoji selection
• Animation controls
• Bottom sheet customization
• Preset switching

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

Development Setup #

1. Fork the repository
2. Clone your fork
3. Create a new branch
4. Make your changes
5. Submit a pull request

Visitors Count #