rememberGlimmerPagerState

Functions summary

GlimmerPagerState
@Composable
rememberGlimmerPagerState(
    initialPage: @IntRange(from = 0) Int,
    initialPageOffsetFraction: @FloatRange(from = -0.5, to = 0.5) Float,
    pageCount: () -> Int
)

Creates and remembers a GlimmerPagerState to be used with a GlimmerHorizontalPager.

Functions

rememberGlimmerPagerState

@Composable
fun rememberGlimmerPagerState(
    initialPage: @IntRange(from = 0) Int = 0,
    initialPageOffsetFraction: @FloatRange(from = -0.5, to = 0.5) Float = 0.0f,
    pageCount: () -> Int
): GlimmerPagerState

Creates and remembers a GlimmerPagerState to be used with a GlimmerHorizontalPager.

Parameters
initialPage: @IntRange(from = 0) Int = 0

the initial page to be displayed. Defaults to 0.

initialPageOffsetFraction: @FloatRange(from = -0.5, to = 0.5) Float = 0.0f

The offset of the initial page as a fraction of the page size. This should vary between -0.5 and 0.5 and indicates how to offset the initial page from the snapped position.

pageCount: () -> Int

a lambda returning the total number of pages in the pager.