Function

animateScrollBy

Scroll by value pixels with animation.

RevenueCat

RevenueCat

Add subscriptions to your apps in minutes

Ad Get started for free

animateScrollBy

Common
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

animateScrollBy

Common
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