SliverAnimatedGrid class Null safety

A SliverGrid that animates items when they are inserted or removed.

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

This sample application uses a SliverAnimatedGrid to create an animated 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.SliverAnimatedGrid.1 mysample

See also:

  • AnimatedGrid, a non-sliver scrolling container that animates items when they are inserted into or removed from a grid.
  • SliverGrid, which does not animate items when they are inserted or removed from a grid.
  • SliverList, which displays a non-animated list of items.
  • SliverAnimatedList, which animates items added and removed from a list instead of a grid.
Inheritance

Constructors

SliverAnimatedGrid({Key? key, required AnimatedItemBuilder itemBuilder, required SliverGridDelegate gridDelegate, ChildIndexGetter? findChildIndexCallback, int initialItemCount = 0})
Creates a SliverGrid that animates items when they are inserted or removed.
const

Properties

findChildIndexCallback ChildIndexGetter?
Called to find the new index of a child based on its key in case of reordering.
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
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

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