# SwipeToDismissValue

Artifact: [androidx.wear.compose:compose-material](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material/SwipeToDismissBox.kt+class:androidx.wear.compose.material.SwipeToDismissValue) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.0.0) Deprecated in [1.4.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.4.0)


```
enum SwipeToDismissValue : Enum<SwipeToDismissValue>
```

<br />

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

*** ** * ** ***

> [!CAUTION]
> **This enum is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

States used as targets for the anchor points for swipe-to-dismiss.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#Default` | **This enum value is deprecated.** SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#Dismissed` | **This enum value is deprecated.** SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue` | `[valueOf](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#valueOf(kotlin.String))(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` **This function is deprecated.** SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue>` | `[values](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#values())()` **This function is deprecated.** SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue>` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#entries()` **This property is deprecated.** SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |

## Enum Values

### Default

```
val SwipeToDismissValue.Default: SwipeToDismissValue
```

> [!CAUTION]
> **This enum value is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

The state of the SwipeToDismissBox before the swipe started.

### Dismissed

```
val SwipeToDismissValue.Dismissed: SwipeToDismissValue
```

> [!CAUTION]
> **This enum value is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

The state of the SwipeToDismissBox after the swipe passes the swipe-to-dismiss threshold.

## Public functions

### valueOf

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

```
fun [valueOf](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#valueOf(kotlin.String))(value: String): SwipeToDismissValue
```

> [!CAUTION]
> **This function is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

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

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

```
fun [values](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/SwipeToDismissValue#values())(): Array<SwipeToDismissValue>
```

> [!CAUTION]
> **This function is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

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

```
val entries: EnumEntries<SwipeToDismissValue>
```

> [!CAUTION]
> **This property is deprecated.**   
> SwipeToDismiss has been migrated to androidx.wear.compose.foundation. Please import SwipeToDismissValue from androidx.wear.compose.foundation instead.

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.