AnimatedStaggeredGrid class
A scrolling container that animates items when they are inserted or removed.
This widget's AnimatedStaggeredGridState can be used to dynamically insert or remove items. To refer to the AnimatedStaggeredGridState 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.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AnimatedStaggeredGrid
Constructors
- AnimatedStaggeredGrid({Key? key, required AnimatedStaggeredGridItemBuilder itemBuilder, required int crossAxisCount, required IndexedStaggeredTileBuilder staggeredTileBuilder, double mainAxisSpacing = 4.0, double crossAxisSpacing = 4.0, int initialItemCount = 0, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding})
-
Creates a scrolling container that animates items when they are inserted or removed.
const
Properties
- controller → ScrollController?
-
An object that can be used to control the position to which this scroll
view is scrolled.
final
- crossAxisCount → int
-
The number of children in the cross axis.
final
- crossAxisSpacing → double
-
The number of logical pixels between each child along the cross axis.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialItemCount → int
-
The number of items the list will start with.
final
- itemBuilder → AnimatedStaggeredGridItemBuilder
-
Called, as needed, to build list item widgets.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- mainAxisSpacing → double
-
The number of logical pixels between each child along the main axis.
final
- padding → EdgeInsetsGeometry?
-
The amount of space by which to inset the children.
final
- physics → ScrollPhysics?
-
How the scroll view should respond to user input.
final
- primary → bool?
-
Whether this is the primary scroll view associated with the parent
PrimaryScrollController.
final
- reverse → bool
-
Whether the scroll view scrolls in the reading direction.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollDirection → Axis
-
The axis along which the scroll view scrolls.
final
- shrinkWrap → bool
-
Whether the extent of the scroll view in the scrollDirection should be
determined by the contents being viewed.
final
- staggeredTileBuilder → IndexedStaggeredTileBuilder
-
Signature for a function that creates StaggeredTile for a given index.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → AnimatedStaggeredGridState -
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}) → 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
-
of(
BuildContext context, {bool nullOk = false}) → AnimatedStaggeredGridState? - The state from the closest instance of this class that encloses the given context.