# RevealValue

# RevealValue

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

<br />

```
@ExperimentalWearMaterialApi
value class RevealValue
```

<br />

*** ** * ** ***

Different values that determine the state of the[SwipeToReveal](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/package-summary#SwipeToReveal(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,androidx.wear.compose.material.RevealState,kotlin.Function0,kotlin.Function0,kotlin.Function0))composable, reflected in[RevealState.currentValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealState#currentValue()).[RevealValue.Covered](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#Covered())is considered the default state where none of the actions are revealed yet.

[SwipeToReveal](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/package-summary#SwipeToReveal(kotlin.Function0,androidx.compose.ui.Modifier,kotlin.Function0,androidx.wear.compose.material.RevealState,kotlin.Function0,kotlin.Function0,kotlin.Function0))direction is not localised, with the default being[RevealDirection.RightToLeft](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealDirection#RightToLeft()), and[RevealValue.RightRevealing](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#RightRevealing())and[RevealValue.RightRevealed](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#RightRevealed())correspond to the actions getting revealed from the right side of the screen. In case swipe direction is set to[RevealDirection.Both](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealDirection#Both()), actions can also get revealed from the left side of the screen, and in that case[RevealValue.LeftRevealing](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#LeftRevealing())and[RevealValue.LeftRevealed](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#LeftRevealed())are used.  

|                                                     See also                                                     |
|------------------------------------------------------------------------------------------------------------------|---|
| [RevealDirection](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealDirection) |   |

## Summary

|                                     ### Public companion properties                                      |
|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [RevealValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue) | [Covered](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#Covered()) The default first value which generally represents the state where the revealable actions have not been revealed yet.                                                   |
| [RevealValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue) | [LeftRevealed](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#LeftRevealed()) 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.          |
| [RevealValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue) | [LeftRevealing](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#LeftRevealing()) The value which represents the state in which all the actions are revealed and the top content is not being swiped.                                         |
| [RevealValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue) | [RightRevealed](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#RightRevealed()) 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. |
| [RevealValue](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue) | [RightRevealing](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#RightRevealing()) The value which represents the state in which all the actions are revealed and the top content is not being swiped.                                       |

|                            ### Public properties                            |
|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [value](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealValue#value()) |

## Public companion properties

### Covered

```
val Covered: 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
```

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[RevealDirection.Both](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealDirection#Both()), and the user swipes from the left side of the screen.  

### LeftRevealing

```
val LeftRevealing: 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[RevealDirection.Both](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/RevealDirection#Both()), and the user swipes from the left side of the screen.  

### RightRevealed

```
val RightRevealed: 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
```

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.5.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.5.0)  

```
val value: Int
```