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
)

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

Cmn

Public properties

WideNavigationRailArrangement

Default arrangement for a wide navigation rail.

Cmn
Shape

Default container shape of a wide navigation rail.

Cmn
Shape

Default container shape of a modal 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)
): 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

Public properties

Arrangement

val ArrangementWideNavigationRailArrangement

Default arrangement for a wide navigation rail.

containerShape

val containerShapeShape

Default container shape of a wide navigation rail.

modalContainerShape

val modalContainerShapeShape

Default container shape of a modal wide navigation rail.

windowInsets

val windowInsetsWindowInsets

Default window insets for a wide navigation rail.