WideNavigationRailDefaults


Defaults used in WideNavigationRail.

Summary

Public functions

WideNavigationRailColors

Creates a WideNavigationRailColors with the provided colors according to the Material specification.

Cmn
WideNavigationRailColors
@Composable
colors(
    containerColor: Color,
    contentColor: Color,
    modalContainerColor: Color,
    modalScrimColor: Color,
    modalContentColor: Color
)

Creates a WideNavigationRailColors with the provided colors according to the Material specification.

Cmn

Public properties

PaddingValues

The default content padding used for WideNavigationRail and ModalWideNavigationRail.

Cmn
ModalWideNavigationRailProperties

Properties used to customize the window behavior of a ModalWideNavigationRail.

Cmn
Arrangement.Vertical

Default arrangement for a wide navigation rail.

Cmn
Shape

This property is deprecated. Deprecated in favor of shape.

Cmn
Shape

Default container shape of a collapsed ModalWideNavigationRail.

Cmn
Shape

This property is deprecated. Deprecated in favor of modalExpandedShape.

Cmn
Shape

Default container shape of a expanded ModalWideNavigationRail.

Cmn
Shape

Default container shape of a wide navigation rail.

Cmn
WindowInsets

Default window insets for a wide navigation rail.

Cmn

Public functions

colors

@Composable
fun colors(): WideNavigationRailColors

Creates a WideNavigationRailColors with the provided colors according to the Material specification.

colors

@Composable
fun colors(
    containerColor: Color = WideNavigationRailDefaults.containerColor,
    contentColor: Color = contentColorFor(containerColor),
    modalContainerColor: Color = NavigationRailExpandedTokens.ModalContainerColor.value,
    modalScrimColor: Color = ScrimTokens.ContainerColor.value.copy(ScrimTokens.ContainerOpacity),
    modalContentColor: Color = contentColorFor(modalContainerColor)
): WideNavigationRailColors

Creates a WideNavigationRailColors with the provided colors according to the Material specification.

Parameters
containerColor: Color = WideNavigationRailDefaults.containerColor

the color used for the background of a non-modal wide navigation rail.

contentColor: Color = contentColorFor(containerColor)

the preferred color for content inside a wide navigation rail. Defaults to either the matching content color for containerColor, or to the current LocalContentColor if containerColor is not a color from the theme

modalContainerColor: Color = NavigationRailExpandedTokens.ModalContainerColor.value

the color used for the background of a modal wide navigation rail.

modalScrimColor: Color = ScrimTokens.ContainerColor.value.copy(ScrimTokens.ContainerOpacity)

the color used for the scrim overlay for background content of a modal wide navigation rail

modalContentColor: Color = contentColorFor(modalContainerColor)

the preferred color for content inside a modal wide navigation rail. Defaults to either the matching content color for modalContainerColor, or to the current LocalContentColor if modalContainerColor is not a color from the theme

Public properties

ContentPadding

val ContentPaddingPaddingValues

The default content padding used for WideNavigationRail and ModalWideNavigationRail.

ModalExpandedProperties

val ModalExpandedPropertiesModalWideNavigationRailProperties

Properties used to customize the window behavior of a ModalWideNavigationRail.

arrangement

val arrangementArrangement.Vertical

Default arrangement for a wide navigation rail.

containerShape

@ExperimentalMaterial3ExpressiveApi
val containerShapeShape

Default container shape of a wide navigation rail.

modalCollapsedShape

val modalCollapsedShapeShape

Default container shape of a collapsed ModalWideNavigationRail.

modalContainerShape

@ExperimentalMaterial3ExpressiveApi
val modalContainerShapeShape

Default container shape of a modal wide navigation rail.

modalExpandedShape

val modalExpandedShapeShape

Default container shape of a expanded ModalWideNavigationRail.

shape

val shapeShape

Default container shape of a wide navigation rail.

windowInsets

val windowInsetsWindowInsets

Default window insets for a wide navigation rail.