redwood-lazylayout-compose/app.cash.redwood.lazylayout.compose/LazyListState

LazyListState

open class LazyListState

A state object that can be hoisted to control and observe scrolling.

In most cases, this will be created via rememberLazyListState.

Constructors

constructor()

Properties

defaultPreloadItemCount

var defaultPreloadItemCount: Int

var firstIndex: Int

Bounds of what the user is looking at. Everything else is placeholders!

var lastIndex: Int

primaryPreloadItemCount

var primaryPreloadItemCount: Int

programmaticScrollIndex

var programmaticScrollIndex: ScrollItemIndex

Update this to trigger a programmatic scroll. This may be updated multiple times, including when the previous scroll state is restored.

scrollInProgressPreloadItemCount

var scrollInProgressPreloadItemCount: Int

secondaryPreloadItemCount

var secondaryPreloadItemCount: Int

Functions

fun loadRange(itemCount: Int): IntRange

fun onUserScroll(firstIndex: Int, lastIndex: Int)

React to a user-initiated scroll.

programmaticScroll

fun programmaticScroll(firstIndex: Int, animated: Boolean, clobberUserScroll: Boolean = true)

Perform a programmatic scroll.