PaginationWidget class

A widget that handles pagination when the user scrolls.

The PaginationWidget class is a StatelessWidget that wraps a child widget and listens for scroll notifications to trigger a pagination function when the user reaches near the bottom of the scrollable content.

Example usage:

PaginationWidget(
  child: ListView.builder(
    itemCount: items.length,
    itemBuilder: (context, index) {
      return ListTile(title: Text(items[index]));
    },
  ),
  paginationFunction: fetchMoreItems,
  total: totalItems,
  current: currentItems,
  paginate: true,
);
Inheritance

Constructors

PaginationWidget({Key? key, required Widget child, required void paginationFunction(), required int total, required int current, bool? paginate})
Constructs a PaginationWidget.

Properties

child → Widget
The child widget that will be wrapped by the pagination logic.
final
current → int
The current number of items loaded.
final
hashCode → int
The hash code for this object.
no setterinherited
height → RxDouble
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loader → RxBool
final
paginate → bool?
A flag indicating whether to enable pagination.
final
paginationFunction → void Function()
The function to be called to load more data when the user scrolls near the bottom.
final
position → RxInt
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollState → RxBool
final
timer ↔ Timer?
getter/setter pair
total → int
The total number of items available.
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