QueryStreamGridView<T> class
A grid view that is based on QueryStreamView.
To better understand the purpose of any parameters that are not documented, you can refer to the GridView.builder documentation.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- QueryStreamGridView
Constructors
-
QueryStreamGridView({Key? key, required Query<
Map< baseQuery, required String orderBy, bool descending = false, int pageSize = 20, bool includeMetadataChanges = false, bool allowSnapshotsFromCache = true, required T itemFromJson(Map<String, dynamic> >String, dynamic> ), required Widget itemBuilder(BuildContext, T), WidgetBuilder? newPageProgressIndicatorBuilder, WidgetBuilder? noItemsFoundIndicatorBuilder, WidgetBuilder? errorIndicatorBuilder, double minScrollExtentLeft = 500, bool showDebugLogs = false, required SliverGridDelegate gridDelegate, Axis scrollDirection = Axis.vertical, bool reverse = false, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, int? findChildIndexCallback(Key)?, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge})
Properties
- addAutomaticKeepAlives → bool
-
final
- addRepaintBoundaries → bool
-
final
- addSemanticIndexes → bool
-
final
- allowSnapshotsFromCache → bool
-
Whether to allow query snapshots that come from cache.
finalinherited
-
baseQuery
→ Query<
Map< String, dynamic> > -
The query with which the items are extracted.
finalinherited
- clipBehavior → Clip
-
final
- descending → bool
-
Whether the sort order for the orderBy field is descending.
finalinherited
- dragStartBehavior → DragStartBehavior
-
final
- errorIndicatorBuilder → WidgetBuilder?
-
The builder for a new page's error indicator.
finalinherited
- findChildIndexCallback → (int? Function(Key)?)
-
final
- gridDelegate → SliverGridDelegate
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- includeMetadataChanges → bool
-
Whether query metadata changes can produce an additional snapshot.
finalinherited
- itemBuilder → Widget Function(BuildContext, T)
-
The builder for the provided item.
finalinherited
- itemCount → int
-
The count of currently loaded items.
no setterinherited
-
itemFromJson
→ T Function(Map<
String, dynamic> ) -
The converter from a query document json to an item used in itemBuilder.
finalinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior
-
final
- minScrollExtentLeft → double
-
The minimum scroll extent that needs to be available below the current
viewport in order to not trigger loading more items.
finalinherited
- newPageProgressIndicatorBuilder → WidgetBuilder?
-
The builder for a new page's progress indicator.
finalinherited
- noItemsFoundIndicatorBuilder → WidgetBuilder?
-
The builder for a no items found indicator.
finalinherited
- orderBy → String
-
The name of the field by which to order the baseQuery.
finalinherited
- padding → EdgeInsetsGeometry?
-
final
- pageSize → int
-
The size of the item portion loaded initially and when more is needed.
finalinherited
- physics → ScrollPhysics?
-
final
- primary → bool?
-
final
- restorationId → String?
-
final
- reverse → bool
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController
-
no setterinherited
- scrollDirection → Axis
-
final
- semanticChildCount → int?
-
final
- showDebugLogs → bool
-
Whether to show debug logs.
finalinherited
- shrinkWrap → bool
-
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildItem(
dynamic context, dynamic index) → Widget -
Builds an item based on its
index.inherited -
buildView(
BoxConstraints constraints) → Widget -
Builds the view based on certain
constraints. -
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
-
getCacheExtent(
BoxConstraints constraints, Axis scrollDirection) → double -
Get the full cache extent for this view.
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