AnimatedList class

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.

{@tool dartpad} This sample application uses an AnimatedList to create an effect when items are removed or added to the list.

** See code in examples/api/lib/widgets/animated_list/animated_list.0.dart ** {@end-tool}

See also:

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

Constructors

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

Properties

clipBehavior → Clip
The content will be clipped (or not) according to this option.
final
hashCode → int
The hash code for this object.
no setterinherited
initialItemCount → int
The number of items the list will start with.
final
itemBuilder → AnimatedListItemBuilder
Called, as needed, to build list item widgets.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
padding → EdgeInsetsGeometry?
The amount of space by which to inset the children.
final
physics → ScrollPhysics?
The axis along which the scroll view scrolls.
final
properties → ScrollViewProperties
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shrinkWrap → bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → AnimatedListState
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, int wrapWidth = 65}) → 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

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.