Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/packruble/weather_animation
The package contains beautiful weather animations. Easy setup with the weather configurator!
https://github.com/packruble/weather_animation
animation dart flutter weather
Last synced: about 10 hours ago
JSON representation
The package contains beautiful weather animations. Easy setup with the weather configurator!
- Host: GitHub
- URL: https://github.com/packruble/weather_animation
- Owner: PackRuble
- License: apache-2.0
- Created: 2022-11-23T07:51:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-29T16:27:22.000Z (9 days ago)
- Last Synced: 2025-01-29T17:26:48.515Z (9 days ago)
- Topics: animation, dart, flutter, weather
- Language: Dart
- Homepage: https://pub.dev/packages/weather_animation
- Size: 14 MB
- Stars: 23
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
[![telegram_badge]][telegram_link]
[![pub_badge]][pub_link]
[![configurator_badge]][configurator_link]
[![repo_star_badge]][repo_star_link]
[![license_badge]][license_link]
[![code_size_badge]][repo_link]
## 🌇 weather_animation
Create weather scenes and animate as your heart desires. Simple and free.
Try the [Weathunits configurator][configurator_link] for setting weather scenes directly in the WEB!
> Put a ![][pub_like_icon] on [Pub][pub_link] and favorite ⭐ on [Github][repo_link] to keep up with changes and not miss new releases!
## Motivation
- 🎨 colorful weather scenes without using gif/png and stuff source
- 🆓 free license for use in your projects (including commercial ones)
- 🎛 easy creation of scenes and easy customization when needed
- 🌅 configurator for easy creation of weather scenes
- 😅 enjoy yourself and you with another fun package
## Table of Contents
* [🌇 weather_animation](#-weather_animation)
* [Motivation](#motivation)
* [Table of Contents](#table-of-contents)
* [How to use simply?](#how-to-use-simply)
* [Use `WeatherScene`](#use-weatherscene)
* [Use `WrapperScene`](#use-wrapperscene)
* [Use `weather_configurator` app](#use-weather_configurator-app)
* [Library structure](#library-structure)
* [Configuration files `...Config`](#configuration-files-config)
* [About `WrapperScene`](#about-wrapperscene)
* [About `BackgroundWidget`](#about-backgroundwidget)
* [Author](#author)
* [Additional information](#additional-information)
## How to use simply?
Import the library:
```dart
import 'package:weather_animation/weather_animation.dart';
```
### Use `WeatherScene`
Check the provided list of ready-made weather scenes in the `WeatherScene` enumeration and select
the desired one through the getter:
```dart
@override
Widget build(BuildContext context) {
return WeatherScene.sunset.sceneWidget;
}
```
or for more customization, use `WrapperScene.weather`:
```dart
@override
Widget build(BuildContext context) {
return WrapperScene.weather(scene: WeatherScene.sunset);
}
```
### Use `WrapperScene`
Specify a list of weather widgets and a list of colors to create a beautiful background gradient:
```dart
@override
Widget build(BuildContext context) {
return const WrapperScene(
colors: [
Color(0xff283593),
Color(0xffff8a65),
],
children: [
SunWidget(),
CloudWidget(),
WindWidget(),
],
);
}
```
If necessary, specify a configuration file to fine-tune the weather widget:
```dart
// ...
SunWidget(
sunConfig: SunConfig(
width: 262.0,
blurSigma: 10.0,
blurStyle: BlurStyle.solid,
isLeftLocation: true,
coreColor: Color(0xffffa726),
midColor: Color(0xd6ffee58),
outColor: Color(0xffff9800),
animMidMill: 2000,
animOutMill: 1800,
),
),
// ...
```
### Use `weather_configurator` app
- online in web --> [Weathunits configurator][configurator_link]
- offline after build project on your gadget (path `example/weathunits_configurator`. Learn more [here](https://github.com/PackRuble/weather_animation/tree/master/example/weathunits_configurator/))
## Library structure
The only point of using the library is to import the following file:
```dart
import 'package:weather_animation/weather_animation.dart';
```
The following weather widgets are available:
| Widget weather | A configuration class |
|--------------------------------------------|-----------------------|
| `CloudWidget` | `CloudConfig` |
| `RainWidget`
`RainDropWidget`* | `RainConfig` |
| `SnowWidget`
`SnowflakeWidget`* | `SnowConfig` |
| `SunWidget` | `SunConfig` |
| `ThunderWidget`
`SingleThunderWidget`* | `ThunderConfig` |
| `WindWidget` | `WindConfig` |
💡**Tip**: Widgets under `*` represent a single weather item. Use these when another `Stack` setting is required.
Each weather widget accepts an optional configuration parameter to fine-tune the widget.
### Configuration files `...Config`
- have correctly `toString`, `operator ==`, `hashCode`
- have a `copyWith` method to clone the object
- have de/serialization handling (`toJson` and `fromJson`). Note: not all fields
- are inherited from class `WeatherConfig`
### About `WrapperScene`
Also, there is a `WrapperScene` widget for quick scene adjustment, which allows you to scale the
weather scene relative to the specified canvas dimensions. Has a clipper and scene widget decoration.
### About `BackgroundWidget`
The `BackgroundWidget` class allows you to create a color background in the form of a linear gradient.
Specify the desired colors and you're done.
## Author
You can contact me or check out my activities on the following platforms:
- [Github](https://github.com/PackRuble)
- [Telegram](https://t.me/+AkGV73kZi_Q1YTMy)
- [StackOverflow](https://stackoverflow.com/users/17991131/ruble)
- [Medium](https://medium.com/@pack.ruble)
- [Habr](https://habr.com/ru/users/PackRuble)
## Additional information
Made with ❤️. Enjoy it!
---
🏷 tags: weather, animation, weather conditions, weather scenes
[pub_badge]: https://img.shields.io/pub/v/weather_animation.svg?style=plastic
[pub_link]: https://pub.dev/packages/weather_animation
[pub_like_icon]: https://pub.dev/static/hash-ffjootqp/img/like-active.svg
[license_badge]: https://img.shields.io/github/license/PackRuble/weather_animation?style=plastic
[license_link]: https://github.com/PackRuble/weather_animation/blob/master/LICENSE
[code_size_badge]: https://img.shields.io/github/languages/code-size/PackRuble/weather_animation?style=plastic
[repo_link]: https://github.com/PackRuble/weather_animation
[telegram_badge]: https://img.shields.io/badge/telegram-❤️-252850?style=plastic&logo=telegram
[telegram_link]: https://t.me/+AkGV73kZi_Q1YTMy
[repo_star_badge]: https://img.shields.io/github/stars/PackRuble/weather_animation?style=plastic
[repo_star_link]: https://github.com/PackRuble/weather_animation/network/dependents
[configurator_badge]: https://img.shields.io/badge/🎄playground-web_app-CB6586?style=plastic
[configurator_link]: https://packruble.github.io/weather_animation/