ReadyList<T, S extends BaseReadyListState<T>, TController extends ReadyListController<T, S>> class

Inheritance
Implemented types

Constructors

ReadyList.grid({Key? key, ScrollController? scrollController, ReadyListWidgetBuilder<T, S>? headerSlivers, StateResultCallBack<bool>? handleNestedScrollViewOverlap, ReadyListWidgetBuilder<T, S>? innerFooterSlivers, ReadyListWidgetBuilder<T, S>? footerSlivers, required ReadyListItemBuilder<T> buildItem, GridDelegateCallback gridDelegate = Grids.columns_2, required TController controller, Iterable<T> filterItems(Iterable<T> items)?, bool? allowFakeItems, PlaceholdersConfig? placeholdersConfig, bool? showNoMoreText, bool? allowRefresh, bool? allowLoadNext, String? noMoreText, String? loadMoreText, EdgeInsetsGeometry? padding, int? pageSize, bool? reverse, bool keepAlive = true, GradientGetterCallback? shimmerScopeGradient, StateResultCallBack<bool>? shrinkWrap, AxisConfig? axis, ScrollPhysics? physics, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers})
SliverStaggeredGridDelegateWithFixedCrossAxisCount SliverStaggeredGridDelegateWithMaxCrossAxisExtent You can use Grids.columns_1 Grids.columns_2 etc...
const
ReadyList.list({Key? key, ScrollController? scrollController, ReadyListWidgetBuilder<T, S>? headerSlivers, ReadyListWidgetBuilder<T, S>? innerFooterSlivers, ReadyListWidgetBuilder<T, S>? footerSlivers, required ReadyListItemBuilder<T> buildItem, ReorderOptions? reorderOptions, required TController controller, Iterable<T> filterItems(Iterable<T> items)?, StateResultCallBack<bool>? handleNestedScrollViewOverlap, PlaceholdersConfig? placeholdersConfig, bool? showNoMoreText, bool? allowRefresh, bool? allowLoadNext, String? noMoreText, String? loadMoreText, EdgeInsetsGeometry? padding, bool? reverse, bool keepAlive = true, GradientGetterCallback? shimmerScopeGradient, StateResultCallBack<bool>? shrinkWrap, int? pageSize, AxisConfig? axis, ScrollPhysics? physics, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers, bool? allowFakeItems})
const
ReadyList.slivers({Key? key, ScrollController? scrollController, ReadyListWidgetBuilder<T, S>? headerSlivers, ReadyListWidgetBuilder<T, S>? innerFooterSlivers, ReadyListWidgetBuilder<T, S>? footerSlivers, required ReadyListSliverBuilder<T, S> slivers, required TController controller, PlaceholdersConfig? placeholdersConfig, bool? showNoMoreText, bool? allowRefresh, bool? allowLoadNext, String? noMoreText, String? loadMoreText, bool? reverse, StateResultCallBack<bool>? handleNestedScrollViewOverlap, bool keepAlive = true, StateResultCallBack<bool>? shrinkWrap, int? pageSize, AxisConfig? axis, ScrollPhysics? physics, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers, GradientGetterCallback? shimmerScopeGradient})
const

Properties

allowFakeItems → bool?
if this is true the the item that passed to builder item may be null useful to display shimmer
final
allowLoadNext → bool?
whether to allow infinite scroll or not
final
allowRefresh → bool?
whether to allow pull to refresh or not
final
axis → AxisConfig?
axis of the list
final
controller → TController
final
filterItems → (Iterable<T> Function(Iterable<T> items)?)
final
footerSlivers → ReadyListWidgetBuilder<T, S>?
final
handleNestedScrollViewOverlap → StateResultCallBack<bool>?
if true it will add SliverOverlapInjector if the list placed inside NestedScrollView defaults to true
final
hashCode → int
The hash code for this object.
no setterinherited
headerSlivers → ReadyListWidgetBuilder<T, S>?
final
innerFooterSlivers → ReadyListWidgetBuilder<T, S>?
final
keepAlive → bool
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadMoreText → String?
The text to display when items loaded but not fill the screen
final
noMoreText → String?
The text to displayed when no more items
final
padding → EdgeInsetsGeometry?
padding of the list
final
pageSize → int?
page size to be passed to controller loadData
final
physics → ScrollPhysics?
physics of the list
final
placeholdersConfig → PlaceholdersConfig?
Config for placeholders when list is empty or has error PlaceholdersConfig.loadingText & PlaceholdersConfig.loadingIndicator is not used when allowFakeItems is true
final
reverse → bool?
whether to reverse the list or not
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
final
shimmerScopeGradient → GradientGetterCallback?
gradient of shimmer scope
final
showNoMoreText → bool?
if false we will not show 'No more text' at the end of the list
final
shrinkWrap → StateResultCallBack<bool>?
whether to shrink-wrap or not
final
topLevelFooterSlivers → List<Widget>?
The first items in the list This can be configured globally
final
topLevelHeaderSlivers → List<Widget>?
The last items in the list This can be configured globally
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ReadyList<T, S, TController>>
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