TooltipProvider

Provides a tooltip store to Tooltip components.

Code examples

<TooltipProvider timeout={250}>
  <TooltipAnchor />
  <Tooltip />
</TooltipProvider>
<TooltipProvider timeout={250}>
  <TooltipAnchor />
  <Tooltip />
</TooltipProvider>

Optional Props

`defaultOpen`

boolean | undefined = false
boolean | undefined = false

Whether the content should be visible by default.

`disclosure`

DisclosureStore | null | undefined
DisclosureStore | null | undefined

A reference to another disclosure store that controls another disclosure component to keep them in sync. Element states like contentElement and disclosureElement won't be synced. For that, use the store prop instead.

Live examples

Command MenuCombining Dialog and Combobox to enable users to search a command list in a Raycast-style modal.

Command Menu with TabsCombining Dialog, Tab, and Combobox from Ariakit React to build a command palette component.

`hideTimeout`

number | undefined = 0
number | undefined = 0

The amount of time in milliseconds to wait before hiding the popup. It defaults to the value passed to timeout.

Live examples

Navigation MenubarUsing Menubar, Menu, and Portal to create an accessible, tabbable navigation menu widget with links and menu buttons that expand on hover and focus.

Tooltip with Framer MotionAbstracting Tooltip into a reusable custom component that uses Framer Motion to create smooth initial and exit animations.

`open`

boolean = false
boolean = false

Whether the content is visible.

Live examples

Combobox with linksUsing a Combobox with items rendered as links that can be clicked with keyboard and mouse. This is useful for creating an accessible page search input in React.

Dialog with React RouterUsing React Router to create a modal Dialog that's controlled by the browser history.

Menu with Framer MotionAbstracting Menu into a reusable dropdown menu component that uses Framer Motion to create smooth initial and exit animations.

Lazy PopoverLazy loading Popover using React.lazy and React.useTransition to avoid downloading additional code until the user interacts with the button.

`placement`

Placement = "top"
Placement = "top"

The placement of the popover.

Live examples

Submenu with ComboboxNesting Notion-style dropdown menus with search & autocomplete features by combining Menu with Combobox.

Sliding MenuRendering nested Menu components to create submenus that slide in and out using CSS Scroll Snap.

Navigation MenubarUsing Menubar, Menu, and Portal to create an accessible, tabbable navigation menu widget with links and menu buttons that expand on hover and focus.

Selection PopoverShowing an inline Popover when a text is selected. This example uses the getAnchorRect prop to position the flyout relative to the selected text.

Standalone PopoverAbstracting the Popover component so that it can be used without PopoverDisclosure or PopoverAnchor. This example uses the getAnchorRect prop to determine the position of the popup.

Select GridUsing Select with SelectPopover rendered with the grid role to create a bidimensional list of selectable items.

`popover`

PopoverStore | null | undefined
PopoverStore | null | undefined

A reference to another popover store that's controlling another popover to keep them in sync.

`setMounted`

((mounted: boolean) => void) | undefined
((mounted: boolean) => void) | undefined

A callback that gets called when the mounted state changes.

Code examples

const [mounted, setMounted] = useState(false);
const disclosure = useDisclosureStore({ setMounted });
const [mounted, setMounted] = useState(false);
const disclosure = useDisclosureStore({ setMounted });

`setOpen`

((open: boolean) => void) | undefined
((open: boolean) => void) | undefined

A callback that gets called when the open state changes.

Code examples

const [open, setOpen] = useState(false);
const disclosure = useDisclosureStore({ open, setOpen });
const [open, setOpen] = useState(false);
const disclosure = useDisclosureStore({ open, setOpen });

`showTimeout`

number | undefined
number | undefined

The amount of time in milliseconds to wait before showing the popup. It defaults to the value passed to timeout.

Live examples

Navigation MenubarUsing Menubar, Menu, and Portal to create an accessible, tabbable navigation menu widget with links and menu buttons that expand on hover and focus.

Submenu with ComboboxNesting Notion-style dropdown menus with search & autocomplete features by combining Menu with Combobox.

`skipTimeout`

number = 300
number = 300

The amount of time after a tooltip is hidden while all tooltips on the page can be shown immediately, without waiting for the show timeout.

`store`

Store<Partial<S>> | undefined
Store<Partial<S>> | undefined

Another store object that will be kept in sync with the original store.

Live examples

Navigation MenubarUsing Menubar, Menu, and Portal to create an accessible, tabbable navigation menu widget with links and menu buttons that expand on hover and focus.

`timeout`

number = 500
number = 500

The amount of time in milliseconds to wait before showing and hiding the popup. To control the delay for showing and hiding separately, use showTimeout and hideTimeout.

`animated`

number | boolean | undefined
number | boolean | undefined

Deprecated: Manually setting the animated prop is no longer necessary. This will be removed in a future release.

Determines whether the content should animate when it is shown or hidden.

If true, the animating state will be true when the content is shown or hidden and it will wait for a CSS animation/transition to end before becoming false.
If it's set to a number, the animating state will be true when the content is shown or hidden and it will wait for the number of milliseconds to pass before becoming false.

`type`

"label" | "description" = "description"
"label" | "description" = "description"

Deprecated: Render a visually hidden label or use the aria-label or aria-labelledby attributes on the anchor element instead.

Determines whether the tooltip is being used as a label or a description for the anchor element.

TooltipProvider

Live examples

Live examples

Live examples

Live examples

Code examples

Code examples

Live examples

Live examples

Stay tuned