Object

WideNavigationRailDefaults

Defaults used in WideNavigationRail.

Source set: Common
object WideNavigationRailDefaults

Defaults used in WideNavigationRail.

Properties

shape

Source set: Common
val shape: Shape

Default container shape of a wide navigation rail.

arrangement

Source set: Common
val arrangement: Arrangement.Vertical

Default arrangement for a wide navigation rail.

windowInsets

Source set: Common
val windowInsets: WindowInsets

Default window insets for a wide navigation rail.

modalCollapsedShape

Source set: Common
val modalCollapsedShape: Shape

Default container shape of a collapsed ModalWideNavigationRail.

modalExpandedShape

Source set: Common
val modalExpandedShape: Shape

Default container shape of a expanded ModalWideNavigationRail.

ModalExpandedProperties

Source set: Common
val ModalExpandedProperties: ModalWideNavigationRailProperties

Properties used to customize the window behavior of a ModalWideNavigationRail.

ContentPadding

Source set: Common
val ContentPadding =
    PaddingValues(
        start = 0.dp,
        top = WNRVerticalPadding,
        end = 0.dp,
        bottom = WNRVerticalPadding,
    )

The default content padding used for WideNavigationRail and ModalWideNavigationRail.

containerShape

Deprecated

Deprecated in favor of shape.

Source set: Common
@ExperimentalMaterial3ExpressiveApi
val containerShape: Shape

Default container shape of a wide navigation rail.

modalContainerShape

Deprecated

Deprecated in favor of modalExpandedShape.

Source set: Common
@ExperimentalMaterial3ExpressiveApi

val modalContainerShape: Shape

Default container shape of a modal wide navigation rail.

Functions

colors

@Composable fun colors() = MaterialTheme.colorScheme.defaultWideWideNavigationRailColors

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 the color used for the background of a non-modal wide navigation rail.
contentColor 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 the color used for the background of a modal wide navigation rail.
modalScrimColor the color used for the scrim overlay for background content of a modal wide navigation rail
modalContentColor 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

colors

@ExperimentalMaterial3ExpressiveApi
    @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 the color used for the background of a non-modal wide navigation rail.
contentColor 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 the color used for the background of a modal wide navigation rail.
modalScrimColor the color used for the scrim overlay for background content of a modal wide navigation rail

Last updated: