Object

WideNavigationRailDefaults

Defaults used in WideNavigationRail.

Source set: Common
public object WideNavigationRailDefaults

Defaults used in WideNavigationRail.

Properties

shape

Source set: Common
public val shape: Shape

Default container shape of a wide navigation rail.

arrangement

Source set: Common
public val arrangement: Arrangement.Vertical

Default arrangement for a wide navigation rail.

windowInsets

Source set: Common
public val windowInsets: WindowInsets

Default window insets for a wide navigation rail.

modalCollapsedShape

Source set: Common
public val modalCollapsedShape: Shape

Default container shape of a collapsed ModalWideNavigationRail.

modalExpandedShape

Source set: Common
public val modalExpandedShape: Shape

Default container shape of a expanded ModalWideNavigationRail.

ModalExpandedProperties

Source set: Common
public val ModalExpandedProperties: ModalWideNavigationRailProperties =
        createDefaultModalWideNavigationRailProperties()

Properties used to customize the window behavior of a ModalWideNavigationRail.

ContentPadding

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

The default content padding used for WideNavigationRail and ModalWideNavigationRail.

Functions

colors

Source set: Common
@Composable
    public fun colors(): WideNavigationRailColors

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

colors

Source set: Common
@Composable
    public 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
Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: