LocalHero class

Mark its child as a candidate for local hero animation.

When the position of this widget (from the perspective of Flutter) changes, an animation is started from the previous position to the new one.

You'll have to use a Key in the top most parent in your container in order to explicitly tell the framework to preserve the state of your children.

Inheritance

Constructors

LocalHero({Key? key, required Object tag, LocalHeroFlightShuttleBuilder? flightShuttleBuilder, bool enabled = true, required Widget child})
Creates a LocalHero.
const

Properties

child Widget
The widget below this widget in the tree.
final
enabled bool
Whether the hero animation should be enabled.
final
flightShuttleBuilder LocalHeroFlightShuttleBuilder?
Optional override to supply a widget that's shown during the local hero's flight.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tag Object
The identifier for this particular local hero. This tag must be unique under the same LocalHeroScope. If between two frames, the position of a LocalHero with the same tag changes, a local hero animation will be triggered.
final

Methods

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