TopAppBarScrollBehavior
-
Cmn
@ExperimentalMaterial3Api
interface TopAppBarScrollBehavior
A TopAppBarScrollBehavior defines how an app bar should behave when the content under it is scrolled.
Summary
Public properties |
||
|---|---|---|
DecayAnimationSpec<Float>? |
An optional |
Cmn
|
Boolean |
Indicates whether the top app bar is pinned. |
Cmn
|
NestedScrollConnection |
A |
Cmn
|
AnimationSpec<Float>? |
An optional |
Cmn
|
TopAppBarState |
A |
Cmn
|
Public properties
flingAnimationSpec
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.
isPinned
val isPinned: Boolean
Indicates whether the top 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.
nestedScrollConnection
val nestedScrollConnection: NestedScrollConnection
A NestedScrollConnection that should be attached to a Modifier.nestedScroll in order to keep track of the scroll events.
snapAnimationSpec
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.
state
val state: TopAppBarState
A TopAppBarState that is attached to this behavior and is read and updated when scrolling happens.