miuix-ui/top.yukonga.miuix.kmp.basic/NavigationRailState

NavigationRailState

class NavigationRailState(initialValue: NavigationRailValue = NavigationRailValue.Collapsed)

A state holder that controls whether a NavigationRail is collapsed or expanded.

Create it with rememberNavigationRailState and pass it to NavigationRail to make the rail expandable. The width and item-layout transitions are driven declaratively by the rail from currentValue, so mutating the state via expand, collapse or toggle is enough to animate.

Parameters

initialValue

The initial NavigationRailValue.

Constructors

NavigationRailState

constructor(initialValue: NavigationRailValue = NavigationRailValue.Collapsed)

Types

object Companion

Properties

var currentValue: NavigationRailValue

The current expansion value.

val isExpanded: Boolean

Whether the rail is currently expanded.

Functions

Collapses the rail.

fun expand()

Expands the rail.

fun toggle()

Toggles the rail between collapsed and expanded.