# DismissValue

Artifact: [androidx.compose.material:material](https://developer.android.com/jetpack/androidx/releases/compose-material) [View Source](https://cs.android.com/search?q=file:androidx/compose/material/SwipeToDismiss.kt+class:androidx.compose.material.DismissValue) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.0.0) Common/AllAndroid/JVM
- Cmn

  ```
  enum DismissValue : Enum<DismissValue>
  ```

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

*** ** * ** ***

Possible values of `https://developer.android.com/reference/kotlin/androidx/compose/material/DismissState`.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material/DismissValue#Default` | Indicates the component has not been dismissed yet. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/DismissValue#DismissedToEnd` | Indicates the component has been dismissed in the reading direction. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material/DismissValue#DismissedToStart` | Indicates the component has been dismissed in the reverse of the reading direction. |

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

### Default

```
val DismissValue.Default: DismissValue
```

Indicates the component has not been dismissed yet.

### DismissedToEnd

```
val DismissValue.DismissedToEnd: DismissValue
```

Indicates the component has been dismissed in the reading direction.

### DismissedToStart

```
val DismissValue.DismissedToStart: DismissValue
```

Indicates the component has been dismissed in the reverse of the reading direction.

## Public functions

### valueOf

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

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

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-material#1.0.0)

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

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

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.