---
title: "RevealValue"
description: "Different values that determine the state of the [SwipeToReveal] composable, reflected in
[RevealState.currentValue]. [RevealValue.Covered] is considered the default state where none of
the actions are revealed yet.

[SwipeToReveal] direction is not localised, with the default being [RevealDirection.RightToLeft],
and [RevealValue.RightRevealing] and [RevealValue.RightRevealed] correspond to the actions
getting revealed from the right side of the screen. In case swipe direction is set to
[RevealDirection.Both], actions can also get revealed from the left side of the screen, and in
that case [RevealValue.LeftRevealing] and [RevealValue.LeftRevealed] are used."
type: "class"
---

<div class='type'>Class</div>


<a id='references'></a>

<div class='sourceset sourceset-android'>Android</div>


```kotlin
@ExperimentalWearMaterialApi
public value class RevealValue private constructor(public val value: Int)
```


Different values that determine the state of the `SwipeToReveal` composable, reflected in
`RevealState.currentValue`. `RevealValue.Covered` is considered the default state where none of
the actions are revealed yet.

`SwipeToReveal` direction is not localised, with the default being `RevealDirection.RightToLeft`,
and `RevealValue.RightRevealing` and `RevealValue.RightRevealed` correspond to the actions
getting revealed from the right side of the screen. In case swipe direction is set to
`RevealDirection.Both`, actions can also get revealed from the left side of the screen, and in
that case `RevealValue.LeftRevealing` and `RevealValue.LeftRevealed` are used.


## Companion Object

#### Properties

<div class='sourceset sourceset-android'>Android</div>


```kotlin
public 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`, and the user
swipes from the left side of the screen.



<div class='sourceset sourceset-android'>Android</div>


```kotlin
public 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`, and the user
swipes from the left side of the screen.



<div class='sourceset sourceset-android'>Android</div>


```kotlin
public 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.



<div class='sourceset sourceset-android'>Android</div>


```kotlin
public 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.



<div class='sourceset sourceset-android'>Android</div>


```kotlin
public 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.





