# ToggleableState

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/state/ToggleableState.kt+class:androidx.compose.ui.state.ToggleableState) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/All
- Cmn

  ```
  enum ToggleableState : Enum<ToggleableState>
  ```

|---|---|---|
| [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)\<[ToggleableState](https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState)\> ||
|   | ↳ | [androidx.compose.ui.state.ToggleableState](https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState) |

*** ** * ** ***

Enum that represents possible toggleable states.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Indeterminate` | State that means that on/off value of a component cannot be determined |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#Off` | State that means a component is off |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#On` | State that means a component is on |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#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/ui/state/ToggleableState>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#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/ui/state/ToggleableState>` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/state/ToggleableState#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

### Indeterminate

```
val ToggleableState.Indeterminate: ToggleableState
```

State that means that on/off value of a component cannot be determined

### Off

```
val ToggleableState.Off: ToggleableState
```

State that means a component is off

### On

```
val ToggleableState.On: ToggleableState
```

State that means a component is on

## Public functions

### valueOf

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

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

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 Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

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

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<ToggleableState>
```

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.