Interface

FloatingToolbarScrollBehavior

A FloatingToolbarScrollBehavior defines how a floating toolbar should behave when the content under it is scrolled.

Source set: Common

Added in 1.5.0-alpha17

@ExperimentalMaterial3ExpressiveApi
sealed interface FloatingToolbarScrollBehavior : NestedScrollConnection

A FloatingToolbarScrollBehavior defines how a floating toolbar should behave when the content under it is scrolled.

Properties

exitDirection

Source set: Common

Added in 1.5.0-alpha17

val exitDirection: FloatingToolbarExitDirection

Indicates the direction towards which the floating toolbar exits the screen.

state

Source set: Common

Added in 1.5.0-alpha17

val state: FloatingToolbarState

A FloatingToolbarState that is attached to this behavior and is read and updated when scrolling happens.

snapAnimationSpec

Source set: Common

Added in 1.5.0-alpha17

val snapAnimationSpec: AnimationSpec<Float>

An AnimationSpec that defines how the floating toolbar snaps to either fully collapsed or fully extended state when a fling or a drag scrolled it into an intermediate position.

flingAnimationSpec

Source set: Common

Added in 1.5.0-alpha17

val flingAnimationSpec: DecayAnimationSpec<Float>

An DecayAnimationSpec that defines how to fling the floating toolbar when the user flings the toolbar itself, or the content below it.

Functions

floatingScrollBehavior

Added in 1.5.0-alpha17

fun Modifier.floatingScrollBehavior(): Modifier

A Modifier that is attached to this behavior.