sa_multi_tween 0.0.4

MultiTween (part of Simple Animations Framework) can animate multiple properties at once.

This project is part of the Simple Animations Framework

⚠ Note: This project is still in development. Don't use it in production for now.

MultiTween

MultiTween is a powerful Animateable that animates multiple properties at once. Typical use cases are

• Staggered animations by combining multiple tweens
• Multiple properties (i.e. color and width) are animated simultaneously

📝 Example

Note: This example uses supercharged package for syntactic sugar and simple_animations for using ControlledAnimation widget.

// Define properties as enum
enum AniProps { width, height }

// Specify MultiTween
final _tween = MultiTween<AniProps>()
  ..add(AniProps.width, Tween(begin: 0.0, end: 100.0), 1000.milliseconds)
  ..add(AniProps.width, Tween(begin: 100.0, end: 200.0), 500.milliseconds)
  ..add(AniProps.height, Tween(begin: 0.0, end: 200.0), 2500.milliseconds);

Use the created _tween in your builder() function:

ControlledAnimation<MultiTweenAnimatable<AniProps>>(
  tween: _tween,
  // Obtain total duration from MultiTween
  duration: _tween.duration,
  builder: (context, animation) {
    return Container(
      // Get animated width as double value
      width: animation.get<double>(AniProps.width),
      // Get animated height as double value
      height: animation.get<double>(AniProps.height),
      color: Colors.yellow,
    );
  },
),

Use the predefined enum for animation properties

You can also use the DefaultAnimationProperties enum that contains a varity of common used animation properties.

Example:

final _tween = MultiTween<DefaultAnimationProperties>()
  ..add(DefaultAnimationProperties.width, Tween(begin: 0.0, end: 100.0), 1000.milliseconds)

Use own durations

You can simply ignore the _tween.duration property and use your own Duration. MultiTween will automatically lengthen or shorten the tween animation.

Example:

ControlledAnimation<MultiTweenAnimatable<AniProps>>(
  tween: _tween,
  // Use own duration
  duration: Durations(seconds: 3),
  builder: (context, animation) {
    return Container(
      width: animation.get<double>(AniProps.width),
      height: animation.get<double>(AniProps.height),
      color: Colors.yellow,
    );
  },
),