AnimatedListState class Null safety

The state for a scrolling container that animates items when they are inserted or removed.

When an item is inserted with insertItem an animation begins running. The animation is passed to AnimatedList.itemBuilder whenever the item's widget is needed.

When an item is removed with removeItem its animation is reversed. The removed item's animation is passed to the removeItem builder parameter.

An app that needs to insert or remove items in response to an event can refer to the AnimatedList's state with a global key:

GlobalKey<AnimatedListState> listKey = GlobalKey<AnimatedListState>();
AnimatedList(key: listKey, ...);

AnimatedList item input handlers can also refer to their AnimatedListState with the static AnimatedList.of method.

Mixed in types




context BuildContext
The location in the tree where this widget builds.
read-only, inherited
hashCode int
The hash code for this object.
read-only, inherited
mounted bool
Whether this State object is currently in a tree.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
widget AnimatedList
The current configuration.
read-only, inherited


activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
deactivate() → void
Called when this object is removed from the tree.
@mustCallSuper, @protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didChangeDependencies() → void
Called when a dependency of this State object changes.
@mustCallSuper, @protected, inherited
didUpdateWidget(covariant AnimatedList oldWidget) → void
Called whenever the widget configuration changes.
@mustCallSuper, @protected, inherited
dispose() → void
Called when this object is removed from the tree permanently.
initState() → void
Called when this object is inserted into the tree.
@mustCallSuper, @protected, inherited
insertItem(int index, {Duration duration = _kDuration}) → void
Insert an item at index and start an animation that will be passed to AnimatedList.itemBuilder when the item is visible.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
@mustCallSuper, @protected, inherited
removeItem(int index, AnimatedListRemovedItemBuilder builder, {Duration duration = _kDuration}) → void
Remove the item at index and start an animation that will be passed to builder when the item is visible.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
@protected, inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.


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