---
title: "RevealState"
description: "A class to keep track of the state of the composable. It can be used to customise the behavior
and state of the composable."
type: "class"
---

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


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

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


```kotlin
public class RevealState(initialValue: RevealValue)
```


A class to keep track of the state of the composable. It can be used to customise the behavior
and state of the composable.

#### Parameters

| | |
| --- | --- |
| initialValue | The initial value of this state. |



## Functions

```kotlin
public suspend fun snapTo(targetValue: RevealValue)
```


Snaps to the `targetValue` without any animation (if a previous item was already revealed,
that item will be reset to the covered state with animation).

#### Parameters

| | |
| --- | --- |
| targetValue | The target `RevealValue` where the `currentValue` will be changed to. |



```kotlin
public suspend fun animateTo(targetValue: RevealValue)
```


Animates to the `targetValue` with the animation spec provided.

#### Parameters

| | |
| --- | --- |
| targetValue | The target `RevealValue` where the `currentValue` will animate to. |