SpatialScrollBehavior

@Stable

class SpatialScrollBehavior(springParams: SpatialSpringParams = SpatialSpringParams(), flingParams: SpatialFlingParams = SpatialFlingParams(), scope: CoroutineScope) : FlingBehavior, OverscrollEffect

A custom FlingBehavior and OverscrollEffect implementation that simulates a spring-like behavior when scrolling past the boundaries of the content.

This implementation separates the physics engine from the platform defaults, allowing for customizable fling decay and spring back animations.

Constructors

constructor(springParams: SpatialSpringParams = SpatialSpringParams(), flingParams: SpatialFlingParams = SpatialFlingParams(), scope: CoroutineScope)

Remaining vertical velocity captured when fling reaches a scroll boundary.

Remaining horizontal velocity captured when fling reaches a scroll boundary.

Maximum vertical overscroll offset recorded during the latest interaction.

Maximum horizontal overscroll offset recorded during the latest interaction.

Vertical fling velocity received when the latest fling was released.

Horizontal fling velocity received when the latest fling was released.

Whether the latest vertical fling direction was downward.

open override val isInProgress: Boolean

Whether the latest horizontal fling direction was rightward.

open override val node: DelegatableNode

open suspend override fun applyToFling(velocity: Velocity, performFling: suspend (Velocity) -> Velocity)

open override fun applyToScroll(delta: Offset, source: NestedScrollSource, performScroll: (Offset) -> Offset): Offset

open suspend override fun ScrollScope.performFling(initialVelocity: Float): Float