ReadyListConfig class

Inheritance
Implemented types

Constructors

ReadyListConfig({Key? key, required Widget child, PlaceholdersConfig? placeholdersConfig, StateResultCallBack<bool>? handleNestedScrollViewOverlap, bool? showNoMoreText, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers, bool? allowRefresh, bool? allowLoadNext, bool? allowFakeItems, String? noMoreText, String? loadMoreText, EdgeInsetsGeometry? padding, bool? reverse, GradientGetterCallback? shimmerScopeGradient, StateResultCallBack<bool>? shrinkWrap, AxisConfig? axis, ScrollPhysics? physics, int? pageSize})
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
child Widget
The widget below this widget in the tree.
finalinherited
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
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
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() InheritedElement
Inflates this configuration to a concrete instance.
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}) 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
updateShouldNotify(covariant ReadyListConfig oldWidget) bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

of(BuildContext context) ReadyListConfig?