AnimatedGrid class Null safety

A scrolling container that animates items when they are inserted into or removed from a grid. in a grid.

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

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

This sample application uses an AnimatedGrid to create an effect when items are removed or added to the grid.
link

To create a local project with this code sample, run:
flutter create --sample=widgets.AnimatedGrid.1 mysample

See also:

  • SliverAnimatedGrid, a sliver which animates items when they are inserted into or removed from a grid.
  • SliverAnimatedList, a sliver which animates items added and removed from a list instead of a grid.
  • AnimatedList, which animates items added and removed from a list instead of a grid.
Inheritance

Constructors

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

Properties

clipBehavior Clip
The content will be clipped (or not) according to this option.
finalinherited
controller ScrollController?
An object that can be used to control the position to which this scroll view is scrolled.
finalinherited
gridDelegate SliverGridDelegate
A delegate that controls the layout of the children within the AnimatedGrid.
final
hashCode int
The hash code for this object.
read-onlyinherited
initialItemCount int
The number of items the AnimatedList or AnimatedGrid will start with.
finalinherited
itemBuilder AnimatedItemBuilder
Called, as needed, to build children widgets.
finalinherited
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.
finalinherited
physics ScrollPhysics?
How the scroll view should respond to user input.
finalinherited
primary bool?
Whether this is the primary scroll view associated with the parent PrimaryScrollController.
finalinherited
reverse bool
Whether the scroll view scrolls in the reading direction.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
scrollDirection Axis
The axis along which the scroll view scrolls.
finalinherited
shrinkWrap bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.
finalinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() AnimatedGridState
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 non-existent 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}) 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) AnimatedGridState?
The state from the closest instance of this class that encloses the given context.
of(BuildContext context) AnimatedGridState
The state from the closest instance of this class that encloses the given context.