NavigationSuiteScaffoldState

public 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

isAnimating

public val isAnimating: Boolean

Whether the state is currently animating.

targetValue

public val targetValue: NavigationSuiteScaffoldValue

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

currentValue

public val currentValue: NavigationSuiteScaffoldValue

Whether the navigation component is currently shown or hidden.

Functions

hide

public suspend fun hide()

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

show

public suspend fun show()

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

toggle

public suspend fun toggle()

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

snapTo

public suspend fun snapTo(targetValue: NavigationSuiteScaffoldValue)

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

Parameters