PagerState

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

PagerState

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

Companion

animateScrollToPage

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

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

dispatchRawDelta

open override fun dispatchRawDelta(delta: Float): Float

scroll

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

scrollToPage

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

Instantly brings the item at page to the middle of the viewport.

toString

open override fun toString(): String

currentPage

The index of the currently selected page.

currentPageOffset

The current offset from the start of currentPage, as a ratio of the page width.

interactionSource

InteractionSource that will be used to dispatch drag events when this list is being dragged.

isScrollInProgress

pageCount

The number of pages to display.

targetPage

The target page for any on-going animations or scrolls by the user.

androidJvm source