Compose Multiplatform Material3/androidx.compose.material3/BottomAppBarDefaults/exitAlwaysScrollBehavior

exitAlwaysScrollBehavior

@Composable
fun exitAlwaysScrollBehavior(state: BottomAppBarState = rememberBottomAppBarState(), canScroll: () -> Boolean = { true }, snapAnimationSpec: AnimationSpec<Float>? = spring(stiffness = Spring.StiffnessMediumLow), flingAnimationSpec: DecayAnimationSpec<Float>? = rememberSplineBasedDecay()): BottomAppBarScrollBehavior

Returns a BottomAppBarScrollBehavior. A bottom app bar that is set up with this BottomAppBarScrollBehavior will immediately collapse when the content is pulled up, and will immediately appear when the content is pulled down.

Parameters

state

the state object to be used to control or observe the bottom app bar's scroll state. See rememberBottomAppBarState for a state that is remembered across compositions.

canScroll

a callback used to determine whether scroll events are to be handled by this ExitAlwaysScrollBehavior

snapAnimationSpec

an optional AnimationSpec that defines how the bottom app bar snaps to either fully collapsed or fully extended state when a fling or a drag scrolled it into an intermediate position

flingAnimationSpec

an optional DecayAnimationSpec that defined how to fling the bottom app bar when the user flings the app bar itself, or the content below it