SliverAnimatedListState class

The state for a sliver 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 SliverAnimatedList.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 SliverAnimatedList's state with a global key:

GlobalKey<SliverAnimatedListState> listKey = GlobalKey<SliverAnimatedListState>();
...
SliverAnimatedList(key: listKey, ...);
...
listKey.currentState.insert(123);

SliverAnimatedList item input handlers can also refer to their SliverAnimatedListState with the static SliverAnimatedList.of method.

Inheritance
Mixed in types

Constructors

SliverAnimatedListState()

Properties

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 SliverAnimatedList
The current configuration. [...]
read-only, inherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
override
dispose() → void
Called when this object is removed from the tree permanently. [...]
override
initState() → void
Called when this object is inserted into the tree. [...]
override
insertItem(int index, {Duration duration: _kDuration}) → void
Insert an item at index and start an animation that will be passed to SliverAnimatedList.itemBuilder when the item is visible. [...]
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. [...]
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback. [...]
inherited
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. [...]
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
inherited
didUpdateWidget(covariant SliverAnimatedList oldWidget) → void
Called whenever the widget configuration changes. [...]
@mustCallSuper, @protected, inherited
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, @protected, inherited
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.
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug}) String
Returns 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 ==(dynamic other) bool
The equality operator. [...]
inherited