overScrollOutOfBound

fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { true }): Modifier

Overscroll effect when scrolling to the boundary.

The effect engages only during a press or pan gesture session (touch drag; trackpad pan on Android). Mouse wheel and keyboard scrolling pass through untouched, as does desktop/macOS trackpad scrolling (delivered as wheel events).

Parameters

isVertical

Whether the overscroll effect is vertical or horizontal.

nestedScrollToParent

Whether to dispatch nested scroll events to parent. Pass-through deltas (non-gesture sources such as mouse wheel, and while pull-to-refresh is active) are forwarded to ancestors regardless of this flag.

isEnabled

Whether the overscroll effect is enabled.