AnimatedList class Null safety

A scrolling container that animates items when they are inserted or removed.

This widget's AnimatedListState can be used to dynamically insert or remove items. To refer to the AnimatedListState either provide a GlobalKey or use the static of method from an item's input callback.

This widget is similar to one created by ListView.builder.

This sample application uses an AnimatedList to create an effect when items are removed or added to the list.
To create a local project with this code sample, run:
flutter create --sample=widgets.AnimatedList.1 mysample

See also:

  • SliverAnimatedList, a sliver that animates items when they are inserted or removed from a list.


AnimatedList({Key? key, required AnimatedListItemBuilder itemBuilder, int initialItemCount = 0, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, Clip clipBehavior = Clip.hardEdge})
Creates a scrolling container that animates items when they are inserted or removed.


clipBehavior Clip
The content will be clipped (or not) according to this option.
controller ScrollController?
An object that can be used to control the position to which this scroll view is scrolled.
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
initialItemCount int
The number of items the list will start with.
itemBuilder AnimatedListItemBuilder
Called, as needed, to build list item widgets.
key Key?
Controls how one widget replaces another widget in the tree.
final, inherited
padding EdgeInsetsGeometry?
The amount of space by which to inset the children.
physics ScrollPhysics?
How the scroll view should respond to user input.
primary bool?
Whether this is the primary scroll view associated with the parent PrimaryScrollController.
reverse bool
Whether the scroll view scrolls in the reading direction.
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scrollDirection Axis
The axis along which the scroll view scrolls.
shrinkWrap bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
createState() AnimatedListState
Creates the mutable state for this widget at a given location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
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.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.


operator ==(Object other) bool
The equality operator.
@nonVirtual, inherited

Static Methods

maybeOf(BuildContext context) AnimatedListState?
The state from the closest instance of this class that encloses the given context.
of(BuildContext context) AnimatedListState
The state from the closest instance of this class that encloses the given context.