OverlaysReact

Tooltip

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

Rendered by React 19.3.1

import { Tooltip } from '@hamur/react/tooltip'

export default function TooltipExample() {
  return (
    <Tooltip.Provider>
      <Tooltip.Root>
        <Tooltip.Trigger className="button" aria-label="Bold">
          B
        </Tooltip.Trigger>
        <Tooltip.Portal>
          <Tooltip.Positioner sideOffset={8}>
            <Tooltip.Popup className="tooltip">
              <Tooltip.Arrow className="arrow" />
              Bold
            </Tooltip.Popup>
          </Tooltip.Positioner>
        </Tooltip.Portal>
      </Tooltip.Root>
    </Tooltip.Provider>
  )
}

660Tests passing in React · 0 failing

41.3 KiBSize

1.90 msOpen

17.3 msClose

16.0 msOpenMutations

11.0 msCloseMutations

1.07 MiBMemory

productdevbook and 18 upstream authors11 commits · last Nov 4

Installation

npm i @hamur/react

Not on npm yet. The package goes out under the chosen name.

Anatomy

Import the component and assemble its parts:

<Tooltip.Provider>
  <Tooltip.Root>
    <Tooltip.Trigger />
    <Tooltip.Portal>
      <Tooltip.Positioner>
        <Tooltip.Popup>
          <Tooltip.Arrow />
        </Tooltip.Popup>
      </Tooltip.Positioner>
    </Tooltip.Portal>
  </Tooltip.Root>
</Tooltip.Provider>

// Not in this example: Tooltip.Viewport

Examples

A Trigger outside Root is tied to it with a handle.

TooltipDetachedTriggersSimple.tsx

import { Tooltip } from '@hamur/react/tooltip'

const demoTooltip = Tooltip.createHandle()

export default function TooltipDetachedTriggersSimpleExample() {
  return (
    <Tooltip.Provider>
      <Tooltip.Trigger className="icon-square" handle={demoTooltip} aria-label="Delete">
        <TrashIcon />
      </Tooltip.Trigger>

      <Tooltip.Root handle={demoTooltip}>
        <Tooltip.Portal>
          <Tooltip.Positioner sideOffset={11}>
            <Tooltip.Popup className="tooltip">
              <Tooltip.Arrow className="arrow" />
              Delete
            </Tooltip.Popup>
          </Tooltip.Positioner>
        </Tooltip.Portal>
      </Tooltip.Root>
    </Tooltip.Provider>
  )
}

function TrashIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      strokeLinejoin="round"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <path strokeLinecap="square" d="M2.5 4h11" />
      <path strokeLinecap="round" d="M6.5 4V3c0-.82843.67157-1.5 1.5-1.5s1.5.67157 1.5 1.5v1" />
      <path
        strokeLinecap="square"
        d="m3.5 4 .87069 9.1422c.07332.7699.7199 1.3578 1.49324 1.3578h4.27217c.7733 0 1.4199-.5879 1.4932-1.3578L12.5 4"
      />
    </svg>
  )
}

open, onOpenChange and triggerId control one tooltip from several triggers.

TooltipDetachedTriggersControlled.tsx

import * as React from 'react'
import { Tooltip } from '@hamur/react/tooltip'

const demoTooltip = Tooltip.createHandle()

export default function TooltipDetachedTriggersControlledExample() {
  const [open, setOpen] = React.useState(false)
  const [triggerId, setTriggerId] = React.useState<string | null>(null)

  const handleOpenChange = (isOpen: boolean, eventDetails: Tooltip.Root.ChangeEventDetails) => {
    setOpen(isOpen)
    setTriggerId(eventDetails.trigger?.id ?? null)
  }

  return (
    <Tooltip.Provider>
      <div className="row">
        <div className="icon-square-group">
          <Tooltip.Trigger
            className="icon-square"
            handle={demoTooltip}
            id="trigger-1"
            aria-label="Trigger 1"
          >
            <HeadphonesIcon />
          </Tooltip.Trigger>

          <Tooltip.Trigger
            className="icon-square"
            handle={demoTooltip}
            id="trigger-2"
            aria-label="Trigger 2"
          >
            <StopwatchIcon />
          </Tooltip.Trigger>

          <Tooltip.Trigger
            className="icon-square"
            handle={demoTooltip}
            id="trigger-3"
            aria-label="Trigger 3"
          >
            <TrashIcon />
          </Tooltip.Trigger>
        </div>

        <button
          type="button"
          className="button"
          onClick={() => {
            setTriggerId('trigger-2')
            setOpen(true)
          }}
        >
          Open programmatically
        </button>
      </div>

      <Tooltip.Root
        handle={demoTooltip}
        open={open}
        onOpenChange={handleOpenChange}
        triggerId={triggerId}
      >
        <Tooltip.Portal>
          <Tooltip.Positioner sideOffset={11}>
            <Tooltip.Popup className="tooltip">
              <Tooltip.Arrow className="arrow" />
              Controlled tooltip
            </Tooltip.Popup>
          </Tooltip.Positioner>
        </Tooltip.Portal>
      </Tooltip.Root>
    </Tooltip.Provider>
  )
}

function HeadphonesIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <path strokeLinecap="round" d="M1.5 11V7.5c0-2.5 2.5-6 6.5-6s6.5 3.5 6.5 6V11" />
      <path d="M12 7.5c1.3807 0 2.5 1.11929 2.5 2.5v2c0 1.3807-1.1193 2.5-2.5 2.5h-1.5v-7zm-8 0h1.5v7H4c-1.38071 0-2.5-1.1193-2.5-2.5v-2c0-1.38071 1.11929-2.5 2.5-2.5Z" />
    </svg>
  )
}

function StopwatchIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <circle cx="8" cy="8.5" r="6" />
      <path
        strokeLinecap="square"
        strokeLinejoin="round"
        d="M8 9.5v-5m0-2v-2m-2 0h4M12 4l1.5-1.5"
      />
    </svg>
  )
}

function TrashIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      strokeLinejoin="round"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <path strokeLinecap="square" d="M2.5 4h11" />
      <path strokeLinecap="round" d="M6.5 4V3c0-.82843.67157-1.5 1.5-1.5s1.5.67157 1.5 1.5v1" />
      <path
        strokeLinecap="square"
        d="m3.5 4 .87069 9.1422c.07332.7699.7199 1.3578 1.49324 1.3578h4.27217c.7733 0 1.4199-.5879 1.4932-1.3578L12.5 4"
      />
    </svg>
  )
}

Viewport animates the content as the tooltip moves between triggers.

TooltipDetachedTriggersFull.tsx

import { Tooltip } from '@hamur/react/tooltip'

const demoTooltip = Tooltip.createHandle<string>()

export default function TooltipDetachedTriggersFullExample() {
  return (
    <Tooltip.Provider>
      <div className="icon-square-group">
        <Tooltip.Trigger
          className="icon-square"
          handle={demoTooltip}
          payload="Listen to audio preview"
          aria-label="Listen to audio preview"
        >
          <HeadphonesIcon />
        </Tooltip.Trigger>

        <Tooltip.Trigger
          className="icon-square"
          handle={demoTooltip}
          payload="Set a timer"
          aria-label="Set a timer"
        >
          <StopwatchIcon />
        </Tooltip.Trigger>

        <Tooltip.Trigger
          className="icon-square"
          handle={demoTooltip}
          payload="Delete: This action cannot be undone"
          aria-label="Delete: This action cannot be undone"
        >
          <TrashIcon />
        </Tooltip.Trigger>
      </div>

      <Tooltip.Root handle={demoTooltip}>
        {({ payload }) => (
          <Tooltip.Portal>
            <Tooltip.Positioner sideOffset={11} className="popup-morph-positioner">
              <Tooltip.Popup className="tooltip popup-morph">
                <Tooltip.Arrow className="arrow" />

                <Tooltip.Viewport className="popup-morph-viewport">{payload}</Tooltip.Viewport>
              </Tooltip.Popup>
            </Tooltip.Positioner>
          </Tooltip.Portal>
        )}
      </Tooltip.Root>
    </Tooltip.Provider>
  )
}

function HeadphonesIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <path strokeLinecap="round" d="M1.5 11V7.5c0-2.5 2.5-6 6.5-6s6.5 3.5 6.5 6V11" />
      <path d="M12 7.5c1.3807 0 2.5 1.11929 2.5 2.5v2c0 1.3807-1.1193 2.5-2.5 2.5h-1.5v-7zm-8 0h1.5v7H4c-1.38071 0-2.5-1.1193-2.5-2.5v-2c0-1.38071 1.11929-2.5 2.5-2.5Z" />
    </svg>
  )
}

function StopwatchIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <circle cx="8" cy="8.5" r="6" />
      <path
        strokeLinecap="square"
        strokeLinejoin="round"
        d="M8 9.5v-5m0-2v-2m-2 0h4M12 4l1.5-1.5"
      />
    </svg>
  )
}

function TrashIcon() {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      strokeLinejoin="round"
      aria-hidden="true"
      style={{ display: 'block' }}
    >
      <path strokeLinecap="square" d="M2.5 4h11" />
      <path strokeLinecap="round" d="M6.5 4V3c0-.82843.67157-1.5 1.5-1.5s1.5.67157 1.5 1.5v1" />
      <path
        strokeLinecap="square"
        d="m3.5 4 .87069 9.1422c.07332.7699.7199 1.3578 1.49324 1.3578h4.27217c.7733 0 1.4199-.5879 1.4932-1.3578L12.5 4"
      />
    </svg>
  )
}

