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.

See also
rememberNavigationSuiteScaffoldState

to construct the default implementation.

Summary

Public functions
suspend Unit

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

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

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

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

Public properties
NavigationSuiteScaffoldValue

Whether the navigation component is currently shown or hidden.
Boolean

Whether the state is currently animating.
NavigationSuiteScaffoldValue

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

Public functions

hide

suspend fun hide(): Unit

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

show

suspend fun show(): Unit

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

snapTo

suspend fun snapTo(targetValue: NavigationSuiteScaffoldValue): Unit

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

Parameters
targetValue: NavigationSuiteScaffoldValue

the value to set to

toggle

suspend fun toggle(): Unit

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

Public properties

currentValue

val currentValue: NavigationSuiteScaffoldValue

Whether the navigation component is currently shown or hidden.

isAnimating

val isAnimating: Boolean

Whether the state is currently animating.

targetValue

val targetValue: NavigationSuiteScaffoldValue

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