All Implemented Interfaces:: androidx.compose.foundation.gestures.ScrollableState

@Deprecated(message = 
accompanist/pager is deprecated.
The androidx.compose equivalent of Insets is Pager.
For more migration information, please visit https://google.github.io/accompanist/pager/#migration
, replaceWith = @ReplaceWith(imports = {androidx.compose.foundation.pager.PagerState}, expression = PagerState(currentPage = currentPage)))@Stable() 
public final class PagerState
 implements ScrollableState

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

In most cases, this will be created via rememberPagerState.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`PagerState.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final InteractionSource`	`interactionSource`
`private final Integer`	`pageCount`
`private Integer`	`currentPage`
`private final Float`	`currentPageOffset`
`private final Integer`	`targetPage`
`private final Boolean`	`isScrollInProgress`
`private final Boolean`	`canScrollBackward`
`private final Boolean`	`canScrollForward`
`private final Boolean`	`lastScrolledBackward`
`private final Boolean`	`lastScrolledForward`

Constructor Summary

Constructors
Constructor	Description
`PagerState(Integer currentPage)`

Method Summary

Modifier and Type	Method	Description
`final InteractionSource`	`getInteractionSource()`
`final Integer`	`getPageCount()`	The number of pages to display.
`final Integer`	`getCurrentPage()`
`final Unit`	`setCurrentPage(Integer currentPage)`
`final Float`	`getCurrentPageOffset()`	The current offset from the start of currentPage, as a ratio of the page width.
`final Integer`	`getTargetPage()`
`Boolean`	`getIsScrollInProgress()`
`Boolean`	`getCanScrollBackward()`
`Boolean`	`getCanScrollForward()`
`Boolean`	`getLastScrolledBackward()`
`Boolean`	`getLastScrolledForward()`
`final Unit`	`animateScrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = 0.0.toDouble(), to = 1.0.toDouble()) Float pageOffset, AnimationSpec<Float> animationSpec, Float initialVelocity, Boolean skipPages)`
`final Unit`	`animateScrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = -1.0.toDouble(), to = 1.0.toDouble()) Float pageOffset)`	Animate (smooth scroll) to the given page to the middle of the viewport.
`final Unit`	`scrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = -1.0.toDouble(), to = 1.0.toDouble()) Float pageOffset)`	Instantly brings the item at page to the middle of the viewport.
`Unit`	`scroll(MutatePriority scrollPriority, SuspendFunction1<ScrollScope, Unit> block)`
`Float`	`dispatchRawDelta(Float delta)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PagerState
```
PagerState(Integer currentPage)
```
  Parameters:
  
  currentPage - the initial value for PagerState.currentPage

Method Detail

getInteractionSource

 final InteractionSource getInteractionSource()

getPageCount

@IntRange(from = 0.toLong()) final Integer getPageCount()

The number of pages to display.

getCurrentPage

@IntRange(from = 0.toLong()) final Integer getCurrentPage()

setCurrentPage

 final Unit setCurrentPage(Integer currentPage)

getCurrentPageOffset
```
 final Float getCurrentPageOffset()
```
The current offset from the start of currentPage, as a ratio of the page width.
To update the scroll position, use scrollToPage or animateScrollToPage.

getTargetPage
```
 final Integer getTargetPage()
```

getIsScrollInProgress
```
 Boolean getIsScrollInProgress()
```

getCanScrollBackward
```
 Boolean getCanScrollBackward()
```

getCanScrollForward
```
 Boolean getCanScrollForward()
```

getLastScrolledBackward
```
 Boolean getLastScrolledBackward()
```

getLastScrolledForward
```
 Boolean getLastScrolledForward()
```

animateScrollToPage

 final Unit animateScrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = 0.0.toDouble(), to = 1.0.toDouble()) Float pageOffset, AnimationSpec<Float> animationSpec, Float initialVelocity, Boolean skipPages)

animateScrollToPage
```
 final Unit animateScrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = -1.0.toDouble(), to = 1.0.toDouble()) Float pageOffset)
```
Animate (smooth scroll) to the given page to the middle of the viewport.
Cancels the currently running scroll, if any, and suspends until the cancellation is complete.

Parameters:

page - the page to animate to.

pageOffset - the percentage of the page size to offset, from the start of page.

scrollToPage
```
 final Unit scrollToPage(@IntRange(from = 0.toLong()) Integer page, @FloatRange(from = -1.0.toDouble(), to = 1.0.toDouble()) Float pageOffset)
```
Instantly brings the item at page to the middle of the viewport.
Cancels the currently running scroll, if any, and suspends until the cancellation is complete.

Parameters:

page - the page to snap to.

pageOffset - the percentage of the page size to offset, from the start of page.

scroll

 Unit scroll(MutatePriority scrollPriority, SuspendFunction1<ScrollScope, Unit> block)

dispatchRawDelta
```
 Float dispatchRawDelta(Float delta)
```

toString
```
 String toString()
```

Class PagerState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PagerState

Method Detail

getInteractionSource

getPageCount

getCurrentPage

setCurrentPage

getCurrentPageOffset

getTargetPage

getIsScrollInProgress

getCanScrollBackward

getCanScrollForward

getLastScrolledBackward

getLastScrolledForward

animateScrollToPage

animateScrollToPage

scrollToPage

scroll

dispatchRawDelta

toString