# WideNavigationRailValue

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/WideNavigationRailState.kt+class:androidx.compose.material3.WideNavigationRailValue) Common/AllAndroid/JVM
- Cmn

  ```
  enum WideNavigationRailValue : Enum<WideNavigationRailValue>
  ```

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[WideNavigationRailValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue)\> ||
|   | ↳ | [androidx.compose.material3.WideNavigationRailValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue) |

*** ** * ** ***

Possible values of `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailState`.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue#Collapsed` | The state of the rail when it is collapsed. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue#Expanded` | The state of the rail when it is expanded. |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue>` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue#values()()` Returns an array containing the constants of this enum type, in the order they're declared. | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue>` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/WideNavigationRailValue#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. | Cmn |

## Enum Values

### Collapsed

```
val WideNavigationRailValue.Collapsed: WideNavigationRailValue
```

The state of the rail when it is collapsed.

### Expanded

```
val WideNavigationRailValue.Expanded: WideNavigationRailValue
```

The state of the rail when it is expanded.

## Public functions

### valueOf

Cmn

```
fun valueOf(value: String): WideNavigationRailValue
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Cmn

```
fun values(): Array<WideNavigationRailValue>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.

## Public properties

### entries

Cmn

```
val entries: EnumEntries<WideNavigationRailValue>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.