ModalWideNavigationRailOverrideScope


Parameters available to ModalWideNavigationRail.

Summary

Public properties

Arrangement.Vertical

the Arrangement.Vertical of this wide navigation rail

Cmn
Shape

the shape of this wide navigation rail's container when it's collapsed

Cmn
WideNavigationRailColors

WideNavigationRailColors that will be used to resolve the colors used for this wide navigation rail.

Cmn
@Composable () -> Unit

the content of this modal wide navigation rail, usually WideNavigationRailItems

Cmn
Dp

the padding to be applied to the top of the rail.

Cmn
ModalWideNavigationRailProperties

ModalWideNavigationRailProperties for further customization of the expanded modal wide navigation rail's window behavior

Cmn
Shape

the shape of this wide navigation rail's container when it's expanded

Cmn
(@Composable () -> Unit)?

optional header that may hold a FloatingActionButton or a logo

Cmn
Modifier

the Modifier to be applied to this wide navigation rail

Cmn
Boolean

whether this wide navigation rail should slide offscreen when it collapses and be hidden, or stay on screen as a collapsed wide navigation rail (default)

Cmn
WideNavigationRailState

the WideNavigationRailState of this wide navigation rail

Cmn
WindowInsets

a window insets of the wide navigation rail

Cmn

Public properties

arrangement

val arrangementArrangement.Vertical

the Arrangement.Vertical of this wide navigation rail

collapsedShape

val collapsedShapeShape

the shape of this wide navigation rail's container when it's collapsed

colors

val colorsWideNavigationRailColors

WideNavigationRailColors that will be used to resolve the colors used for this wide navigation rail. See WideNavigationRailDefaults.colors

content

val content: @Composable () -> Unit

the content of this modal wide navigation rail, usually WideNavigationRailItems

expandedHeaderTopPadding

val expandedHeaderTopPaddingDp

the padding to be applied to the top of the rail. It's usually needed in order to align the content of the rail between the collapsed and expanded animation

expandedProperties

val expandedPropertiesModalWideNavigationRailProperties

ModalWideNavigationRailProperties for further customization of the expanded modal wide navigation rail's window behavior

expandedShape

val expandedShapeShape

the shape of this wide navigation rail's container when it's expanded

header

val header: (@Composable () -> Unit)?

optional header that may hold a FloatingActionButton or a logo

modifier

val modifierModifier

the Modifier to be applied to this wide navigation rail

shouldHideOnCollapse

val shouldHideOnCollapseBoolean

whether this wide navigation rail should slide offscreen when it collapses and be hidden, or stay on screen as a collapsed wide navigation rail (default)

state

val stateWideNavigationRailState

the WideNavigationRailState of this wide navigation rail

windowInsets

val windowInsetsWindowInsets

a window insets of the wide navigation rail