Skip to contents
1.0.0-beta.3GitHub

Tooltip

A popup that appears when an element is hovered or focused, showing a hint for sighted users.

View as Markdown

Accessibility guidelines

To ensure that tooltips are accessible and helpful, follow these guidelines:

  • Provide an accessible name for the trigger: The tooltip’s trigger must have a meaningful label. This can be its visible text or an aria-label/aria-labelledby attribute. The label should closely match the tooltip’s content to ensure consistency for screen reader users.

  • Avoid tooltips for critical information: Tooltips work well for enhancing UI clarity (like labeling icon buttons) but should not be the sole means of conveying important information. Since tooltips do not appear on touch devices, consider using a Popover for essential content.

  • Avoid tooltips for “infotips”: If your tooltip is attached to an “info icon” button whose only purpose is to show the tooltip, opt for Popover and add the openOnHover prop instead. Tooltips should describe an element that performs an action separate from opening the tooltip itself.

Anatomy

Import the component and assemble its parts:

Anatomy

API reference

Provider

Provides a shared delay for multiple tooltips. The grouping logic ensures that once a tooltip becomes visible, the adjacent tooltips will be shown instantly.

delaynumber
Name
delay
Description

How long to wait before opening a tooltip. Specified in milliseconds.

Type
number | undefined
closeDelaynumber
Name
closeDelay
Description

How long to wait before closing a tooltip. Specified in milliseconds.

Type
number | undefined
timeoutnumber(default: 400)
Name
timeout
Description

Another tooltip will open instantly if the previous tooltip is closed within this timeout. Specified in milliseconds.

Type
number | undefined
Default
400
childrenReactNode
Name
children
Type
React.ReactNode

Root

Groups all parts of the tooltip. Doesn’t render its own HTML element.

defaultOpenboolean(default: false)
Name
defaultOpen
Description

Whether the tooltip is initially open.

To render a controlled tooltip, use the open prop instead.

Type
boolean | undefined
Default
false
openboolean
Name
open
Description

Whether the tooltip is currently open.

Type
boolean | undefined
onOpenChangefunction
Name
onOpenChange
Description

Event handler called when the tooltip is opened or closed.

Type
| ((
    open: boolean,
    eventDetails: Tooltip.Root.ChangeEventDetails,
  ) => void)
| undefined
actionsRefRefObject<Tooltip.Root.Actions>
Name
actionsRef
Description

A ref to imperative actions.

  • unmount: When specified, the tooltip will not be unmounted when closed. Instead, the unmount function must be called to unmount the tooltip manually. Useful when the tooltip's animation is controlled by an external library.
Type
React.RefObject<Tooltip.Root.Actions> | undefined
onOpenChangeCompletefunction
Name
onOpenChangeComplete
Description

Event handler called after any animations complete when the tooltip is opened or closed.

Type
((open: boolean) => void) | undefined
trackCursorAxisUnion(default: 'none')
Name
trackCursorAxis
Description

Determines which axis the tooltip should track the cursor on.

Type
'none' | 'both' | 'x' | 'y' | undefined
Default
'none'
disabledboolean(default: false)
Name
disabled
Description

Whether the tooltip is disabled.

Type
boolean | undefined
Default
false
delaynumber(default: 600)
Name
delay
Description

How long to wait before opening the tooltip. Specified in milliseconds.

Type
number | undefined
Default
600
closeDelaynumber(default: 0)
Name
closeDelay
Description

How long to wait before closing the tooltip. Specified in milliseconds.

Type
number | undefined
Default
0
hoverableboolean(default: true)
Name
hoverable
Description

Whether the tooltip contents can be hovered without closing the tooltip.

Type
boolean | undefined
Default
true
childrenReactNode
Name
children
Type
React.ReactNode

Trigger

An element to attach the tooltip to. Renders a <button> element.

classNamestring | function
Name
className
Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
string | ((state: Tooltip.Trigger.State) => string)
renderReactElement | function
Name
render
Description

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Tooltip.Trigger.State,
  ) => ReactElement)
data-popup-open
Present when the corresponding tooltip is open.

Portal

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>.

containerUnion
Name
container
Description

A parent element to render the portal element into.

Type
| HTMLElement
| ShadowRoot
| React.RefObject<HTMLElement | ShadowRoot | null>
| null
| undefined
childrenReactNode
Name
children
Type
React.ReactNode
keepMountedboolean(default: false)
Name
keepMounted
Description

Whether to keep the portal mounted in the DOM while the popup is hidden.

Type
boolean | undefined
Default
false

Positioner

Positions the tooltip against the trigger. Renders a <div> element.

collisionAvoidanceCollisionAvoidance
Name
collisionAvoidance
Description

Determines how to handle collisions when positioning the popup.

