# RevealDirection

Artifact: [androidx.wear.compose:compose-foundation](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/foundation/SwipeToReveal.kt+class:androidx.wear.compose.foundation.RevealDirection) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.5.0) Deprecated in [1.5.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.5.0)


```
@ExperimentalWearFoundationApi
value class RevealDirection
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library, use this instead:
>
> ```kotlin
> RevealDirection
> ```

Different values `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/SwipeToReveal.composable#SwipeToReveal(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,androidx.wear.compose.foundation.RevealState,kotlin.Function0,kotlin.Function0,androidx.wear.compose.foundation.GestureInclusion,kotlin.Function0)` composable can reveal the actions from.

`https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection` is not localised, with the default being `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#RightToLeft()` to prevent conflict with the system-wide swipe to dismiss gesture in an activity, so it's strongly advised to respect the default value to avoid conflicting gestures.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#Both()` **This property is deprecated.** The SwipeToReveal component from the latest material library should be used instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#RightToLeft()` **This property is deprecated.** The SwipeToReveal component from the latest material library should be used instead. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#value()` **This property is deprecated.** The SwipeToReveal component from the latest material library should be used instead. |

## Public companion properties

### Both

```
val Both: RevealDirection
```

> [!CAUTION]
> **This property is deprecated.**   
> The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library, use this instead:
>
> ```kotlin
> RevealDirection
> ```

The value which allows the user to swipe in either direction to reveal or execute the actions. This should not be used if the component is used in an activity as the gesture might conflict with the swipe-to-dismiss gesture and could be confusing for the users. This is only supported for rare cases where the current screen does not support swipe to dismiss.

### RightToLeft

```
val RightToLeft: RevealDirection
```

> [!CAUTION]
> **This property is deprecated.**   
> The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library, use this instead:
>
> ```kotlin
> RevealDirection
> ```

The default value which allows the user to swipe right to left to reveal or execute the actions. It's strongly advised to respect the default behavior to avoid conflict with the swipe-to-dismiss gesture.

## Public properties

### value

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

```
val value: Int
```

> [!CAUTION]
> **This property is deprecated.**   
> The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library, use this instead:
>
> ```kotlin
> RevealDirection
> ```