NavigationSuiteDefaults

object NavigationSuiteDefaults

Contains the default values used by the NavigationSuite.

Properties

val verticalArrangement = Arrangement.Top

Default items vertical arrangement for a navigation suite.

Functions

colors

@Composable
    fun colors(
        shortNavigationBarContentColor: Color = ShortNavigationBarDefaults.contentColor,
        shortNavigationBarContainerColor: Color = ShortNavigationBarDefaults.containerColor,
        wideNavigationRailColors: WideNavigationRailColors = WideNavigationRailDefaults.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 navigation*ContainerColor, or to the current LocalContentColor if navigation*ContainerColor is not a color from the theme.

Parameters

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 navigation*ContainerColor, or to the current LocalContentColor if navigation*ContainerColor is not a color from the theme.

Parameters

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