redwood-lazylayout-schema/app.cash.redwood.lazylayout/RefreshableLazyList

RefreshableLazyList

data class RefreshableLazyList(val isVertical: Boolean, val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, val itemsBefore: Int, val itemsAfter: Int, val refreshing: Boolean, val onRefresh: () -> Unit?, val width: Constraint, val height: Constraint, val margin: Margin, val crossAxisAlignment: CrossAxisAlignment, val scrollItemIndex: ScrollItemIndex, val pullRefreshContentColor: UInt, val placeholder: () -> Unit, val items: () -> Unit)

Constructors

RefreshableLazyList

constructor(isVertical: Boolean, onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit, itemsBefore: Int, itemsAfter: Int, refreshing: Boolean, onRefresh: () -> Unit?, width: Constraint, height: Constraint, margin: Margin, crossAxisAlignment: CrossAxisAlignment, scrollItemIndex: ScrollItemIndex, pullRefreshContentColor: UInt, placeholder: () -> Unit, items: () -> Unit)

Properties

crossAxisAlignment

val crossAxisAlignment: CrossAxisAlignment

If isVertical, sets the default horizontal alignment for items in this list. Else, sets the default vertical alignment for items in this list.

height

val height: Constraint

Sets whether the list's height will wrap its contents (Constraint.Wrap) or match the height of its parent (Constraint.Fill).

isVertical

val isVertical: Boolean

Whether the list should be vertically oriented.

items

val items: () -> Unit

The window of items to be inflated by the native lazy list widget implementation. The window is defined as a sequential subset of the composables emitted in items. These composables are created by incrementally passing a range of indices to the user-defined item factories, as specified in the LazyListScope functions.

itemsAfter

val itemsAfter: Int

The number of un-emitted items after the items window.

itemsBefore

val itemsBefore: Int

The number of un-emitted items before the items window.

margin

val margin: Margin

Applies margin (space) around the list.

onRefresh

val onRefresh: () -> Unit?

Called when a swipe gesture triggers a pull-to-refresh.

onViewportChanged

val onViewportChanged: (firstVisibleItemIndex: Int, lastVisibleItemIndex: Int) -> Unit

Invoked when the user has scrolled the list, such that the firstVisibleItemIndex or the lastVisibleItemIndex has changed. When the user performs a fling, onViewportChanged will be invoked multiple times.

placeholder

val placeholder: () -> Unit

A block which describes the content of each placeholder item.

pullRefreshContentColor

val pullRefreshContentColor: UInt

The color of the pull-to-refresh indicator as an ARGB color int.

refreshing

val refreshing: Boolean

Whether or not the list should show the pull-to-refresh indicator.

scrollItemIndex

val scrollItemIndex: ScrollItemIndex

The last ScrollItemIndex programmatically requested by the user. The native lazy list widget implementation will scroll itself such that the item index will be at the start of the viewport.

width

val width: Constraint

Sets whether the list's width will wrap its contents (Constraint.Wrap) or match the width of its parent (Constraint.Fill).