Contains the default values used by the NavigationSuite.

Summary

Public functions

NavigationSuiteColors
@Composable
colors(
    navigationBarContainerColor: Color,
    navigationBarContentColor: Color,
    navigationRailContainerColor: Color,
    navigationRailContentColor: Color,
    navigationDrawerContainerColor: Color,
    navigationDrawerContentColor: Color
)

Creates a NavigationSuiteColors with the provided colors for the container color, according to the Material specification.

Cmn
NavigationSuiteItemColors
@Composable
itemColors(
    navigationBarItemColors: NavigationBarItemColors,
    navigationRailItemColors: NavigationRailItemColors,
    navigationDrawerItemColors: NavigationDrawerItemColors
)

Creates a NavigationSuiteItemColors with the provided colors for a NavigationSuiteScope.item.

Cmn

Public functions

colors

@Composable
fun colors(
    navigationBarContainerColor: Color = NavigationBarDefaults.containerColor,
    navigationBarContentColor: Color = contentColorFor(navigationBarContainerColor),
    navigationRailContainerColor: Color = NavigationRailDefaults.ContainerColor,
    navigationRailContentColor: Color = contentColorFor(navigationRailContainerColor),
    navigationDrawerContainerColor: Color = @Suppress("DEPRECATION") DrawerDefaults.containerColor,
    navigationDrawerContentColor: Color = contentColorFor(navigationDrawerContainerColor)
): NavigationSuiteColors

Creates a NavigationSuiteColors with the provided colors for the container color, according to the Material specification.

Use Color.Transparent for the navigationContainerColor to have no color. The navigationContentColor will default to either the matching content color for navigationContainerColor, or to the current LocalContentColor if navigationContainerColor is not a color from the theme.

Parameters
navigationBarContainerColor: Color = NavigationBarDefaults.containerColor

the default container color for the NavigationBar

navigationBarContentColor: Color = contentColorFor(navigationBarContainerColor)

the default content color for the NavigationBar

navigationRailContainerColor: Color = NavigationRailDefaults.ContainerColor

the default container color for the NavigationRail

navigationRailContentColor: Color = contentColorFor(navigationRailContainerColor)

the default content color for the NavigationRail

navigationDrawerContainerColor: Color = @Suppress("DEPRECATION") DrawerDefaults.containerColor

the default container color for the PermanentDrawerSheet

navigationDrawerContentColor: Color = contentColorFor(navigationDrawerContainerColor)

the default content color for the PermanentDrawerSheet

itemColors

@Composable
fun itemColors(
    navigationBarItemColors: NavigationBarItemColors = NavigationBarItemDefaults.colors(),
    navigationRailItemColors: NavigationRailItemColors = NavigationRailItemDefaults.colors(),
    navigationDrawerItemColors: NavigationDrawerItemColors = NavigationDrawerItemDefaults.colors()
): NavigationSuiteItemColors

Creates a NavigationSuiteItemColors with the provided colors for a NavigationSuiteScope.item.

For specifics about each navigation item colors see NavigationBarItemColors, NavigationRailItemColors, and NavigationDrawerItemColors.

Parameters
navigationBarItemColors: NavigationBarItemColors = NavigationBarItemDefaults.colors()

the NavigationBarItemColors associated with the NavigationBarItem of the NavigationSuiteScope.item

navigationRailItemColors: NavigationRailItemColors = NavigationRailItemDefaults.colors()

the NavigationRailItemColors associated with the NavigationRailItem of the NavigationSuiteScope.item

navigationDrawerItemColors: NavigationDrawerItemColors = NavigationDrawerItemDefaults.colors()

the NavigationDrawerItemColors associated with the NavigationDrawerItem of the NavigationSuiteScope.item