Interface

BottomAppBarScrollBehavior

A BottomAppBarScrollBehavior defines how a bottom app bar should behave when the content under it is scrolled.

Source set: Common

Added in 1.5.0-alpha17

@ExperimentalMaterial3Api
interface BottomAppBarScrollBehavior

A BottomAppBarScrollBehavior defines how a bottom app bar should behave when the content under it is scrolled.

Properties

state

Source set: Common

Added in 1.5.0-alpha17

val state: BottomAppBarState

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

isPinned

Source set: Common

Added in 1.5.0-alpha17

val isPinned: Boolean

Indicates whether the bottom app bar is pinned.

A pinned app bar will stay fixed in place when content is scrolled and will not react to any drag gestures.

snapAnimationSpec

Source set: Common

Added in 1.5.0-alpha17

val snapAnimationSpec: AnimationSpec<Float>?

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

Source set: Common

Added in 1.5.0-alpha17

val flingAnimationSpec: DecayAnimationSpec<Float>?

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.

nestedScrollConnection

Source set: Common

Added in 1.5.0-alpha17

val nestedScrollConnection: NestedScrollConnection

A NestedScrollConnection that should be attached to a androidx.compose.ui.input.nestedscroll.nestedScroll in order to keep track of the scroll events.