ui/kiwi.orbit.compose.ui.controls/TopAppBarScrollBehavior

TopAppBarScrollBehavior

@Stable
interface TopAppBarScrollBehavior

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val flingAnimationSpec: DecayAnimationSpec<Float>?

An optional DecayAnimationSpec that defined how to fling the top app bar when the user flings the app bar itself, or the content below it.

Link copied to clipboard
abstract val isPinned: Boolean

Indicates whether the top app bar is pinned.

Link copied to clipboard
abstract val nestedScrollConnection: NestedScrollConnection

A NestedScrollConnection that should be attached to a Modifier.nestedScroll in order to keep track of the scroll events.

Link copied to clipboard
abstract val snapAnimationSpec: AnimationSpec<Float>?

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

Link copied to clipboard
abstract val state: TopAppBarState

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