FloatingToolbarScrollBehavior

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha25

Common/AllAndroid/JVM

• Cmn

  sealed interface FloatingToolbarScrollBehavior : NestedScrollConnection

---

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

See also
exitAlwaysScrollBehavior

Summary

Public functions
open Modifier	Modifier.floatingScrollBehavior() This function is deprecated. Use floatingScrollBehaviorModifier instead.	Cmn

Public properties
FloatingToolbarExitDirection	exitDirection Indicates the direction towards which the floating toolbar exits the screen.	Cmn
DecayAnimationSpec<Float>	flingAnimationSpec An DecayAnimationSpec that defines how to fling the floating toolbar when the user flings the toolbar itself, or the content below it.	Cmn
Modifier	floatingScrollBehaviorModifier A Modifier that is attached to this behavior.	Cmn
AnimationSpec<Float>	snapAnimationSpec 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.	Cmn
FloatingToolbarState	state A FloatingToolbarState that is attached to this behavior and is read and updated when scrolling happens.	Cmn

Inherited functions

From androidx.compose.ui.input.nestedscroll.NestedScrollConnection open suspend Velocity onPostFling(consumed: Velocity, available: Velocity) Post fling event chain. Cmn open Offset onPostScroll(     consumed: Offset,     available: Offset,     source: NestedScrollSource ) Post scroll event pass. Cmn open suspend Velocity onPreFling(available: Velocity) Pre fling event chain. Cmn open Offset onPreScroll(available: Offset, source: NestedScrollSource) Pre scroll event chain. Cmn

Public functions

Modifier.floatingScrollBehavior

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha25

Deprecated in 1.5.0-alpha25

open fun Modifier.floatingScrollBehavior(): Modifier

This function is deprecated.
Use floatingScrollBehaviorModifier instead.

A Modifier that is attached to this behavior.

Public properties

exitDirection

Cmn

val exitDirection: FloatingToolbarExitDirection

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

flingAnimationSpec

Cmn

Added in 1.5.0-alpha25

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

Cmn

Added in 1.5.0-alpha25

val floatingScrollBehaviorModifier: Modifier

A Modifier that is attached to this behavior.

snapAnimationSpec

Cmn

Added in 1.5.0-alpha25

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.

state

Cmn

Added in 1.5.0-alpha25

val state: FloatingToolbarState

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