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, ...);
...
listKey.currentState.insert(123);

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

Inheritance
Mixed in types

Constructors

AnimatedListState()

Properties

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

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didUpdateWidget(covariant AnimatedList oldWidget) → void
Called whenever the widget configuration changes.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
initState() → void
Called when this object is inserted into the tree.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
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.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
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">@protectedinherited
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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