PagedMasonryGridView<PageKeyType, ItemType> class

A MasonryGridView with pagination capabilities.

You can also see this as a PagedGridView that supports rows of varying sizes.

This is a wrapper around the MasonryGridView from the flutter_staggered_grid_view package. For more info on how to build staggered grids, check out the referred package's documentation and examples.

Inheritance

Constructors

PagedMasonryGridView({required PagedChildBuilderDelegate<PagingItem> builderDelegate, required SliverSimpleGridDelegateBuilder gridDelegateBuilder, PagedChildStatusBuilderDelegate<PagingItem>? statusBuilderDelegate, Axis scrollDirection = Axis.vertical, bool reverse = false, bool? primary, ScrollPhysics? physics, ScrollController? scrollController, double mainAxisSpacing = 0.0, double crossAxisSpacing = 0.0, double? cacheExtent, bool showNewPageProgressIndicatorAsGridChild = true, bool showNewPageErrorIndicatorAsGridChild = true, bool showNoMoreItemsIndicatorAsGridChild = true, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, bool shrinkWrap = false, EdgeInsetsGeometry? padding, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, required PagingDataController<dynamic, PagingItem> pagingBuilderController, Key? key})
const
PagedMasonryGridView.count({required PagedChildBuilderDelegate<PagingItem> builderDelegate, required int crossAxisCount, PagedChildStatusBuilderDelegate<PagingItem>? statusBuilderDelegate, Axis scrollDirection = Axis.vertical, bool reverse = false, bool? primary, ScrollPhysics? physics, ScrollController? scrollController, double mainAxisSpacing = 0.0, double crossAxisSpacing = 0.0, double? cacheExtent, bool showNewPageProgressIndicatorAsGridChild = true, bool showNewPageErrorIndicatorAsGridChild = true, bool showNoMoreItemsIndicatorAsGridChild = true, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, bool shrinkWrap = false, EdgeInsetsGeometry? padding, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, required PagingDataController<dynamic, PagingItem> pagingBuilderController, Key? key})
Equivalent to MasonryGridView.count.
PagedMasonryGridView.extent({required PagedChildBuilderDelegate<PagingItem> builderDelegate, required double maxCrossAxisExtent, PagedChildStatusBuilderDelegate<PagingItem>? statusBuilderDelegate, Axis scrollDirection = Axis.vertical, bool reverse = false, bool? primary, ScrollPhysics? physics, ScrollController? scrollController, double mainAxisSpacing = 0.0, double crossAxisSpacing = 0.0, double? cacheExtent, bool showNewPageProgressIndicatorAsGridChild = true, bool showNewPageErrorIndicatorAsGridChild = true, bool showNoMoreItemsIndicatorAsGridChild = true, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, bool shrinkWrap = false, EdgeInsetsGeometry? padding, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, required PagingDataController<dynamic, PagingItem> pagingBuilderController, Key? key})
Equivalent to MasonryGridView.extent.

Properties

addAutomaticKeepAlives → bool
Matches SliverChildBuilderDelegate.addAutomaticKeepAlives.
final
addRepaintBoundaries → bool
Matches SliverChildBuilderDelegate.addRepaintBoundaries.
final
addSemanticIndexes → bool
Matches SliverChildBuilderDelegate.addSemanticIndexes.
final
anchor → double
The relative position of the zero scroll offset.
finalinherited
builderDelegate → PagedChildBuilderDelegate<PagingItem>
Matches PagedLayoutBuilder.builderDelegate.
final
cacheExtent → double?
The viewport has an area before and after the visible area to cache items that are about to become visible when the user scrolls.
finalinherited
center → Key?
The first child in the GrowthDirection.forward growth direction.
finalinherited
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
crossAxisSpacing → double
final
dragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled.
finalinherited
gridDelegateBuilder → SliverSimpleGridDelegateBuilder
Provides the adjusted child count (based on the pagination status) so that a SliverSimpleGridDelegate can be returned.
final
hashCode → int
The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior
Defines the behavior of gesture detector used in this Scrollable.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior
ScrollViewKeyboardDismissBehavior the defines how this ScrollView will dismiss the keyboard automatically.
finalinherited
mainAxisSpacing → double
final
padding → EdgeInsetsGeometry?
The amount of space by which to inset the children.
finalinherited
pagingBuilderController → PagingDataController<dynamic, PagingItem>
final
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
restorationId → String?
Restoration ID to save and restore the scroll offset of the scrollable.
finalinherited
reverse → bool
Whether the scroll view scrolls in the reading direction.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollBehavior → ScrollBehavior?
A ScrollBehavior that will be applied to this widget individually.
finalinherited
scrollController → ScrollController?
Matches ScrollView.controller
final
scrollDirection → Axis
The Axis along which the scroll view's offset increases.
finalinherited
semanticChildCount → int?
The number of children that will contribute semantic information.
finalinherited
showNewPageErrorIndicatorAsGridChild → bool
Matches PagedSliverGrid.showNewPageErrorIndicatorAsGridChild.
final
showNewPageProgressIndicatorAsGridChild → bool
Matches PagedSliverGrid.showNewPageProgressIndicatorAsGridChild.
final
showNoMoreItemsIndicatorAsGridChild → bool
Matches PagedSliverGrid.showNoMoreItemsIndicatorAsGridChild.
final
shrinkWrap → bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.
finalinherited
statusBuilderDelegate → PagedChildStatusBuilderDelegate<PagingItem>?
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
buildChildLayout(BuildContext context) → Widget
Subclasses should override this method to build the layout model.
override
buildSlivers(BuildContext context) → List<Widget>
Build the list of widgets to place inside the viewport.
inherited
buildViewport(BuildContext context, ViewportOffset offset, AxisDirection axisDirection, List<Widget> slivers) → Widget
Build the viewport.
inherited
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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
getDirection(BuildContext context) → AxisDirection
Returns the AxisDirection in which the scroll view scrolls.
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