A popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it.
Provider to control display delay globally.
Opens when the trigger is focused or hovered.
Closes when the trigger is activated or when pressing escape.
Supports custom timings.
Install the component from your command line.
npm install @radix-ui/react-tooltip
Import all parts and piece them together.
import * as Tooltip from '@radix-ui/react-tooltip';
export default () => (
<Tooltip.Provider>
<Tooltip.Root>
<Tooltip.Trigger />
<Tooltip.Portal>
<Tooltip.Content>
<Tooltip.Arrow />
</Tooltip.Content>
</Tooltip.Portal>
</Tooltip.Root>
</Tooltip.Provider>
);
Wraps your app to provide global functionality to your tooltips.
Contains all the parts of a tooltip.
The button that toggles the tooltip. By default, the Tooltip.Content
will position itself against the trigger.
When used, portals the content part into the body
.
The component that pops out when the tooltip is open.
An optional arrow element to render alongside the tooltip. This can be used to help visually link the trigger with the Tooltip.Content
. Must be rendered inside Tooltip.Content
.
Use the Provider
to control delayDuration
and skipDelayDuration
globally.
import * as Tooltip from '@radix-ui/react-tooltip';
export default () => (
<Tooltip.Provider delayDuration={800} skipDelayDuration={500}>
<Tooltip.Root>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Content>…</Tooltip.Content>
</Tooltip.Root>
<Tooltip.Root>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Content>…</Tooltip.Content>
</Tooltip.Root>
</Tooltip.Provider>
);
Use the delayDuration
prop to control the time it takes for the tooltip to open.
import * as Tooltip from '@radix-ui/react-tooltip';
export default () => (
<Tooltip.Root delayDuration={0}>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Content>…</Tooltip.Content>
</Tooltip.Root>
);
Since disabled buttons don't fire events, you need to:
Trigger
as span
.button
has no pointerEvents
.import * as Tooltip from '@radix-ui/react-tooltip';
export default () => (
<Tooltip.Root>
<Tooltip.Trigger asChild>
<span tabIndex={0}>
<button disabled style={{ pointerEvents: 'none' }}>
…
</button>
</span>
</Tooltip.Trigger>
<Tooltip.Content>…</Tooltip.Content>
</Tooltip.Root>
);
You may want to constrain the width of the content so that it matches the trigger width. You may also want to constrain its height to not exceed the viewport.
We expose several CSS custom properties such as --radix-tooltip-trigger-width
and --radix-tooltip-content-available-height
to support this. Use them to constrain the content dimensions.
// index.jsx
import * as Tooltip from '@radix-ui/react-tooltip';
import './styles.css';
export default () => (
<Tooltip.Root>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Portal>
<Tooltip.Content className="TooltipContent" sideOffset={5}>
…
</Tooltip.Content>
</Tooltip.Portal>
</Tooltip.Root>
);
/* styles.css */
.TooltipContent {
width: var(--radix-tooltip-trigger-width);
max-height: var(--radix-tooltip-content-available-height);
}
We expose a CSS custom property --radix-tooltip-content-transform-origin
. Use it to animate the content from its computed origin based on side
, sideOffset
, align
, alignOffset
and any collisions.
// index.jsx
import * as Tooltip from '@radix-ui/react-tooltip';
import './styles.css';
export default () => (
<Tooltip.Root>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Content className="TooltipContent">…</Tooltip.Content>
</Tooltip.Root>
);
/* styles.css */
.TooltipContent {
transform-origin: var(--radix-tooltip-content-transform-origin);
animation: scaleIn 0.5s ease-out;
}
@keyframes scaleIn {
from {
opacity: 0;
transform: scale(0);
}
to {
opacity: 1;
transform: scale(1);
}
}
We expose data-side
and data-align
attributes. Their values will change at runtime to reflect collisions. Use them to create collision and direction-aware animations.
// index.jsx
import * as Tooltip from '@radix-ui/react-tooltip';
import './styles.css';
export default () => (
<Tooltip.Root>
<Tooltip.Trigger>…</Tooltip.Trigger>
<Tooltip.Content className="TooltipContent">…</Tooltip.Content>
</Tooltip.Root>
);
/* styles.css */
.TooltipContent {
animation-duration: 0.6s;
animation-timing-function: cubic-bezier(0.16, 1, 0.3, 1);
}
.TooltipContent[data-side='top'] {
animation-name: slideUp;
}
.TooltipContent[data-side='bottom'] {
animation-name: slideDown;
}
@keyframes slideDown {
from {
opacity: 0;
transform: translateY(-10px);
}
to {
opacity: 1;
transform: translateY(0);
}
}
@keyframes slideUp {
from {
opacity: 0;
transform: translateY(10px);
}
to {
opacity: 1;
transform: translateY(0);
}
}
Create your own API by abstracting the primitive parts into your own component.
This example abstracts all of the Tooltip
parts and introduces a new content
prop.
import { Tooltip } from './your-tooltip';
export default () => (
<Tooltip content="Tooltip content">
<button>Tooltip trigger</button>
</Tooltip>
);
Use the asChild
prop to convert the trigger part into a slottable area. It will replace the trigger with the child that gets passed to it.
// your-tooltip.jsx
import React from 'react';
import * as TooltipPrimitive from '@radix-ui/react-tooltip';
export function Tooltip({
children,
content,
open,
defaultOpen,
onOpenChange,
...props
}) {
return (
<TooltipPrimitive.Root
open={open}
defaultOpen={defaultOpen}
onOpenChange={onOpenChange}
>
<TooltipPrimitive.Trigger asChild>
{children}
</TooltipPrimitive.Trigger>
<TooltipPrimitive.Content side="top" align="center" {...props}>
{content}
<TooltipPrimitive.Arrow width={11} height={5} />
</TooltipPrimitive.Content>
</TooltipPrimitive.Root>
);
}