WideNavigationRailState

Cmn

@ExperimentalMaterial3ExpressiveApi
interface WideNavigationRailState

A state object that can be hoisted to observe the wide navigation rail state. It allows for setting to the rail to be collapsed or expanded.

See also
`rememberWideNavigationRailState`	to construct the default implementation.

Summary

Public functions
`suspend Unit`	`collapse()` Collapse the rail with animation and suspend until it fully collapses.	Cmn
`suspend Unit`	`expand()` Expand the rail with animation and suspend until it fully expands.	Cmn
`suspend Unit`	`snapTo(targetValue: WideNavigationRailValue)` Set the state without any animation and suspend until it's set.	Cmn
`suspend Unit`	`toggle()` Collapse the rail with animation if it's expanded, or expand it if it's collapsed, and suspend until it's set to its new state.	Cmn

Public properties
`WideNavigationRailValue`	`currentValue` Whether the rail is currently expanded or not.	Cmn
`Boolean`	`isAnimating` Whether the state is currently animating	Cmn
`WideNavigationRailValue`	`targetValue` Whether the rail is going to be expanded or not.	Cmn

Cmn

suspend fun collapse(): Unit

Collapse the rail with animation and suspend until it fully collapses.

Cmn

suspend fun expand(): Unit

Expand the rail with animation and suspend until it fully expands.

Cmn

suspend fun snapTo(targetValue: WideNavigationRailValue): Unit

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

Parameters
`targetValue: WideNavigationRailValue`	the expanded boolean to set to

Cmn

suspend fun toggle(): Unit

Collapse the rail with animation if it's expanded, or expand it if it's collapsed, and suspend until it's set to its new state.

Cmn

val currentValue: WideNavigationRailValue

Whether the rail is currently expanded or not.

Cmn

val isAnimating: Boolean

Whether the state is currently animating

Cmn

val targetValue: WideNavigationRailValue

Whether the rail is going to be expanded or not.