SuraPaginatedList class

Inheritance
Available Extensions

Constructors

SuraPaginatedList({Key? key, required int itemCount, required IndexedWidgetBuilder itemBuilder, required Future<void> dataLoader(), required bool hasMoreData, ScrollPhysics? physics = const ClampingScrollPhysics(), bool shrinkWrap = false, Widget? loadingWidget = const CircularProgressIndicator(), EdgeInsets padding = const EdgeInsets.symmetric(vertical: 16, horizontal: 12), Axis scrollDirection = Axis.vertical, Widget? separator, IndexedWidgetBuilder? separatorBuilder, Widget? onEmpty, ScrollController? scrollController, bool attachProvidedScrollControllerToListview = false, bool hasError = false, Widget? errorWidget})
const

Properties

attachProvidedScrollControllerToListview bool
Add provided scrollController to our PaginatedListview Use case: Provided scroll controller usually happen when this ListView is inside another Listview, So we use provided scrollController to check for paginated trigger only but not attach to PaginatedList But sometime, provided ScrollController isn't attach to any parent Listview yet. So in that case it must be attach to our PaginatedList
final
dataLoader Future<void> Function()
callback for getting more data when ScrollController reach max scrolExtends
final
errorWidget Widget?
A widget that show at the bottom of listview when there is an error
final
hasError bool
Indicate if there is an error when getting more data
final
hashCode int
The hash code for this object.
no setterinherited
hasMoreData bool
condition to check if we still have more data to fetch Example: currentItems == totalItems or currentPage == totalPages
final
itemBuilder IndexedWidgetBuilder
Normal Listview itemBuilder
final
itemCount int
Normal Listview itemCount
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingWidget Widget?
widget to show when we're fetching more data
final
onEmpty Widget?
Provider a widget if there's no item
final
padding EdgeInsets
Normal Listview padding
final
physics ScrollPhysics?
Normal Listview physics
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollController ScrollController?
If SuraPaginatedList is user inside another scroll view, you must provide a scrollController that also use in your parent scrollController scroll view
final
scrollDirection Axis
Normal Listview scrollDirection
final
separator Widget?
SuraPaginatedList use ListView.separated, so you can provide divider widget This can be use to replace separatorBuilder
final
separatorBuilder IndexedWidgetBuilder?
SuraPaginatedList use ListView.separated, so you can provide divider widget
final
shrinkWrap bool
Normal Listview shrinkWrap
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _SuraPaginatedListState
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}) 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