rememberTopAppBarState

Composable Function

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

Creates a TopAppBarState that is remembered across compositions.

Parameters

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