WideNavigationRailState

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.

Properties

isAnimating

val isAnimating: Boolean

Whether the state is currently animating

targetValue

val targetValue: WideNavigationRailValue

Whether the rail is going to be expanded or not.

currentValue

val currentValue: WideNavigationRailValue

Whether the rail is currently expanded or not.

Functions

expand

suspend fun expand()

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

collapse

suspend fun collapse()

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

toggle

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.

snapTo

suspend fun snapTo(targetValue: WideNavigationRailValue)

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

Parameters