rememberBottomAppBarState

Composable Function

Common
@ExperimentalMaterial3Api
@Composable
fun rememberBottomAppBarState(
    initialHeightOffsetLimit: Float = -Float.MAX_VALUE,
    initialHeightOffset: Float = 0f,
    initialContentOffset: Float = 0f,
): BottomAppBarState

Creates a BottomAppBarState that is remembered across compositions.

Parameters

initialHeightOffsetLimitthe initial value for BottomAppBarState.heightOffsetLimit, which represents the pixel limit that a bottom app bar is allowed to collapse when the scrollable content is scrolled
initialHeightOffsetthe initial value for BottomAppBarState.heightOffset. The initial offset height offset should be between zero and initialHeightOffsetLimit.
initialContentOffsetthe initial value for BottomAppBarState.contentOffset