Common
```kotlin
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
Common
```kotlin
val isAnimating: Boolean
```
Whether the state is currently animating.
Common
```kotlin
val targetValue: NavigationSuiteScaffoldValue
```
Whether the navigation component is going to be shown or hidden.
Common
```kotlin
val currentValue: NavigationSuiteScaffoldValue
```
Whether the navigation component is currently shown or hidden.
## Functions
hide
```kotlin
suspend fun hide()
```
Hide the navigation component with animation and suspend until it fully expands.
show
```kotlin
suspend fun show()
```
Show the navigation component with animation and suspend until it fully expands.
toggle
```kotlin
suspend fun toggle()
```
Hide the navigation component with animation if it's shown, or collapse it otherwise, and
suspend until it fully expands.
snapTo
```kotlin
suspend fun snapTo(targetValue: NavigationSuiteScaffoldValue)
```
Set the state without any animation and suspend until it's set.
#### Parameters
| | |
| --- | --- |
| targetValue | the value to set to |