PagerState

@Stable()

class PagerState(@IntRange(from = 0.toLong()) currentPage: Int) : ScrollableState

A state object that can be hoisted to control and observe scrolling for HorizontalPager.

In most cases, this will be created via rememberPagerState.

Parameters

currentPage

the initial value for PagerState.currentPage

Constructors

PagerState

fun PagerState(@IntRange(from = 0.toLong()) currentPage: Int = 0)

the initial value for PagerState.currentPage

Types

Companion

object Companion

Functions

animateScrollToPage

suspend fun animateScrollToPage(@IntRange(from = 0.toLong()) page: Int, @FloatRange(from = -1.0.toDouble(), to = 1.0.toDouble()) pageOffset: Float = 0f)

Animate (smooth scroll) to the given page to the middle of the viewport.

suspend fun animateScrollToPage(@IntRange(from = 0.toLong()) page: Int, @FloatRange(from = 0.0.toDouble(), to = 1.0.toDouble()) pageOffset: Float = 0f, animationSpec: AnimationSpec<Float> = spring(), initialVelocity: Float = 0f, skipPages: Boolean = true)

dispatchRawDelta

open override fun dispatchRawDelta(delta: Float): Float

scroll

open suspend override fun scroll(scrollPriority: MutatePriority, block: suspend ScrollScope.() -> Unit)

scrollToPage