aurora_background 1.0.2
aurora_background: ^1.0.2 copied to clipboard
A beautiful and customizable aurora background effect for Flutter applications
Aurora Background #
A beautiful and highly customizable aurora background effect for Flutter applications. Create stunning animated backgrounds with aurora waves and a starry night sky.
🌟 Features #
- Smooth animated aurora waves
- Customizable colors and animations
- Interactive starfield background
- High performance and low memory footprint
- Highly customizable parameters
- Easy to implement
📱 Preview #
Default Aurora Effect #
Customized Aurora #
🚀 Getting Started #
Add this to your package's pubspec.yaml
file:
dependencies:
aurora_background: ^1.0.0
💻 Usage #
Basic Usage #
AuroraBackground(
child: YourWidget(),
)
Advanced Usage #
AuroraBackground(
numberOfWaves: 4,
backgroundColors: const [
Color(0xFF0B1026),
Color(0xFF1B2735),
Color(0xFF2C3E50),
],
waveDurations: const [6, 12, 18, 24],
waveColors: const [
[Color(0x558CE8FF), Color(0x558CE8FF), Color(0x558CE8FF)],
[Color(0x5587FF9B), Color(0x5587FF9B), Color(0x5587FF9B)],
[Color(0x55B987FF), Color(0x55B987FF), Color(0x55B987FF)],
],
waveHeightMultiplier: 0.2,
baseHeightMultiplier: 0.35,
waveBlur: 30,
starFieldConfig: StarFieldConfig(
starCount: 200,
maxStarSize: 2.0,
starColor: Colors.white.withOpacity(0.8),
seed: 123,
),
child: YourWidget(),
)
⚙️ Configuration Options #
AuroraBackground Properties #
Property | Type | Default | Description |
---|---|---|---|
child |
Widget |
required | The widget to display on top of the aurora background |
numberOfWaves |
int |
3 | Number of aurora waves |
backgroundColors |
List<Color> |
[see code] | Background gradient colors |
waveDurations |
List<int> |
[8, 16, 24] | Animation duration for each wave |
waveColors |
List<List<Color>> |
[see code] | Colors for each wave |
waveHeightMultiplier |
double |
0.15 | Controls wave height |
baseHeightMultiplier |
double |
0.4 | Controls base wave position |
waveBlur |
double |
40.0 | Blur intensity of waves |
StarFieldConfig Properties #
Property | Type | Default | Description |
---|---|---|---|
starCount |
int |
100 | Number of stars |
maxStarSize |
double |
1.5 | Maximum star size |
starColor |
Color |
Colors.white | Color of stars |
seed |
int |
42 | Random seed for star positions |
🤝 Contributing #
Contributions are welcome! 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 tag "enhancement".
Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
📝 License #
Distributed under the MIT License. See LICENSE
for more information.