# NavigationSuiteDefaults

Artifact: [androidx.compose.material3:material3-adaptive-navigation-suite](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScaffold.kt+class:androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteDefaults)


```
object NavigationSuiteDefaults
```

<br />

*** ** * ** ***

Contains the default values used by the `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuite.composable#NavigationSuite(androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteType,androidx.compose.ui.Modifier,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteColors,androidx.compose.foundation.layout.Arrangement.Vertical,kotlin.Function0,kotlin.Function0)`.

## Summary

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteDefaults#colors(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.material3.WideNavigationRailColors,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( shortNavigationBarContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, shortNavigationBarContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, wideNavigationRailColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors, navigationBarContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, navigationBarContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, navigationRailContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, navigationRailContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, navigationDrawerContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, navigationDrawerContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteColors` with the provided colors for the container color, according to the Material specification. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteItemColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteDefaults#itemColors(androidx.compose.material3.NavigationBarItemColors,androidx.compose.material3.NavigationRailItemColors,androidx.compose.material3.NavigationDrawerItemColors)( navigationBarItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBarItemColors, navigationRailItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRailItemColors, navigationDrawerItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationDrawerItemColors )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteItemColors` with the provided colors for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScope#item(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)`. |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/Arrangement.Vertical` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteDefaults#verticalArrangement()` Default items vertical arrangement for a navigation suite. |

## Public 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 `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteColors` with the provided colors for the container color, according to the Material specification.

Use `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color#Transparent()` for the navigation*ContainerColor to have no color. The navigation* ContentColor will default to either the matching content color for navigation*ContainerColor, or to the current `https://developer.android.com/reference/kotlin/androidx/compose/material3/package-summary#LocalContentColor()` if navigation*ContainerColor is not a color from the theme.

| Parameters |
|---|---|
| `shortNavigationBarContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = ShortNavigationBarDefaults.contentColor` | the content color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ShortNavigationBar.composable#ShortNavigationBar(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.foundation.layout.WindowInsets,androidx.compose.material3.ShortNavigationBarArrangement,kotlin.Function0)` |
| `shortNavigationBarContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = ShortNavigationBarDefaults.containerColor` | the container color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/ShortNavigationBar.composable#ShortNavigationBar(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.foundation.layout.WindowInsets,androidx.compose.material3.ShortNavigationBarArrangement,kotlin.Function0)` |
| `wideNavigationRailColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors = WideNavigationRailDefaults.colors()` | the `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRail.composable#WideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)` |
| `navigationBarContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationBarDefaults.containerColor` | the default container color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBar.composable#NavigationBar(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |
| `navigationBarContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(navigationBarContainerColor)` | the default content color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBar.composable#NavigationBar(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |
| `navigationRailContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailDefaults.ContainerColor` | the default container color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRail.composable#NavigationRail(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,kotlin.Function1,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |
| `navigationRailContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(navigationRailContainerColor)` | the default content color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRail.composable#NavigationRail(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,kotlin.Function1,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |
| `navigationDrawerContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = @Suppress("DEPRECATION") DrawerDefaults.containerColor` | the default container color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/PermanentDrawerSheet.composable#PermanentDrawerSheet(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |
| `navigationDrawerContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(navigationDrawerContainerColor)` | the default content color for the `https://developer.android.com/reference/kotlin/androidx/compose/material3/PermanentDrawerSheet.composable#PermanentDrawerSheet(androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,kotlin.Function1)` |

### itemColors

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

Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteItemColors` with the provided colors for a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScope#item(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)`.

For specifics about each navigation item colors see `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBarItemColors`, `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRailItemColors`, and `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationDrawerItemColors`.

| Parameters |
|---|---|
| `navigationBarItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBarItemColors = NavigationBarItemDefaults.colors()` | the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBarItemColors` associated with the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationBarItem.composable#(androidx.compose.foundation.layout.RowScope).NavigationBarItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,androidx.compose.material3.NavigationBarItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScope#item(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` |
| `navigationRailItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRailItemColors = NavigationRailItemDefaults.colors()` | the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRailItemColors` associated with the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationRailItem.composable#NavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,androidx.compose.material3.NavigationRailItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScope#item(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` |
| `navigationDrawerItemColors: https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationDrawerItemColors = NavigationDrawerItemDefaults.colors()` | the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationDrawerItemColors` associated with the `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationDrawerItem.composable#NavigationDrawerItem(kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,kotlin.Function0,androidx.compose.ui.graphics.Shape,androidx.compose.material3.NavigationDrawerItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/navigationsuite/NavigationSuiteScope#item(kotlin.Boolean,kotlin.Function0,kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Boolean,kotlin.Function0,kotlin.Boolean,kotlin.Function0,androidx.compose.material3.adaptive.navigationsuite.NavigationSuiteItemColors,androidx.compose.foundation.interaction.MutableInteractionSource)` |

## Public properties

### verticalArrangement

```
val verticalArrangement: Arrangement.Vertical
```

Default items vertical arrangement for a navigation suite.