# RevealValue

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.RevealValue) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.2.0) Deprecated in [1.5.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.5.0)


```
@ExperimentalWearFoundationApi
value class RevealValue
```

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

Different values that determine the state of the `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, reflected in `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealState#currentValue()`. `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#Covered()` is considered the default state where none of the actions are revealed yet.

`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)` direction is not localised, with the default being `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#RightToLeft()`, and `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#RightRevealing()` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#RightRevealed()` correspond to the actions getting revealed from the right side of the screen. In case swipe direction is set to `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#Both()`, actions can also get revealed from the left side of the screen, and in that case `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#LeftRevealing()` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#LeftRevealed()` are used.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection` |   |

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#Covered()` **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/RevealValue` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#LeftRevealed()` **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/RevealValue` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#LeftRevealing()` **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/RevealValue` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#RightRevealed()` **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/RevealValue` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealValue#RightRevealing()` **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/RevealValue#value()` **This property is deprecated.** The SwipeToReveal component from the latest material library should be used instead. |

## Public companion properties

### Covered

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

```
val Covered: RevealValue
```

> [!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
> RevealValue
> ```

The default first value which generally represents the state where the revealable actions have not been revealed yet. In this state, none of the actions have been triggered or performed yet.

### LeftRevealed

```
val LeftRevealed: RevealValue
```

> [!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
> RevealValue
> ```

The value which represents the state in which the whole revealable content is fully revealed, and they are displayed on the left side of the screen. This also represents the state in which one of the actions has been triggered/performed.

This is only used when the swipe direction is set to `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#Both()`, and the user swipes from the left side of the screen.

### LeftRevealing

```
val LeftRevealing: RevealValue
```

> [!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
> RevealValue
> ```

The value which represents the state in which all the actions are revealed and the top content is not being swiped. In this state, none of the actions have been triggered or performed yet, and they are displayed on the left side of the screen.

This is only used when the swipe direction is set to `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/RevealDirection#Both()`, and the user swipes from the left side of the screen.

### RightRevealed

```
val RightRevealed: RevealValue
```

> [!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
> RevealValue
> ```

The value which represents the state in which the whole revealable content is fully revealed, and the actions are revealed on the right side of the screen. This also represents the state in which one of the actions has been triggered/performed.

### RightRevealing

```
val RightRevealing: RevealValue
```

> [!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
> RevealValue
> ```

The value which represents the state in which all the actions are revealed and the top content is not being swiped. In this state, none of the actions have been triggered or performed yet, and they are displayed on the right side of the screen.

## Public properties

### value

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.2.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
> RevealValue
> ```