# WideNavigationRailDefaults

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/WideNavigationRail.kt+class:androidx.compose.material3.WideNavigationRailDefaults) Common/AllAndroid/JVM
- Cmn

  ```
  object WideNavigationRailDefaults
  ```

*** ** * ** ***

Defaults used in `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)`.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors()()` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` with the provided colors according to the Material specification. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors(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)( containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, modalContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, modalScrimColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, modalContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` with the provided colors according to the Material specification. | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#ContentPadding()` The default content padding used for `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)` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRailProperties` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#ModalExpandedProperties()` Properties used to customize the window behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/Arrangement.Vertical` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#arrangement()` Default arrangement for a wide navigation rail. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#modalCollapsedShape()` Default container shape of a collapsed `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#modalExpandedShape()` Default container shape of a expanded `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Shape` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#shape()` Default container shape of a wide navigation rail. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/WindowInsets` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#windowInsets()` Default window insets for a wide navigation rail. | Cmn |

## Public functions

### colors

Cmn

```
@Composable
fun colors(): WideNavigationRailColors
```

Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` with the provided colors according to the Material specification.

### colors

Cmn

```
@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 `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailColors` with the provided colors according to the Material specification.

| Parameters |
|---|---|
| `containerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = WideNavigationRailDefaults.containerColor` | the color used for the background of a non-modal wide navigation rail. |
| `contentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(containerColor)` | the preferred color for content inside a wide navigation rail. Defaults to either the matching content color for `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors(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)`, or to the current `https://developer.android.com/reference/kotlin/androidx/compose/material3/package-summary#LocalContentColor()` if `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors(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)` is not a color from the theme |
| `modalContainerColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailExpandedTokens.ModalContainerColor.value` | the color used for the background of a modal wide navigation rail. |
| `modalScrimColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = ScrimTokens.ContainerColor.value.copy(ScrimTokens.ContainerOpacity)` | the color used for the scrim overlay for background content of a modal wide navigation rail |
| `modalContentColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = contentColorFor(modalContainerColor)` | the preferred color for content inside a modal wide navigation rail. Defaults to either the matching content color for `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors(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)`, or to the current `https://developer.android.com/reference/kotlin/androidx/compose/material3/package-summary#LocalContentColor()` if `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailDefaults#colors(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)` is not a color from the theme |

## Public properties

### ContentPadding

Cmn

```
val ContentPadding: PaddingValues
```

The default content padding used for `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)` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`.

### ModalExpandedProperties

Cmn

```
val ModalExpandedProperties: ModalWideNavigationRailProperties
```

Properties used to customize the window behavior of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`.

### arrangement

Cmn

```
val arrangement: Arrangement.Vertical
```

Default arrangement for a wide navigation rail.

### modalCollapsedShape

Cmn

```
val modalCollapsedShape: Shape
```

Default container shape of a collapsed `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`.

### modalExpandedShape

Cmn

```
val modalExpandedShape: Shape
```

Default container shape of a expanded `https://developer.android.com/reference/kotlin/androidx/compose/material3/ModalWideNavigationRail.composable#ModalWideNavigationRail(androidx.compose.ui.Modifier,androidx.compose.material3.WideNavigationRailState,kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Shape,androidx.compose.material3.WideNavigationRailColors,kotlin.Function0,androidx.compose.ui.unit.Dp,androidx.compose.foundation.layout.WindowInsets,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.material3.ModalWideNavigationRailProperties,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0)`.

### shape

Cmn

```
val shape: Shape
```

Default container shape of a wide navigation rail.

### windowInsets

Cmn

```
val windowInsets: WindowInsets
```

Default window insets for a wide navigation rail.