PagerState

val Saver: Saver<PagerState, *>

To keep current page and page offset saved

suspend fun animateScrollToPage(
    page: Int,
    pageOffsetFraction: @FloatRange(from = -0.5, to = 0.5) Float = 0.0f,
    animationSpec: AnimationSpec<Float> = spring()
): Unit

Scroll animate to a given page. If the page is too far away from currentPage we will not compose all pages in the way. We will pre-jump to a nearer page, compose and animate the rest of the pages until page.

suspend fun scrollToPage(
    page: Int,
    pageOffsetFraction: @FloatRange(from = -0.5, to = 0.5) Float = 0.0f
): Unit

Scroll (jump immediately) to a given page.

val currentPage: Int

The current page displayed by the pager.

val currentPageOffsetFraction: Float

The fractional offset from the start of the current page, in the range -0.5,0.5, where 0 indicates the start of the current page

val interactionSource: InteractionSource

InteractionSource that will be used to dispatch drag events when this list is being dragged. If you want to know whether the fling (or animated scroll) is in progress, use isScrollInProgress.

val layoutInfo: PagerLayoutInfo

A PagerLayoutInfo that contains useful information about the Pager's last layout pass. For instance, you can query the page size.

This property is observable and is updated after every scroll or remeasure. If you use it in the composable function it will be recomposed on every change causing potential performance issues including infinity recomposition loop. Therefore, avoid using it in the composition.

If you want to run some side effects like sending an analytics event or updating a state based on this value consider using "snapshotFlow".

val pageCount: Int

The total number of pages present in this pager.

val settledPage: Int

The page that is currently "settled". This is an animation/gesture unaware page in the sense that it will not be updated while the pages are being scrolled, but rather when the animation/scroll settles.

val targetPage: Int

The page this pager intends to settle to. During fling or animated scroll (from animateScrollToPage) this will represent the page this pager intends to settle to. When no scroll is ongoing, this will be equal to currentPage.