RealtimePagination class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RealtimePagination
Constructors
- RealtimePagination({Key? key, required Query query, required int itemsPerPage, required ItemBuilderDelegate itemBuilder, PaginatedBuilderDelegate? customPaginatedBuilder, double scrollThreshold = 0.85, Widget? initialLoading, Widget? emptyDisplay, Widget? bottomLoader, bool useRefreshIndicator = false, Function? onRefresh, ScrollController? scrollController})
-
const
Properties
- bottomLoader → Widget?
-
Widget to show at the under the last document, when the package is loading more documents.
final
- customPaginatedBuilder → PaginatedBuilderDelegate?
-
Return a ListView.builder or ListView.separated, assigning the passed properties.
The rest is fully customizable.
final
- emptyDisplay → Widget?
-
Widget to show when the query return no documents
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialLoading → Widget?
-
Widget to show when first fetching the query.
final
- itemBuilder → ItemBuilderDelegate
-
The Function called to build a document loaded.
final
- itemsPerPage → int
-
Quantity of items per page
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onRefresh → Function?
-
Function to call when refreshed, if useRefreshIndicator is true.
final
- query → Query
-
The Firestore query to make
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
You can pass your own instance of scrollController.
No need to dispose, already dispose internally.
final
- scrollThreshold → double
-
The scroll threshold before start to load new documents. (0...1)
final
- useRefreshIndicator → bool
-
If should use RefreshIndicator
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _RealtimePaginationState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects 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