SuperScroll class
A simple and lightweight pagination widget for Flutter.
SuperScroll wraps a scrollable widget and uses a SuperScrollController to manage pagination logic automatically.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SuperScroll
Constructors
- SuperScroll({required Widget child, required SuperScrollController controller, double scrollOffset = 100.0, Widget? newPageProgressIndicator, Widget? firstPageProgressIndicator, Widget? firstPageErrorIndicator, Widget? newPageErrorIndicator, Widget? noItemsFoundIndicator, Widget? noMoreItemsIndicator, ScrollController? scrollController, Key? key})
-
const
Properties
- child → Widget
-
The scrollable widget to be wrapped (e.g., ListView, GridView).
Note: The child's itemCount should typically be
controller.items.length.final - controller → SuperScrollController
-
The controller managing the pagination state.
final
- firstPageErrorIndicator → Widget?
-
Widget to display when an error occurs fetching the first page.
final
- firstPageProgressIndicator → Widget?
-
Widget to display when the first page is loading.
If null, a default SuperSkeleton list is used.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- newPageErrorIndicator → Widget?
-
Widget to display when an error occurs fetching a subsequent page.
final
- newPageProgressIndicator → Widget?
-
Widget to display at the bottom when loading subsequent pages.
If null, a default SuperSkeleton is used.
final
- noItemsFoundIndicator → Widget?
-
Widget to display when no items were found on the first page.
final
- noMoreItemsIndicator → Widget?
-
Widget to display when there are no more items to load.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
An optional ScrollController to monitor the scroll position.
If not provided, an internal one will be created.
final
- scrollOffset → double
-
Distance from the bottom (in pixels) to trigger loading more data.
Defaults to 100.0.
final
-
Whether to show the default footer (indicators) managed by SuperScroll.
Set to false if the child manages its own indicators (e.g., using SuperSliverList).
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SuperScroll> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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