A package to create nice and smooth animations for flutter
A simple package to build beautiful and smooth animations for flutter framework. By using this package, you don't need
to bother yourself with
AnimationTweens and also timing and of those animations.
Here there are some simple examples of what I've made with this package in 5 minutes for each one.
The following descriptions may sounds complicated but it's pretty simple, sorry for my bad english, I think if you jump to example directory and take a look at the codes, you'll find out it's really easy to use
Each object on the screen is called an
ActorWidget has two required properties:
@required String name; @required List<ActorAction> actions;
ActorAction is an individual animation of the
ActorWidgets in your page run simultaneously.
ActorActions inside of an
ActorWidget run sequentially, but you can control how much it waits before starts the animation
// ___________________________________ ActorWidget( | name: 'Actor1', | actions: [ | // ___________ | ActorAction( | | ... | | ), | | ActorAction( | | ... | (Sequentially) | (Simultaneously) ), | | ActorAction( | | ... | | ) | | // ___________| | ]), | ActorWidget(), | ActorWidget(), | ActorWidget(), | // ___________________________________|
ActorAction Features #
ActorAction has following features
List<String> group; // you can define one or multi group for action. Function onCompleted; Function onStart; Duration waitBeforeStart; // the amount of time the current action must wait to start, after the previous action is finished ActorPath path; ActorPosition position; ActorOpacity opacity; ActorCharacter character; ActorRotation rotation; ActorScale scale;
if you want to animate some of your
ActorWidgets, you can give a name to the actions of your actor. then start your
AnimationDirector by that group.
Using this, only
ActorWidgets which has the given
This is useful when you want to trigger an animation manually. see Example Menu3x3.
The actor character! your actor is represented by
ActorCharacter has the following properties:
Duration duration; Curve curve; double width; double height; Widget child; String clipPath; // the string of the clip path EdgeInsets padding; EdgeInsets margin; BoxDecoration decoration; BoxDecoration foregroundDecoration;
clipPath type is string! if follows svg codes rule. and for now only supports
In order to generate a path you can use FlutterDev.site Path Creator.
Draw your path and copy
The Result to the
You can animate the position of
ActorPosition has the following properties
Duration duration; Curve curve; double top; double left; double right; double bottom;
To change the opacity of your
ActorOpacity has the following properties
Duration duration; Curve curve; double opacity;
To change the scale of your
ActorScale has the following properties
Duration duration; Curve curve; double startScale; double finishScale;
To rotate, flip horizontal or vertical your
Actor widget, you can use
ActorRotation has the following properties
Duration duration; Curve curve; double rotationTurns; Alignment alignment; bool clockwise; double startTween; double verticalFlipTurns; double horizontalFlipTurns;
You can draw a path by using
ActorPath. and if you define an
ActorCharacter along with
ActorPath, the character will
move along the created path.
To draw your path again use FlutterDev.site Path Creator.
ActorPath has the following properties
Duration duration; Curve curve; String path; // the String code of the path int traversePercentage; // the percentage of `ActorCharacter` movement along the path int startPositionInPercent; // the start position of animation in percent bool displayPath; // displays the path on the screen, bool displayProgress; // displays the progress of path filling on the screen Offset offset; // you can align the position of ActorCharacter widget on the path Paint pathStyle; // style of the path line Paint progressStyle; // style of the progress line int progressLength; // the length of progress line, the default is as equal as the path int progressAnimationRepeat; // the repeat times of progress animation bool fadingProgress; // to make the tail of the progress line faded
Path Creator #
In order to create paths easily head to FlutterDev.site Path Creator.
Draw your path and copy the generated code from
Adaptive Size #
By default, the generated path is based on fixed numbers of your path and has the following effect
If you want to draw your path to be adaptive to the screen of any device, you need to select
Adaptive Height or both if you want your path to be fully adaptive.
When you select for example
Adaptive Width, the drawing-area width will be considered as mobile,tablet,... width so you get following
Adaptive Width. (500 for example)
But keep in mind, in both cases, the result may be different on different screen-sizes.
Let's say we want to animate an orange circle from top-center of the screen to the center. Then after 2 seconds, move the circle to the bottom of the page.
The first step is to create our character and position it to top of the page.
ActorAction( position: ActorPosition(top: 0, left: 0, right: 0), character: ActorCharacter( child: Center( child: Container( width: 50, height: 50, decoration: BoxDecoration( color: Colors.orangeAccent, borderRadius: BorderRadius.circular(50), ), ), ) ), ),
The second step is to move it to the center of the page, so let's add another
... ActorAction( position: ActorPosition( curve: Curves.elasticOut, duration: Duration(milliseconds: 800), top: MediaQuery.of(context).size.height / 2 - 25), ), ...
And the final step is to move our circle to the bottom of the page after 2 seconds
... ActorAction( waitBeforeStart: Duration(seconds: 2), position: ActorPosition( duration: Duration(milliseconds: 800), curve: Curves.elasticOut, top: MediaQuery.of(context).size.height - 100), ), ...
and you get the following result
[0.0.1] - 03/15/2020 #
- package uploaded
[0.1.0] - 03/16/2020 #
- some necessary updates
[0.1.1] - 03/16/2020 #
- some optional updates !
- added 1 more example
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: animation_director: ^0.1.1
2. Install it
You can install packages from the command line:
$ flutter pub get
Alternatively, your editor might support
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.7.1
- pana: 0.13.6
- Flutter: 1.12.13+hotfix.8
Maintain an example.
None of the files in the package's
example/ directory matches known example patterns.
Common filename patterns include
animation_director.dart. Packages with multiple examples should provide
For more information see the pub package layout conventions.