Lottie class

A widget to display a loaded LottieComposition. The controller property allows to specify a custom AnimationController that will drive the animation. If controller is null, the animation will play automatically and the behavior could be adjusted with the properties animate, repeat and reverse.

Inheritance

Constructors

Lottie({Key? key, required LottieComposition? composition, Animation<double>? controller, double? width, double? height, AlignmentGeometry? alignment, BoxFit? fit, bool? animate, FrameRate? frameRate, bool? repeat, bool? reverse, LottieDelegates? delegates, LottieOptions? options, bool? addRepaintBoundary, FilterQuality? filterQuality})
const

Properties

addRepaintBoundary bool
Indicate to automatically add a RepaintBoundary widget around the animation. This allows to optimize the app performance by isolating the animation in its own Layer.
final
alignment AlignmentGeometry?
How to align the composition within its bounds.
final
animate bool
If no controller is specified, this value indicate whether or not the Lottie animation should be played automatically (default to true). If there is an animation controller specified, this property has no effect.
final
composition LottieComposition?
The Lottie composition to animate. It could be parsed asynchronously with LottieComposition.fromBytes.
final
controller Animation<double>?
The animation controller to animate the Lottie animation. If null, a controller is automatically created by this class and is configured with the properties animate, reverse
final
delegates LottieDelegates?
A group of callbacks to further customize the lottie animation.
final
filterQuality FilterQuality?
The quality of the image layer. See FilterQuality FilterQuality.high is highest quality but slowest.
final
fit BoxFit?
How to inscribe the Lottie composition into the space allocated during layout.
final
frameRate FrameRate?
The number of frames per second to render. Use FrameRate.composition to use the original frame rate of the Lottie composition (default) Use FrameRate.max to advance the animation progression at every frame.
final
hashCode int
The hash code for this object.
no setterinherited
height double?
If non-null, require the composition to have this height.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
options LottieOptions?
Some options to enable/disable some feature of Lottie
final
repeat bool
Specify that the automatic animation should repeat in a loop (default to true). The property has no effect if animate is false or controller is not null.
final
reverse bool
Specify that the automatic animation should repeat in a loop in a "reverse" mode (go from start to end and then continuously from end to start). It default to false. The property has no effect if animate is false, repeat is false or controller is not null.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
width double?
If non-null, requires the composition to have this width.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<Lottie>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

cache LottieCache
The cache instance for recently loaded Lottie compositions.
no setter
traceEnabled bool
getter/setter pair

Static Methods

asset(String name, {Animation<double>? controller, bool? animate, FrameRate? frameRate, bool? repeat, bool? reverse, LottieDelegates? delegates, LottieOptions? options, void onLoaded(LottieComposition)?, LottieImageProviderFactory? imageProviderFactory, Key? key, AssetBundle? bundle, LottieFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder, double? width, double? height, BoxFit? fit, AlignmentGeometry? alignment, String? package, bool? addRepaintBoundary, FilterQuality? filterQuality, WarningCallback? onWarning}) LottieBuilder
Creates a widget that displays an LottieComposition obtained from an AssetBundle.
file(Object file, {Animation<double>? controller, FrameRate? frameRate, bool? animate, bool? repeat, bool? reverse, LottieDelegates? delegates, LottieOptions? options, LottieImageProviderFactory? imageProviderFactory, void onLoaded(LottieComposition)?, Key? key, LottieFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder, double? width, double? height, BoxFit? fit, AlignmentGeometry? alignment, bool? addRepaintBoundary, FilterQuality? filterQuality, WarningCallback? onWarning}) LottieBuilder
Creates a widget that displays an LottieComposition obtained from a File.
memory(Uint8List bytes, {Animation<double>? controller, FrameRate? frameRate, bool? animate, bool? repeat, bool? reverse, LottieDelegates? delegates, LottieOptions? options, LottieImageProviderFactory? imageProviderFactory, void onLoaded(LottieComposition)?, Key? key, LottieFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder, double? width, double? height, BoxFit? fit, AlignmentGeometry? alignment, bool? addRepaintBoundary, FilterQuality? filterQuality, WarningCallback? onWarning}) LottieBuilder
Creates a widget that displays an LottieComposition obtained from a Uint8List.
network(String url, {Animation<double>? controller, FrameRate? frameRate, bool? animate, bool? repeat, bool? reverse, LottieDelegates? delegates, LottieOptions? options, LottieImageProviderFactory? imageProviderFactory, void onLoaded(LottieComposition)?, Key? key, LottieFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder, double? width, double? height, BoxFit? fit, AlignmentGeometry? alignment, bool? addRepaintBoundary, FilterQuality? filterQuality, WarningCallback? onWarning}) LottieBuilder
Creates a widget that displays an LottieComposition obtained from the network.