over
fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> Float?, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
OverScroll effect for scrollable Composable.
form https://github.com/Cormor/ComposeOverscroll
Author
: cormor
Parameters
is
is vertical, or horizontal?
nested
Whether to dispatch nested scroll events to parent.
scroll
u can refer to DefaultParabolaScrollEasing, The incoming values are the currently existing overscroll Offset and the new offset from the gesture. modify it to cooperate with springStiff to customize the sliding damping effect. The current default easing comes from iOS, you don't need to modify it!
spring
springStiff for overscroll effect，For better user experience, the new value is not recommended to be higher thanStiffnessMediumLow
spring
springDamp for overscroll effect，generally do not need to set.
is
Whether to enable the overscroll effect, default is enabled on Android and iOS.