{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

LazyStaggeredGridStateKt

public final class LazyStaggeredGridStateKt


Summary

Public methods

static final @NonNull LazyStaggeredGridState
@Composable
rememberLazyStaggeredGridState(
    int initialFirstVisibleItemIndex,
    int initialFirstVisibleItemScrollOffset
)

Creates a LazyStaggeredGridState that is remembered across composition.

Public methods

rememberLazyStaggeredGridState

@Composable
public static final @NonNull LazyStaggeredGridState rememberLazyStaggeredGridState(
    int initialFirstVisibleItemIndex,
    int initialFirstVisibleItemScrollOffset
)

Creates a LazyStaggeredGridState that is remembered across composition.

Calling this function with different parameters on recomposition WILL NOT recreate or change the state. Use LazyStaggeredGridState.scrollToItem or LazyStaggeredGridState.animateScrollToItem to adjust position instead.

Parameters
int initialFirstVisibleItemIndex

initial position for LazyStaggeredGridState.firstVisibleItemIndex

int initialFirstVisibleItemScrollOffset

initial value for LazyStaggeredGridState.firstVisibleItemScrollOffset

Returns
@NonNull LazyStaggeredGridState

created and memoized LazyStaggeredGridState with given parameters.