Type
| {
    side?: 'none' | 'flip'
    align?: 'shift' | 'none' | 'flip'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| {
    side?: 'shift' | 'none'
    align?: 'shift' | 'none'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| undefined
Example
<Positioner
  collisionAvoidance={{
    side: 'shift',
    align: 'shift',
    fallbackAxisSide: 'none',
  }}
/>
alignAlign(default: 'center')
Name
align
Description

How to align the popup relative to the specified side.

Type
'center' | 'start' | 'end' | undefined
Default
'center'
alignOffsetnumber | OffsetFunction(default: 0)
Name
alignOffset
Description

Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment.

The function takes a data object parameter with the following properties:

  • data.anchor: the dimensions of the anchor element with properties width and height.
  • data.positioner: the dimensions of the positioner element with properties width and height.
  • data.side: which side of the anchor element the positioner is aligned against.
  • data.align: how the positioner is aligned relative to the specified side.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default
0
Example
<Positioner
  alignOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom'
      ? anchor.width
      : anchor.height;
  }}
/>
sideSide(default: 'top')
Name
side
Description

Which side of the anchor element to align the popup against. May automatically change to avoid collisions.

Type
| 'top'
| 'bottom'
| 'left'
| 'right'
| 'inline-end'
| 'inline-start'
| undefined
Default
'top'
sideOffsetnumber | OffsetFunction(default: 0)
Name
sideOffset
Description

Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment.

The function takes a data object parameter with the following properties:

  • data.anchor: the dimensions of the anchor element with properties width and height.
  • data.positioner: the dimensions of the positioner element with properties width and height.
  • data.side: which side of the anchor element the positioner is aligned against.
  • data.align: how the positioner is aligned relative to the specified side.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default
0
Example
<Positioner
  sideOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom'
      ? anchor.height
      : anchor.width;
  }}
/>
arrowPaddingnumber(default: 5)
Name
arrowPadding
Description

Minimum distance to maintain between the arrow and the edges of the popup.

Use it to prevent the arrow element from hanging out of the rounded corners of a popup.

Type
number | undefined
Default
5
anchorUnion
Name
anchor
Description

An element to position the popup against. By default, the popup will be positioned against the trigger.

Type
| Element
| React.RefObject<Element | null>
| VirtualElement
| (() => Element | VirtualElement | null)
| null
| undefined
collisionBoundaryBoundary(default: 'clipping-ancestors')
Name
collisionBoundary
Description

An element or a rectangle that delimits the area that the popup is confined to.

Type
| Element
| 'clipping-ancestors'
| Element[]
| Rect
| undefined
Default
'clipping-ancestors'
collisionPaddingPadding(default: 5)
Name
collisionPadding
Description

Additional space to maintain from the edge of the collision boundary.

Type
| {
    top?: number
    right?: number
    bottom?: number
    left?: number
  }
| number
| undefined
Default
5
stickyboolean(default: false)
Name
sticky
Description

Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.

Type
boolean | undefined
Default
false
positionMethod'fixed' | 'absolute'(default: 'absolute')
Name
positionMethod
Description

Determines which CSS position property to use.

Type
'fixed' | 'absolute' | undefined
Default
'absolute'
trackAnchorboolean(default: true)
Name
trackAnchor
Description

Whether the popup tracks any layout shift of its positioning anchor.

Type
boolean | undefined
Default
true
classNamestring | function
Name
className
Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: Tooltip.Positioner.State) => string)
renderReactElement | function
Name
render
Description

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Tooltip.Positioner.State,
  ) => ReactElement)
data-open
Present when the tooltip is open.
data-closed
Present when the tooltip is closed.
data-anchor-hidden
Present when the anchor is hidden.
data-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.
--anchor-height
The anchor's height.
--anchor-width
The anchor's width.
--available-height
The available height between the trigger and the edge of the viewport.
--available-width
The available width between the trigger and the edge of the viewport.
--transform-origin
The coordinates that this element is anchored to. Used for animations and transitions.

Popup

A container for the tooltip contents. Renders a <div> element.

classNamestring | function
Name
className
Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
string | ((state: Tooltip.Popup.State) => string)
renderReactElement | function
Name
render
Description

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Tooltip.Popup.State,
  ) => ReactElement)
data-open
Present when the tooltip is open.
data-closed
Present when the tooltip is closed.
data-align
Indicates how the popup is aligned relative to specified side.
data-instant
Present if animations should be instant.
data-side
Indicates which side the popup is positioned relative to the trigger.
data-starting-style
Present when the tooltip is animating in.
data-ending-style
Present when the tooltip is animating out.

Arrow

Displays an element positioned against the tooltip anchor. Renders a <div> element.

classNamestring | function
Name
className
Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
string | ((state: Tooltip.Arrow.State) => string)
renderReactElement | function
Name
render
Description

Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Tooltip.Arrow.State,
  ) => ReactElement)
data-open
Present when the tooltip is open.
data-closed
Present when the tooltip is closed.
data-uncentered
Present when the tooltip arrow is uncentered.
data-anchor-hidden
Present when the anchor is hidden.
data-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.