# WideNavigationRailItemDefaults

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.WideNavigationRailItemDefaults) Common/AllAndroid/JVM
- Cmn

  ```
  object WideNavigationRailItemDefaults
  ```

*** ** * ** ***

Defaults used in `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)`.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#colors()()` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` with the provided colors according to the Material specification. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#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,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( selectedIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, selectedTextColorTopIconPosition: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, selectedTextColorStartIconPosition: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, selectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, unselectedIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, unselectedTextColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, disabledTextColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` Creates a `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` with the provided colors according to the Material specification. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemIconPosition` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#iconPositionFor(kotlin.Boolean)(railExpanded: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` The default icon position of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` given whether the associated `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)` is collapsed or expanded. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#indicatorPadding(kotlin.Boolean,androidx.compose.foundation.layout.PaddingValues,androidx.compose.foundation.layout.PaddingValues)( railExpanded: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, collapsedPadding: https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues, expandedPadding: https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues )` The default indicator padding of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)`. | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#IndicatorCollapsedPadding()` The default padding to be applied when the associated `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` is collapsed. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItemDefaults#IndicatorExpandedPadding()` The default padding to be applied when the associated `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` is expanded. | Cmn |

## Public functions

### colors

Cmn

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

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

### colors

Cmn

```
@Composable
fun colors(
    selectedIconColor: Color = NavigationRailColorTokens.ItemActiveIcon.value,
    selectedTextColorTopIconPosition: Color = NavigationRailColorTokens.ItemActiveLabelText.value,
    selectedTextColorStartIconPosition: Color = NavigationRailColorTokens.ItemActiveIcon.value,
    selectedIndicatorColor: Color = NavigationRailColorTokens.ItemActiveIndicator.value,
    unselectedIconColor: Color = NavigationRailColorTokens.ItemInactiveIcon.value,
    unselectedTextColor: Color = NavigationRailColorTokens.ItemInactiveLabelText.value,
    disabledIconColor: Color = unselectedIconColor.copy(alpha = DisabledAlpha),
    disabledTextColor: Color = unselectedTextColor.copy(alpha = DisabledAlpha)
): NavigationItemColors
```

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

| Parameters |
|---|---|
| `selectedIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemActiveIcon.value` | the color to use for the icon when the item is selected. |
| `selectedTextColorTopIconPosition: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemActiveLabelText.value` | the color to use for the text label when the item is selected and the icon is at the top. |
| `selectedTextColorStartIconPosition: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemActiveIcon.value` | the color to use for the text label when the item is selected and the icon is at the start. |
| `selectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemActiveIndicator.value` | the color to use for the indicator when the item is selected. |
| `unselectedIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemInactiveIcon.value` | the color to use for the icon when the item is unselected. |
| `unselectedTextColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = NavigationRailColorTokens.ItemInactiveLabelText.value` | the color to use for the text label when the item is unselected. |
| `disabledIconColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = unselectedIconColor.copy(alpha = DisabledAlpha)` | the color to use for the icon when the item is disabled. |
| `disabledTextColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = unselectedTextColor.copy(alpha = DisabledAlpha)` | the color to use for the text label when the item is disabled. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` | the resulting `https://developer.android.com/reference/kotlin/androidx/compose/material3/NavigationItemColors` used for `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` |

### iconPositionFor

Cmn

```
fun iconPositionFor(railExpanded: Boolean): NavigationItemIconPosition
```

The default icon position of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` given whether the associated `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)` is collapsed or expanded.

### indicatorPadding

Cmn

```
@Composable
fun indicatorPadding(
    railExpanded: Boolean,
    collapsedPadding: PaddingValues = IndicatorCollapsedPadding,
    expandedPadding: PaddingValues = IndicatorExpandedPadding
): PaddingValues
```

The default indicator padding of a `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)`.

| Parameters |
|---|---|
| `railExpanded: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | whether the associated `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)` is expanded or collapsed |
| `collapsedPadding: https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues = IndicatorCollapsedPadding` | the padding to be applied when the associated `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)` is collapsed |
| `expandedPadding: https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues = IndicatorExpandedPadding` | the padding to be applied when the associated `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)` is expanded |

## Public properties

### IndicatorCollapsedPadding

Cmn

```
val IndicatorCollapsedPadding: PaddingValues
```

The default padding to be applied when the associated `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` is collapsed.

### IndicatorExpandedPadding

Cmn

```
val IndicatorExpandedPadding: PaddingValues
```

The default padding to be applied when the associated `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailItem.composable#WideNavigationRailItem(kotlin.Boolean,kotlin.Function0,kotlin.Function0,kotlin.Function0,kotlin.Boolean,androidx.compose.ui.Modifier,kotlin.Boolean,androidx.compose.material3.NavigationItemIconPosition,androidx.compose.material3.NavigationItemColors,androidx.compose.foundation.interaction.MutableInteractionSource,androidx.compose.foundation.layout.PaddingValues)` is expanded.