ListOptions<T, S extends BaseReadyListState<T>> class

options for ReadyList

Implemented types

• ReadyListConfigOptions

Constructors

ListOptions({GridDelegateCallback? gridDelegate, Widget trailing(T item)?, ScrollController? scrollController, ReadyListWidgetBuilder<T, S>? headerSlivers, ReadyListWidgetBuilder<T, S>? footerSlivers, ReadyListWidgetBuilder<T, S>? innerFooterSlivers, PlaceholdersConfig? placeholdersConfig, bool? showNoMoreText, StateResultCallBack<bool>? handleNestedScrollViewOverlap, String? noMoreText, String? loadMoreText, EdgeInsetsGeometry? padding, bool? reverse, GradientGetterCallback? shimmerScopeGradient, StateResultCallBack<bool>? shrinkWrap, Color headerColor(double percent)?, AxisConfig? axis, ScrollPhysics? physics, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers, int? pageSize, required TitleBuilderCallBack<T> title})

const

ListOptions.builder({required ListItemBuilder<T> builder, ScrollController? scrollController, ReadyListWidgetBuilder<T, S>? headerSlivers, ReadyListWidgetBuilder<T, S>? footerSlivers, StateResultCallBack<bool>? handleNestedScrollViewOverlap, ReadyListWidgetBuilder<T, S>? innerFooterSlivers, PlaceholdersConfig? placeholdersConfig, bool? showNoMoreText, Color headerColor(double percent)?, String? noMoreText, String? loadMoreText, EdgeInsetsGeometry? padding, bool? reverse, GradientGetterCallback? shimmerScopeGradient, StateResultCallBack<bool>? shrinkWrap, AxisConfig? axis, ScrollPhysics? physics, List<Widget>? topLevelFooterSlivers, List<Widget>? topLevelHeaderSlivers, int? pageSize, bool? allowFakeItems, GridDelegateCallback? gridDelegate})

build ReadyList item with custom builder

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

no setter, override

allowRefresh → bool?

whether to allow pull to refresh or not

no setter, override

axis → AxisConfig?

axis of the list

final

footerSlivers → ReadyListWidgetBuilder<T, S>?

ReadyList.footerSlivers

final

gridDelegate → GridDelegateCallback?

specify the grid delegate when the visible layout is ReadyList

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 setter, inherited

headerColor → (Color Function(double percent)?)

title is the card title of ReadyList item

final

headerSlivers → ReadyListWidgetBuilder<T, S>?

ReadyList.headerSlivers

final

innerFooterSlivers → ReadyListWidgetBuilder<T, S>?

ReadyList.innerFooterSlivers

final

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 setter, inherited

scrollController → ScrollController?

scroll controller for ReadyList

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

trailing → (Widget Function(T item)?)

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited