BasicTooltipState

@ExperimentalFoundationApi
interface BasicTooltipState

The state that is associated with an instance of a tooltip. Each instance of tooltips should have its own BasicTooltipState.

Properties

isVisible

val isVisible: Boolean

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

isPersistent

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 BasicTooltipState.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

show

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

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

Parameters

dismiss

fun dismiss()

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

onDispose

fun onDispose()

Clean up when the this state leaves Composition.