WidgetAnimator class

Widget animator is a class you can wrap around any Widget to enable a collection of different animations effects to it, they are broken down into three categories

  • Incoming transitions - for when the widget is first rendered onto the screen
  • At rest animations - which will show once the incoming transition is complete while the widget is active
  • Outgoing transitions - for when a change is detected (either by the Key of the child changing or by the widget type changing) the widget will only change once the outgoing transition has completed All transitions (incoming/at rest/outgoing) are optional
Inheritance

Constructors

WidgetAnimator({Key? key, WidgetTransitionEffects? incomingEffect, WidgetTransitionEffects? outgoingEffect, WidgetRestingEffects? atRestEffect, Widget? child, dynamic onIncomingAnimationComplete(Key?)?, dynamic onOutgoingAnimationComplete(Key?)?})
Constructor for the WidgetAnimator
const

Properties

atRestEffect WidgetRestingEffects?
WidgetTransitionEffects to show when a widget is displayed any not transitioning in or out
final
child Widget?
Widget the child widget to render that requires animating
final
hashCode int
The hash code for this object.
no setterinherited
incomingEffect WidgetTransitionEffects?
WidgetTransitionEffects to show when a widget is first rendered
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onIncomingAnimationComplete → (dynamic Function(Key?)?)
Function callback to call once the incoming animation has completed
final
onOutgoingAnimationComplete → (dynamic Function(Key?)?)
Function callback to call once the outgoing animation has completed
final
outgoingEffect WidgetTransitionEffects?
WidgetTransitionEffects to show when a widget is being replaced
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<WidgetAnimator>
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}) 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