{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

TooltipState

@ExperimentalMaterial3Api
public interface TooltipState extends BasicTooltipState


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

Summary

Public methods

abstract @NonNull MutableTransitionState<@NonNull Boolean>

The current transition state of the tooltip.

Inherited methods

From androidx.compose.material3.BasicTooltipState
abstract void

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

abstract boolean

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

abstract boolean

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

abstract void

Clean up when the this state leaves Composition.

abstract void
show(@NonNull MutatePriority mutatePriority)

Show the tooltip associated with the current BasicTooltipState.

Public methods

getTransition

abstract @NonNull MutableTransitionState<@NonNull BooleangetTransition()

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