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.
| See also | |
|---|---|
rememberNavigationSuiteScaffoldState |
to construct the default implementation. |
Summary
Public functions |
|
|---|---|
suspend Unit |
hide()Hide the navigation component with animation and suspend until it fully expands. |
suspend Unit |
show()Show the navigation component with animation and suspend until it fully expands. |
suspend Unit |
snapTo(targetValue: NavigationSuiteScaffoldValue)Set the state without any animation and suspend until it's set. |
suspend Unit |
toggle()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 |
Public properties
currentValue
val currentValue: NavigationSuiteScaffoldValue
Whether the navigation component is currently shown or hidden.
targetValue
val targetValue: NavigationSuiteScaffoldValue
Whether the navigation component is going to be shown or hidden.