Class
Common
```kotlin
class ScrollState(initial: Int) : ScrollableState
```
State of the scroll. Allows the developer to change the scroll position or get current state by
calling methods on this object. To be hosted and passed to `Modifier.verticalScroll` or
`Modifier.horizontalScroll`
To create and automatically remember `ScrollState` with default parameters use
`rememberScrollState`.
Learn how to control the state of `Modifier.verticalScroll` or `Modifier.horizontalScroll`:
#### Parameters
| | |
| --- | --- |
| initial | value of the scroll |
## Properties
Common
```kotlin
@get:FrequentlyChangingValue
var value: Int
```
current scroll position value in pixels
Common
```kotlin
var maxValue: Int
```
maximum bound for `value`, or `Int.MAX_VALUE` if still unknown
Common
```kotlin
var viewportSize: Int
```
Size of the viewport on the scrollable axis, or 0 if still unknown. Note that this value is
only populated after the first measure pass.
Common
```kotlin
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 smooth scroll) is in progress, use
`isScrollInProgress`.
## Functions
```kotlin
suspend fun animateScrollTo(value: Int, animationSpec: AnimationSpec = SpringSpec())
```
Scroll to position in pixels with animation.
#### Parameters
| | |
| --- | --- |
| value | target value in pixels to smooth scroll to, value will be coerced to 0..maxPosition |
| animationSpec | animation curve for smooth scroll animation |
```kotlin
suspend fun scrollTo(value: Int): Float
```
Instantly jump to the given position in pixels.
Cancels the currently running scroll, if any, and suspends until the cancellation is
complete.
#### Parameters
| | |
| --- | --- |
| value | number of pixels to scroll by |
#### Returns
| | |
| --- | --- |
| | the amount of scroll consumed |
## Companion Object
#### Properties
Common
```kotlin
val Saver: Saver
```
The default `Saver` implementation for `ScrollState`.