WideNavigationRailState

public 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

public val isAnimating: Boolean

Whether the state is currently animating

targetValue

public val targetValue: WideNavigationRailValue

Whether the rail is going to be expanded or not.

currentValue

public val currentValue: WideNavigationRailValue

Whether the rail is currently expanded or not.

Functions

expand

public suspend fun expand()

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

collapse

public suspend fun collapse()

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

toggle

public 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

public suspend fun snapTo(targetValue: WideNavigationRailValue)

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

Parameters