TopAppBarScrollBehavior

Artifact: androidx.compose.material3:material3

Added in 1.0.0

Cmn
```
interface TopAppBarScrollBehavior
```

A TopAppBarScrollBehavior defines how an app bar should behave when the content under it is scrolled.

See also
`pinnedScrollBehavior`
`enterAlwaysScrollBehavior`
`exitUntilCollapsedScrollBehavior`

Summary

Public properties
`DecayAnimationSpec<Float>?`	`flingAnimationSpec` An optional `DecayAnimationSpec` that defines how to fling the top app bar when the user flings the app bar itself, or the scrollable content.	Cmn
`Boolean`	`isPinned` Indicates whether the top app bar is pinned.	Cmn
`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.	Cmn
`AnimationSpec<Float>?`	`snapAnimationSpec` 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.	Cmn
`TopAppBarState`	`state` A `TopAppBarState` that is attached to this behavior and is read and updated when scrolling happens.	Cmn

Public properties

flingAnimationSpec

Cmn

Added in 1.0.0

val flingAnimationSpec: DecayAnimationSpec<Float>?

An optional DecayAnimationSpec that defines how to fling the top app bar when the user flings the app bar itself, or the scrollable content. If null is provided, the app bar will not continue to animate its height based on the scroll velocity.

isPinned

Cmn

Added in 1.0.0

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

Cmn

Added in 1.0.0

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.

snapAnimationSpec

Cmn

Added in 1.0.0

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. If null is provided, the app bar will not snap and will remain in its current state.

state

Cmn

Added in 1.0.0

val state: TopAppBarState

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