---
title: "animateScrollBy"
description: "Scroll by [value] pixels with animation.

Cancels the currently running scroll, if any, and suspends until the cancellation is complete."
type: "function"
---

<div class='type'>Function</div>


<a id='references'></a>
<div class='sourceset sourceset-common'>Common</div>


```kotlin
suspend fun ScrollableState.animateScrollBy(
    value: Float,
    animationSpec: AnimationSpec<Float> = spring(),
): Float
```


Scroll by `value` pixels with animation.

Cancels the currently running scroll, if any, and suspends until the cancellation is complete.

#### Parameters

| | |
| --- | --- |
| value | number of pixels to scroll by |
| animationSpec | `AnimationSpec` to be used for this scrolling |


#### Returns

| | |
| --- | --- |
|  | the amount of scroll consumed |




<div class='sourceset sourceset-common'>Common</div>


```kotlin
suspend fun Scrollable2DState.animateScrollBy(
    value: Offset,
    animationSpec: AnimationSpec<Offset> = spring(),
): Offset
```


Scroll by `value` pixels with animation.

Cancels the currently running scroll, if any, and suspends until the cancellation is complete.

#### Parameters

| | |
| --- | --- |
| value | number of pixels to scroll by |
| animationSpec | `AnimationSpec` to be used for this scrolling |


#### Returns

| | |
| --- | --- |
|  | the amount of scroll consumed |