BasicTooltipState

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

Summary

Public functions
Unit

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

Clean up when the this state leaves Composition.
Cmn
suspend Unit
show(mutatePriority: MutatePriority)

Show the tooltip associated with the current BasicTooltipState.
Cmn

Public properties
Boolean

Boolean that determines if the tooltip associated with this will be persistent or not.
Cmn
Boolean

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

Public functions

dismiss

Cmn
Added in 1.6.0
fun dismiss(): Unit

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

onDispose

Cmn
Added in 1.6.0
fun onDispose(): Unit

Clean up when the this state leaves Composition.

show

Cmn
Added in 1.6.0
suspend fun show(mutatePriority: MutatePriority = MutatePriority.Default): Unit

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

Parameters
mutatePriority: MutatePriority = MutatePriority.Default

MutatePriority to be used.

Public properties

isPersistent

Cmn
Added in 1.6.0
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.

isVisible

Cmn
Added in 1.6.0
val isVisible: Boolean

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