GetAnimatedBuilder<T> class

A widget that animates a tween value over a duration after a specified delay.

Implements animation lifecycle hooks such as onStart and onComplete.

The animation plays once, when the widget is first inserted into the tree. Rebuilding the widget with a different duration, tween, or curve updates the animation configuration but does not replay it. To replay the animation, either provide a new Key (recreating the state), enable autoPlayOnUpdate, or keep the AnimationController received in onStart/onComplete and call controller.forward(from: 0).

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• GetAnimatedBuilder

Implementers

• BlurAnimation
• BounceAnimation
• ColorAnimation
• FlipAnimation
• OpacityAnimation
• RotateAnimation
• ScaleAnimation
• SizeAnimation
• SlideAnimation
• SpinAnimation
• WaveAnimation
• WobbleAnimation

Available extensions

• AnimationExtension

Constructors

GetAnimatedBuilder({Key? key, Curve curve = Curves.linear, ValueSetter<AnimationController>? onComplete, ValueSetter<AnimationController>? onStart, required Duration duration, required Tween<T> tween, required T idleValue, required ValueWidgetBuilder<T> builder, required Widget child, required Duration delay, bool autoPlayOnUpdate = false})

Creates a GetAnimatedBuilder with the given parameters.

const

Properties

autoPlayOnUpdate → bool

Whether to replay the animation from the beginning when the widget is rebuilt with a different tween.

final

builder → ValueWidgetBuilder<T>

The builder function that builds a widget with the current animated value.

final

child → Widget

The child widget to be animated.

final

curve → Curve

The animation curve to apply to the transition.

final

delay → Duration

The delay duration before the animation starts playing.

final

duration → Duration

The duration of the animation transition itself.

final

hashCode → int

The hash code for this object.

no setter, inherited

idleValue → T

The idle or initial value of the animation before it starts playing.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onComplete → ValueSetter<AnimationController>?

A callback triggered when the animation completes.

final

onStart → ValueSetter<AnimationController>?

A callback triggered when the animation starts playing.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

totalDuration → Duration

Returns the total duration including both the animation duration and the delay.

no setter

tween → Tween<T>

The tween defining the start and end values for the animation.

final

Methods

blur({double begin = 0, double end = 15, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Blurs the widget from begin to end sigma factor.

bounce({required double begin, required double end, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Bounces the scale of the widget from begin to end.

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → GetAnimatedBuilderState<T>

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

fadeIn({Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Animates the widget's opacity from 0.0 to 1.0.

fadeOut({Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Animates the widget's opacity from 1.0 to 0.0.

flip({double begin = 0, double end = 1, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Flips the widget around the Y-axis from begin to end.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rotate({required double begin, required double end, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Rotates the widget from begin to end angle in radians.

scale({required double begin, required double end, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Scales the widget from begin to end factor.

size({required double begin, required double end, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Animates the widget's layout size/scale from begin to end.

slide({required OffsetBuilder offset, double begin = 0, double end = 1, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Translates/slides the widget dynamically using an offset builder.

spin({Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Spins the widget 360 degrees.

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

wave({double begin = 0, double end = 1, Duration duration = _defaultDuration, Duration delay = _defaultDelay, ValueSetter<AnimationController>? onComplete, bool isSequential = false, bool autoPlayOnUpdate = false}) → GetAnimatedBuilder

Available on Widget, provided by the AnimationExtension extension

Animates the widget with a translation wave on the Y-axis.

Operators

operator ==(Object other) → bool

The equality operator.

inherited