PagerState API Reference in foundation

Creates a default PagerState to be used with a Pager Please refer to the sample to learn how to use this API.

PagerState

Source set: Common

public fun PagerState(
    currentPage: Int = 0,
    @FloatRange(from = -0.5, to = 0.5) currentPageOffsetFraction: Float = 0f,
    pageCount: () -> Int,
): PagerState

Creates a default PagerState to be used with a Pager

Please refer to the sample to learn how to use this API.

Parameters


currentPage	The pager that should be shown first.
currentPageOffsetFraction	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	The amount of pages this Pager will have.