API reference

37 props across 8 parts, in React syntax. className, style, render are listed once, under Shared props.

Arrow`Tooltip.Arrow`

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

Arrow data attributes
Data attribute	Description
`data-open`	Present when the tooltip is open.
`data-closed`	Present when the tooltip is closed.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-uncentered`	Present when the tooltip arrow is uncentered.
`data-instant`	Present if animations should be instant.

Popup`Tooltip.Popup`

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

Popup data attributes
Data attribute	Description
`data-open`	Present when the tooltip is open.
`data-closed`	Present when the tooltip is closed.
`data-starting-style`	Present when the tooltip begins animating in.
`data-ending-style`	Present when the tooltip is animating out.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-instant`	Present if animations should be instant.

Portal`Tooltip.Portal`

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

Portal props
Prop	Type	Default
`container`A parent element to render the portal element into.	`HTMLElement \| ShadowRoot \| React.RefObject<HTMLElement \| ShadowRoot \| null> \| null`	`—`
`keepMounted`Whether to keep the portal mounted in the DOM while the popup is hidden.	`boolean`	`false`

Positioner`Tooltip.Positioner`

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

Positioner props
Prop	Type	Default
`disableAnchorTracking`Whether to disable the popup from tracking any layout shift of its positioning anchor.	`boolean`	`false`
`align`How to align the popup relative to the specified side.	`Align`	`'center'`
`alignOffset`Additional offset along the alignment axis in pixels.	`number \| OffsetFunction`	`0`
`side`Which side of the anchor element to align the popup against.	`Side`	`'top'`
`sideOffset`Distance between the anchor and the popup in pixels.	`number \| OffsetFunction`	`0`
`arrowPadding`Minimum distance to maintain between the arrow and the edges of the popup.	`number`	`5`
`anchor`An element to position the popup against.	`Element \| VirtualElement \| React.RefObject<Element \| null> \| (() => Element \| VirtualElement \| null) \| null`	`—`
`collisionAvoidance`Determines how to handle collisions when positioning the popup.	`CollisionAvoidance`	`—`
`collisionBoundary`An element or a rectangle that delimits the area that the popup is confined to.	`Boundary`	`'clipping-ancestors'`
`collisionPadding`Additional space to maintain from the edge of the collision boundary.	`Padding`	`5`
`sticky`Whether to maintain the popup in the viewport after	`boolean`	`false`
`positionMethod`Determines which CSS `position` property to use.	`"absolute" \| "fixed"`	`'absolute'`

Positioner data attributes
Data attribute	Description
`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-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.

Positioner CSS variables
CSS variable	Description
`--available-width`	The available width between the trigger and the edge of the viewport.
`--available-height`	The available height between the trigger and the edge of the viewport.
`--anchor-width`	The anchor's width.
`--anchor-height`	The anchor's height.
`--transform-origin`	The coordinates that this element is anchored to. Used for animations and transitions.
`--positioner-width`	The width of the tooltip's positioner. It is important to set `width` to this value when using CSS to animate size changes.
`--positioner-height`	The height of the tooltip's positioner. It is important to set `height` to this value when using CSS to animate size changes.

Provider`Tooltip.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.

Provider props
Prop	Type	Default
`delay`How long to wait before opening the tooltip on hover.	`number`	`—`
`closeDelay`How long to wait before closing a tooltip.	`number`	`—`
`timeout`Another tooltip will open instantly if the previous tooltip	`number`	`400`
`children`	`React.ReactNode`	`—`

Root`Tooltip.Root`

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

Root props
Prop	Type	Default
`defaultOpen`Whether the tooltip is initially open.	`boolean`	`false`
`open`Whether the tooltip is currently open.	`boolean`	`—`
`onOpenChange`Event handler called when the tooltip is opened or closed.	`((open: boolean, eventDetails: TooltipRootChangeEventDetails) => void)`	`—`
`actionsRef`A ref to imperative actions.	`React.RefObject<TooltipRootActions \| null>`	`—`
`defaultTriggerId`ID of the trigger that the tooltip is associated with.	`string \| null`	`—`
`handle`A handle to associate the tooltip with a trigger.	`TooltipHandle<Payload>`	`—`
`onOpenChangeComplete`Event handler called after any animations complete when the tooltip is opened or closed.	`((open: boolean) => void)`	`—`
`triggerId`ID of the trigger that the tooltip is associated with.	`string \| null`	`—`
`trackCursorAxis`Determines which axis the tooltip should track the cursor on.	`"none" \| "both" \| "x" \| "y"`	`'none'`
`disabled`Whether the tooltip is disabled.	`boolean`	`false`
`disableHoverablePopup`Whether the tooltip contents can be hovered without closing the tooltip.	`boolean`	`false`
`children`The content of the tooltip.	`React.ReactNode \| PayloadChildRenderFunction<Payload>`	`—`

