Flare-Flutter

Flutter runtime for Flare, depends on flare_dart.

Installation

Add flare_flutter as a dependency in your pubspec.yaml file. If you plan on writing a custom controller or want access to more of the guts of the library, you will want to also include flare_dart which is the base library responsible for loading, instancing, animating, and doing all the work that happens before rendering in flare_flutter. The examples include use cases for both scenarios.

Exporting for Flutter

Export from Flare with the "Export to Engine" menu. In the Engine dropdown, choose Flutter, and in the Format dropdown your favorite form of compression.

Adding Assets

Once you've exported your file, add the .flr file to your project's Flutter assets.

Example

Take a look at the provided example applications for how to use the FlutterActor widget with an exported Flutter character.

Usage

The easiest way to get started is by using the provided FlareActor widget. This is a stateless Flutter widget that allows for one Flare file with one active animation playing to be embedded in your Flutter App.

You can change the currently playing animation by changing the animation property's name.

You can also specify the mixSeconds to determine how long it takes for the animation to interpolate from the previous one. A value of 0 means that it will just pop to the new animation. A value of 0.5 will mean it takes half of a second to fully mix the new animation on top of the old one.

import 'package:flare_flutter/flare_actor.dart';
class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => new _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return new FlareActor("assets/Filip.flr", alignment:Alignment.center, fit:BoxFit.contain, animation:"idle");
  }
}

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

See the LICENSE file for license rights and limitations (MIT).

Libraries

aabb
actor
actor_animation
actor_artboard
actor_axis_constraint
actor_blur
actor_bone
actor_bone_base
actor_color
actor_component
actor_constraint
actor_distance_constraint
actor_drawable
actor_drop_shadow
actor_ellipse
actor_event
actor_flags
actor_ik_constraint
actor_image
actor_inner_shadow
actor_jelly_bone
actor_layer_effect
actor_layer_effect_renderer
actor_mask
actor_node
actor_node_solo
actor_path
actor_polygon
actor_rectangle
actor_root_bone
actor_rotation_constraint
actor_scale_constraint
actor_shadow
actor_shape
actor_skin
actor_skinnable
actor_star
actor_targeted_constraint
actor_transform_constraint
actor_translation_constraint
actor_triangle
asset_flare
asset_provider
binary_reader
block_reader
block_types
cache
cache_asset
cubic
cubic_ease
dependency_sorter
flare_actor
flare_cache
flare_cache_asset
flare_cache_builder
flare_controller
flare_controls
flare_flutter
flare_render_box
flare_testing
hold
interpolator
jelly_component
json_block_reader
json_reader
keyframe
linear
mat2d
memory_flare
path_point
property_types
stream_reader
transform_components
transform_space
trim_path
vec2d