Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blaugold/fleet

An animation Framework for Flutter. It is state-based, declarative, extensible, composable and easy to use.
https://github.com/blaugold/fleet

animation dart declarative flutter mobile state-based ui

Last synced: 21 days ago
JSON representation

An animation Framework for Flutter. It is state-based, declarative, extensible, composable and easy to use.

Host: GitHub
URL: https://github.com/blaugold/fleet
Owner: blaugold
License: mit
Created: 2022-08-29T09:15:31.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-12-05T14:28:44.000Z (11 months ago)
Last Synced: 2024-10-03T07:21:48.724Z (about 1 month ago)
Topics: animation, dart, declarative, flutter, mobile, state-based, ui
Language: Dart
Homepage: https://pub.dev/packages/fleet
Size: 438 KB
Stars: 24
Watchers: 3
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        [![CI](https://github.com/blaugold/fleet/actions/workflows/CI.yaml/badge.svg)](https://github.com/blaugold/fleet/actions/workflows/CI.yaml)

[![pub.dev](https://img.shields.io/pub/v/fleet)](https://pub.dev/packages/fleet)

> ⚠️ This package is in an early state of development. If you find any bugs or

> have any suggestions, please open an [issue][issues].

**Fleet** is an animation framework for Flutter.

- [**State-based**][animated]: Animate transitions from one state to another.

- [**Declarative**][animationspec]: Describe an animation and apply it to a

  state change. No need to manage `AnimationController`s or `Tween`s.

- **Animatable widgets**: Comes out of the box with general purpose widgets that

  support animating with Fleet.

  - **Extensible**: Any widget can be made to support animating with Fleet.

  - **Flexible**: Animatable widgets can be used with or without animations.

  - **Composable**: Widgets that build on animatable widgets are automatically

    animatable.

  - **Animate parameters individually**: Animate parameters of animatable widget

    individually, e.g. with different curves.

- **User-friendly**: Add and change animations with little refactoring.

# Getting started

Add Fleet to your `pubspec.yaml`:

```shell

flutter pub add fleet

```

Now you're ready to use Fleet in your Flutter app.

Take a look a the [examples][example_app] or continue to the introduction to

Fleet.

# Introduction

Fleet has been heavily inspired by the animation framework that comes with

[SwiftUI][swiftui animation framework]. If you are familiar with it, you will

find most concepts familiar.

I'm going to walk you through adding a simple animation to a widget. Below is

the unanimated version of the widget:

```dart

import 'package:fleet/fleet.dart';

import 'package:flutter/material.dart';

class MyWidget extends StatefulWidget {

  const MyWidget({super.key});

  @override

  State createState() => _MyWidgetState();

}

class _MyWidgetState extends State {

  var _active = false;

  @override

  Widget build(BuildContext context) {

    return GestureDetector(

      onTap: () {

        setState(() {

          _active = !_active;

        });

      },

      child: ColoredBox(

        color: _active ? Colors.blue : Colors.grey,

      ),

    );

  }

}

```

Now lets animate the state change of `_active`:

```diff

-class _MyWidgetState extends State {

+class _MyWidgetState extends State with AnimatingStateMixin {

   var _active = false;

   @override

   Widget build(BuildContext context) {

     return GestureDetector(

       onTap: () {

-        setState(() {

+        setStateWithAnimation(Curves.ease.animation(250.ms), () {

           _active = !_active;

         });

       },

-      child: ColoredBox(

+      child: FleetColoredBox(

         color: _active ? Colors.blue : Colors.grey,

       ),

     );

   }

 }

```

We made the following changes:

1. Mixin `AnimatingStateMixin` to `_MyWidgetState`, so we can use

   `setStateWithAnimation`.

2. Use `setStateWithAnimation` to specify the animation that we want to apply to

   the state change.

3. Use `FleetColoredBox` instead of `ColoredBox`.

The `FleetColoredBox` widget is a drop-in replacement for `ColoredBox` that

supports animating with Fleet. Widgets that support animating with Fleet don't

have any special parameters related to animation and can be used without

animation, just as well.

Fleet provides drop-in replacements for a number of generally useful Flutter

framework widgets (all with the prefix `A`). Any widget can be made to support

state-based animation through components provided by Fleet (see

[`AnimatableStatelessWidget`][AnimatableStatelessWidget]). Issues or PRs for

adding support for more widgets are welcome!

Note that we did not explicitly tell `setStateWithAnimation` what to animate.

This is because Fleet uses a **state-based** approach. All state changes caused

by executing the provided callback will be animated. Even the state changes

which are indirect, like the `color` parameter of `FleetColoredBox` going from

`Colors.grey` to `Colors.blue`. Fleet does this by tracking the state of

animatable parameters of animatable widgets from one build to the next.

`Curves.ease.animation(250.ms)` creates an [`AnimationSpec`][animationspec] that

we pass to `setStateWithAnimation` to specify how to animate from the old to the

new state.

`.animate` is an extension method on `Curve` that creates an

[`AnimationSpec`][animationspec] form the curve. It optionally takes a

`Duration`. For a nicer syntax for specifying `Duration`s, Fleet provides

extensions on `int`, e.g `250.ms` is equivalent to

`Duration(milliseconds: 250)`.

# Animatable widgets

The following drop-in replacements for Flutter framework widgets are provided

for animating with Fleet:

- FleetAlign

- FleetAspectRatio

- FleetCenter

- FleetColoredBox

- FleetColumn

- FleetConstrainedBox

- FleetContainer

- FleetDecoratedBox

- FleetFittedBox

- FleetFlex

- FractionalTranslation

- FleetFractionallySizedBox

- FleetLimitedBox

- FleetOpacity

- FleetOverflowBox

- FleetPadding

- FleetPositioned

- FleetPositionedDirectional

- FleetRow

- FleetSizedBox

- FleetSizedOverflowBox

- FleetSliverOpacity

- FleetSliverPadding

- FleetTransform

See the [fleet_imports] package for an way to start using these widgets with

minimal changes to your code.

The following provided widgets are specific to Fleet:

- UniformPadding

---

**Gabriel Terwesten** &bullet; **GitHub**

**[@blaugold](https://github.com/blaugold)** &bullet; **Twitter**

**[@GTerwesten](https://twitter.com/GTerwesten)** &bullet; **Medium**

**[@gabriel.terwesten](https://medium.com/@gabriel.terwesten)**

[issues]: https://github.com/blaugold/fleet/issues

[swiftui animation framework]:

  https://developer.apple.com/documentation/swiftui/animations

[example_app]:

  https://github.com/blaugold/fleet/tree/main/packages/fleet/example

[withanimationasync]:

  https://pub.dev/documentation/fleet/latest/fleet/withAnimationAsync.html

[setstatewithanimation]:

  https://pub.dev/documentation/fleet/latest/fleet/AnimatingStateMixin/setStateWithAnimation.html

[AnimatableStatelessWidget]:

  https://pub.dev/documentation/fleet/latest/fleet/AnimatableStatelessWidget-class.html

[animationspec]:

  https://pub.dev/documentation/fleet/latest/fleet/AnimationSpec-class.html

[animated]: https://pub.dev/documentation/fleet/latest/fleet/Animated-class.html

[fleet_imports]: https://pub.dev/packages/fleet_imports