FloatingToolbarScrollBehavior

public sealed interface FloatingToolbarScrollBehavior : NestedScrollConnection

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

Properties

exitDirection

public val exitDirection: FloatingToolbarExitDirection

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

state

public val state: FloatingToolbarState

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

snapAnimationSpec

public 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

public 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.

floatingScrollBehaviorModifier

public val floatingScrollBehaviorModifier: Modifier

A Modifier that is attached to this behavior.

Functions

floatingScrollBehavior

@Deprecated(
        message = "Use floatingScrollBehaviorModifier instead.",
        replaceWith = ReplaceWith("this.then(floatingScrollBehaviorModifier)"),
    )
    public fun Modifier.floatingScrollBehavior(): Modifier

A Modifier that is attached to this behavior.