rememberLazyGridState

Composable Function

Common
@Composable
fun rememberLazyGridState(
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
): LazyGridState

Creates a LazyGridState 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

initialFirstVisibleItemIndexthe initial value for LazyGridState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffsetthe initial value for LazyGridState.firstVisibleItemScrollOffset
Common
@ExperimentalFoundationApi
@Composable
fun rememberLazyGridState(
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
    prefetchStrategy: LazyGridPrefetchStrategy = remember { LazyGridPrefetchStrategy() },
): LazyGridState

Creates a LazyGridState 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

initialFirstVisibleItemIndexthe initial value for LazyGridState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffsetthe initial value for LazyGridState.firstVisibleItemScrollOffset
prefetchStrategythe LazyGridPrefetchStrategy to use for prefetching content in this grid
Common
@ExperimentalFoundationApi
@Composable
fun rememberLazyGridState(
    cacheWindow: LazyLayoutCacheWindow,
    initialFirstVisibleItemIndex: Int = 0,
    initialFirstVisibleItemScrollOffset: Int = 0,
): LazyGridState

Creates a LazyGridState 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

cacheWindowspecifies the size of the ahead and behind window to be used as per LazyLayoutCacheWindow.
initialFirstVisibleItemIndexthe initial value for LazyGridState.firstVisibleItemIndex
initialFirstVisibleItemScrollOffsetthe initial value for LazyGridState.firstVisibleItemScrollOffset