Tooltip

The Tooltip component displays additional information when a user hovers or focuses on a trigger element.

Usage & Examples

Default

default.tsx

<Tooltip content="Tooltip message" position="top">
  <Button>Hover me</Button>
</Tooltip>

Props API

19 props
Columns
Tooltip props API
Default
Description
aria-labelstringNoariaAccessible label applied to the tooltip itself. Use when the tooltip needs an explicit accessible name.
aria-labelledbystringNoariaAccessible labelling reference for the tooltip itself.
childrenReactNodeYespropsThe element that triggers the tooltip.
classNamestringNostylingAdditional CSS class names for the tooltip wrapper.
contentstringYespropsThe content text displayed inside the tooltip.
data-testidstringNotestingBackward-compatible alias for test ID attributes.
glassbooleanNopropsconfigured default glass setting (fallback: false)Applies a translucent frosted-glass treatment using the active theme palette.
idstringNopropsOptional custom id for the tooltip element. If omitted, a stable generated id is used.
keepMountedWhenHiddenbooleanNopropstrueWhether the tooltip should remain in the accessibility tree when hidden. Defaults to false behavior via aria-hidden.
position"left" | "right" | "top" | "bottom"Noprops"top"The position of the tooltip relative to the target element. "top" | "bottom" | "left" | "right"
roundingRoundingTypeNostylingconfigured default rounding (fallback: "medium")Rounding style of the tooltip. "none" | "small" | "medium" | "large" | "full"
shadowShadowTypeNostylingconfigured default shadow (fallback: "light")Shadow style of the tooltip. "none" | "light" | "medium" | "strong" | "intense"