Elements

Reference

Tooltip

Tooltip, dressed in the paper-and-ink system: the smallest vessel — a tight chip of ink that dissolves in over its anchor. The parts — Root, Trigger, Positioner, Content, Arrow, ArrowTip.

Trigger · Arrow · ArrowTip · Positioner · Content

#ArrowTip

A styled part — no props of its own; it takes the anatomy's shared styling.

#Arrow

A styled part — no props of its own; it takes the anatomy's shared styling.

#Content

A styled part — no props of its own; it takes the anatomy's shared styling.

#Positioner

A styled part — no props of its own; it takes the anatomy's shared styling.

#Root

PropTypeDefaultDescription
aria-labelstringCustom label for the tooltip.
closeDelaynumber500The close delay of the tooltip.
closeOnClickbooleantrueWhether the tooltip should close on click
closeOnEscapebooleantrueWhether to close the tooltip when the Escape key is pressed.
closeOnPointerDownbooleantrueWhether to close the tooltip on pointerdown.
closeOnScrollbooleantrueWhether the tooltip should close on scroll
defaultOpenbooleanThe initial open state of the tooltip when rendered. Use when you don't need to control the open state of the tooltip.
defaultTriggerValuestring | nullThe initial trigger value when rendered. Use when you don't need to control the trigger value.
disabledbooleanWhether the tooltip is disabled
idstringThe unique identifier of the machine.
idsPartial<{ trigger: string; content: string; arrow: string; positioner: string; }>The ids of the elements in the tooltip. Useful for composition.
interactivebooleanfalseWhether the tooltip's content is interactive. In this mode, the tooltip will remain open when user hovers over the content. @see https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus
openbooleanThe controlled open state of the tooltip
openDelaynumber1000The open delay of the tooltip.
positioningtooltip.PositioningOptionsThe user provided options used to position the popover content
triggerValuestring | nullThe value of the trigger that currently open the tooltip
EventPayload
exitComplete—
openChangedetails: OpenChangeDetails
update:openopen: boolean
triggerValueChangedetails: TriggerValueChangeDetails
update:triggerValuetriggerValue: string | null

#Trigger

PropTypeDefaultDescription
valuestringThe value that identifies this specific trigger