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.

Properties

Whether the rail is currently expanded or not.

Whether the state is currently animating

Whether the rail is going to be expanded or not.

abstract suspend fun collapse()

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

abstract suspend fun expand()

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

abstract suspend fun snapTo(targetValue: WideNavigationRailValue)

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

abstract suspend fun 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.