---
title: "TooltipState"
description: "The state that is associated with a [TooltipBox]. Each instance of [TooltipBox] should have its
own [TooltipState]."
type: "interface"
---

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


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

<div class='sourceset sourceset-common'>Common</div>



```kotlin
interface TooltipState
```


The state that is associated with a `TooltipBox`. Each instance of `TooltipBox` should have its
own `TooltipState`.


## Properties

<div class='sourceset sourceset-common'>Common</div>


```kotlin
val transition: MutableTransitionState<Boolean>
```


The current transition state of the tooltip. Used to start the transition of the tooltip when
fading in and out.



<div class='sourceset sourceset-common'>Common</div>


```kotlin
val isVisible: Boolean
```


`Boolean` that indicates if the tooltip is currently being shown or not.



<div class='sourceset sourceset-common'>Common</div>


```kotlin
val isPersistent: Boolean
```


`Boolean` that determines if the tooltip associated with this will be persistent or not. If
isPersistent is true, then the tooltip will only be dismissed when the user clicks outside
the bounds of the tooltip or if `TooltipState.dismiss` is called. When isPersistent is false,
the tooltip will dismiss after a short duration. Ideally, this should be set to true when
there is actionable content being displayed within a tooltip.



## Functions

```kotlin
suspend fun show(mutatePriority: MutatePriority = MutatePriority.Default)
```


Show the tooltip associated with the current `TooltipState`. When this method is called all
of the other tooltips currently being shown will dismiss.

#### Parameters

| | |
| --- | --- |
| mutatePriority | `MutatePriority` to be used. |



```kotlin
fun dismiss()
```


Dismiss the tooltip associated with this `TooltipState` if it's currently being shown.


```kotlin
fun onDispose()
```


Clean up when the this state leaves Composition.