NavigationSuiteScaffoldState

interface NavigationSuiteScaffoldState

A state object that can be hoisted to observe the navigation suite scaffold state. It allows for setting its navigation component to be hidden or displayed.

Properties

val isAnimating: Boolean

Whether the state is currently animating.

val targetValue: NavigationSuiteScaffoldValue

Whether the navigation component is going to be shown or hidden.

val currentValue: NavigationSuiteScaffoldValue

Whether the navigation component is currently shown or hidden.

Functions

hide

suspend fun hide()

Hide the navigation component with animation and suspend until it fully expands.

show

suspend fun show()

Show the navigation component with animation and suspend until it fully expands.

toggle

suspend fun toggle()

Hide the navigation component with animation if it's shown, or collapse it otherwise, and suspend until it fully expands.

snapTo

suspend fun snapTo(targetValue: NavigationSuiteScaffoldValue)

Set the state without any animation and suspend until it's set.

Parameters