pager/com.google.accompanist.pager/PagerState

PagerState

class PagerState(currentPage: Int = 0) : 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

fun PagerState(currentPage: Int = 0)

Types

object Companion

Functions

animateScrollToPage

suspend fun animateScrollToPage(page: Int, pageOffset: Float = 0.0f)

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

~~suspend~~ ~~fun~~ ~~animateScrollToPage~~( page: Int, pageOffset: Float = 0.0f, animationSpec: AnimationSpec<Float> = spring(), initialVelocity: Float = 0.0f, skipPages: Boolean = true)

dispatchRawDelta

open override fun dispatchRawDelta(delta: Float): Float

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

suspend fun scrollToPage(page: Int, pageOffset: Float = 0.0f)

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

open override fun toString(): String

Properties

var currentPage: Int

The index of the currently selected page. This may not be the page which is currently displayed on screen.

currentPageOffset

val currentPageOffset: Float

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

interactionSource

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.

isScrollInProgress

open override val isScrollInProgress: Boolean

val pageCount: Int

The number of pages to display.

~~val~~ ~~targetPage~~: Int

The target page for any on-going animations or scrolls by the user. Returns the current page if a scroll or animation is not currently in progress.