rememberLazyListState

Composable Function
Common
@Composable
fun rememberLazyListState(
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
): LazyListState

Creates a LazyListState that is remembered across compositions.

Changes to the provided initial values will not result in the state being recreated or changed in any way if it has already been created.

Parameters
initialFirstVisibleItemIndex the initial value for LazyListState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffset the initial value for LazyListState.firstVisibleItemScrollOffset
Common
@ExperimentalFoundationApi
@Composable
fun rememberLazyListState(
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
    prefetchStrategy: LazyListPrefetchStrategy = remember { LazyListPrefetchStrategy() },
): LazyListState

Creates a LazyListState that is remembered across compositions.

Changes to the provided initial values will not result in the state being recreated or changed in any way if it has already been created.

Parameters
initialFirstVisibleItemIndex the initial value for LazyListState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffset the initial value for LazyListState.firstVisibleItemScrollOffset
prefetchStrategy the LazyListPrefetchStrategy to use for prefetching content in this list
Common
@ExperimentalFoundationApi
@Composable
fun rememberLazyListState(
    cacheWindow: LazyLayoutCacheWindow,
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
): LazyListState

Creates a LazyListState that is remembered across compositions.

Changes to the provided initial values will not result in the state being recreated or changed in any way if it has already been created.

Parameters
cacheWindow specifies the size of the ahead and behind window to be used as per LazyLayoutCacheWindow.
initialFirstVisibleItemIndex the initial value for LazyListState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffset the initial value for LazyListState.firstVisibleItemScrollOffset