Trigger`Tooltip.Trigger`

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

Trigger props
Prop	Type	Default
`closeOnClick`Whether the tooltip should close when this trigger is clicked.	`boolean`	`true`
`handle`A handle to associate the trigger with a tooltip.	`TooltipHandle<Payload>`	`—`
`payload`A payload to pass to the tooltip when it is opened.	`Payload`	`—`
`disabled`If `true`, the tooltip will not open when interacting with this trigger.	`boolean`	`false`
`delay`How long to wait before opening the tooltip on hover.	`number`	`600`
`closeDelay`How long to wait before closing the tooltip.	`number`	`0`

Trigger data attributes
Data attribute	Description
`data-popup-open`	Present when the corresponding tooltip is open.
`data-trigger-disabled`	Present when the trigger is disabled, either by the `disabled` prop or by a parent `<Tooltip.Root>` component.

Viewport`Tooltip.Viewport`

A viewport for displaying content transitions. This component is only required if one popup can be opened by multiple triggers, its content changes based on the trigger, and switching between them is animated. Renders a <div>.

Viewport props
Prop	Type	Default
`children`The content to render inside the transition container.	`React.ReactNode`	`—`

Viewport data attributes
Data attribute	Description
`data-current`	Applied to the direct child of the viewport when no transitions are present or the new content when it's entering.
`data-previous`	Applied to the direct child of the viewport that contains the exiting content when transitions are present.
`data-activation-direction`	Indicates the direction from which the popup was activated. This can be used to create directional animations based on how the popup was triggered. Contains space-separated values for both horizontal and vertical axes.
`data-transitioning`	Indicates that the viewport is currently transitioning between old and new content.
`data-instant`	Present if animations should be instant.

Viewport CSS variables
CSS variable	Description
`--popup-width`	The width of the parent popup. This variable is placed on the 'previous' container and stores the width of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content.
`--popup-height`	The height of the parent popup. This variable is placed on the 'previous' container and stores the height of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content.

Shared props

Every part that renders an element takes these.

Shared props
Prop	Type
`className`CSS class applied to the element, or a function that returns a class based on the component's state.	`string \| ((state: State) => string \| undefined)`
`style`Style applied to the element, or a function that returns a style object based on the component's state.	`React.CSSProperties \| ((state: State) => React.CSSProperties \| undefined)`
`render`Allows you to replace the component's HTML element with a different tag, or compose it with another component.	`React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, State>`

Keyboard and accessibility

Keyboard

Keyboard
Keys	Does	Part
`Tab`	Focusing Trigger opens the tooltip	Trigger
`Escape`	Closes the tooltip	Popup

Accessibility

What the parts set
Part	Sets	So that
Popup	no role and no link to Trigger	the hint is not read twice; touch and screen reader users do not depend on it
Trigger	needs an `aria-label` that matches the tooltip's text	every user gets the same name for the control
Arrow	`aria-hidden="true"`	the decorative arrow is not read

Focus order

Trigger is the tab stop; focus never moves into Popup.
Focusing Trigger opens the tooltip, and leaving it or pressing Escape closes it.

Tooltip

Installation

Anatomy

Examples

Detached Triggers Simple

Detached Triggers Controlled

Detached Triggers Full

API reference

Arrow`Tooltip.Arrow`

Portal`Tooltip.Portal`

Positioner`Tooltip.Positioner`

Provider`Tooltip.Provider`

Root`Tooltip.Root`

Trigger`Tooltip.Trigger`

Viewport`Tooltip.Viewport`

Shared props

Keyboard and accessibility

Keyboard

Accessibility

Focus order

Installation

Anatomy

Examples

Detached Triggers Simple

Detached Triggers Controlled

Detached Triggers Full

API reference

ArrowTooltip.Arrow

PopupTooltip.Popup

PortalTooltip.Portal

PositionerTooltip.Positioner

ProviderTooltip.Provider

RootTooltip.Root

TriggerTooltip.Trigger

ViewportTooltip.Viewport

Shared props

Keyboard and accessibility

Keyboard

Accessibility

Focus order

Arrow`Tooltip.Arrow`

Popup`Tooltip.Popup`

Portal`Tooltip.Portal`

Positioner`Tooltip.Positioner`

Provider`Tooltip.Provider`

Root`Tooltip.Root`

Trigger`Tooltip.Trigger`

Viewport`Tooltip.Viewport`