Compose Multiplatform Material3/androidx.compose.material3/TopAppBarDefaults/pinnedScrollBehavior

pinnedScrollBehavior

@Composable
fun pinnedScrollBehavior(state: TopAppBarState = rememberTopAppBarState(), canScroll: () -> Boolean = { true }): TopAppBarScrollBehavior

Returns a pinned TopAppBarScrollBehavior that tracks nested-scroll callbacks and updates its TopAppBarState.contentOffset accordingly.

Parameters

state

the state object to be used to control or observe the top app bar's scroll state. See rememberTopAppBarState for a state that is remembered across compositions.

canScroll

a callback used to determine whether scroll events are to be handled by this pinned TopAppBarScrollBehavior