Compose Multiplatform Material3/androidx.compose.material3/BottomAppBarState

BottomAppBarState

A state object that can be hoisted to control and observe the bottom app bar state. The state is read and updated by a BottomAppBarScrollBehavior implementation.

In most cases, this state will be created via rememberBottomAppBarState.

Types

Companion

object Companion

Properties

collapsedFraction

abstract val collapsedFraction: Float

A value that represents the collapsed height percentage of the app bar.

contentOffset

abstract var contentOffset: Float

The total offset of the content scrolled under the bottom app bar.

heightOffset

abstract var heightOffset: Float

The bottom app bar's current height offset in pixels. This height offset is applied to the fixed height of the app bar to control the displayed height when content is being scrolled.

heightOffsetLimit

abstract var heightOffsetLimit: Float

The bottom app bar's height offset limit in pixels, which represents the limit that a bottom app bar is allowed to collapse to.