EndlessPaginationListView<T> class

An infinite loading list view that builds items loaded from the loadMore API into a scrollable list.

Inheritance

Constructors

EndlessPaginationListView({required Future<List<T>> loadMore(int pageIndex), required Widget itemBuilder(BuildContext context, {required int index, required T item, required int totalItems}), required EndlessPaginationDelegate paginationDelegate, double? extentAfterFactor = 0.4, EndlessPaginationController<T>? controller, ScrollController? scrollController, void onStateChange(Set<EndlessState> states)?, EdgeInsets? padding, double? itemPadding, Widget headerBuilder(BuildContext context)?, EndlessStateProperty? headerBuilderState, Widget emptyBuilder(BuildContext context)?, EndlessStateProperty? emptyBuilderState, Widget loadingBuilder(BuildContext context)?, EndlessStateProperty? loadingBuilderState, Widget loadMoreBuilder(BuildContext context)?, EndlessStateProperty? loadMoreBuilderState, Widget footerBuilder(BuildContext context)?, EndlessStateProperty? footerBuilderState, ScrollPhysics? physics, bool? initialLoad = true, dynamic key})
const

Properties

controller → EndlessPaginationController<T>?
The stream controller used to perform actions on the list view such as loading more data or clearing the list.
final
emptyBuilder → Widget Function(BuildContext context)?
The builder function for the list view empty state.
final
emptyBuilderState → EndlessStateProperty?
The state property for the list view empty state.
final
extentAfterFactor → double?
The fraction of the remaining quantity of content conceptually "below" the viewport in the scrollable relative to the maximum height of the scrollable region at which point loadMore should be called to load more data.
final
footerBuilder → Widget Function(BuildContext context)?
The builder function for the list view footer.
final
footerBuilderState → EndlessStateProperty?
The state property for the list view footer.
final
hashCode → int
The hash code for this object.
no setterinherited
headerBuilder → Widget Function(BuildContext context)?
The builder function for the list view header.
final
headerBuilderState → EndlessStateProperty?
The state property for the list view header.
final
initialLoad → bool?
Whether to immediately request data from the stream when it is first subscribed to by calling the loadMore API.
final
itemBuilder → Widget Function(BuildContext context, {required int index, required T item, required int totalItems})
The builder function for the list view items.
final
itemPadding → double?
The padding number in between each item in the list view.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingBuilder → Widget Function(BuildContext context)?
The builder function for the list view loading state.
final
loadingBuilderState → EndlessStateProperty?
The state property for the list view loading state.
final
loadMore → Future<List<T>> Function(int pageIndex)
A function which returns the additional items to add to the list view when it is scrolled to its threshold for loading more items determined by the extentAfterFactor.
final
loadMoreBuilder → Widget Function(BuildContext context)?
The builder function for the list view load more action widget.
final
loadMoreBuilderState → EndlessStateProperty?
The state property for the list view load more action widget.
final
onStateChange → void Function(Set<EndlessState> states)?
A callback function that provides the current states of the endless scroll view whenever they change.
final
padding → EdgeInsets?
The padding around the scroll view.
final
paginationDelegate → EndlessPaginationDelegate
The delegate that specifies the pagination requirements for the list view such as the maximum number of pages to load and the page size.
final
physics → ScrollPhysics?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
The scroll controller for the list view.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
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
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