# Tooltip (/cloud/headless/tooltip) {/* Generated by scripts/sync-base-ui-reference.mjs. Edit the script, not this file. */} ## In Nyte [#in-nyte] ```ts title="Import" import { Tooltip } from "@nyte-ai/ui/tooltip"; ``` `@nyte-ai/ui/tooltip` re-exports the Base UI namespace unchanged. There is no Nyte styling on this subpath; the consumer owns every class, StyleX style, and layout decision. Base UI owns the interaction model, keyboard handling, focus management, and ARIA below. Consumed by: * `desktop/src/renderer/src/components/ui.tsx` * `desktop/src/renderer/src/router.tsx` The rest of this page is Base UI's documentation for `@base-ui/react/tooltip`, reproduced verbatim under the MIT license, © Material-UI SAS. Component paths in examples refer to the Base UI package; in Nyte, import from the subpath above. ## Usage guidelines [#usage-guidelines] * **Prefer using tooltips as visual labels only**: Tooltips should act as supplementary visual labels for sighted mouse and keyboard users. Tooltips alone are not accessible to touch or screen reader users. See [Alternatives to tooltips](#alternatives-to-tooltips) for more details. * **Provide an accessible name for the trigger**: Tooltips are visual-only elements and are not a replacement for labeling the trigger. The tooltip's trigger must have an `aria-label` attribute that closely matches the tooltip's content to ensure consistency for screen reader users. ## Anatomy [#anatomy] Import the component and assemble its parts: ```jsx title="Anatomy" import { Tooltip } from '@base-ui/react/tooltip'; ; ``` ## Alternatives to tooltips [#alternatives-to-tooltips] Tooltips should be supplementary popups that provide non-essential clarity in high-density UIs. A user should not miss critical information if they never see a tooltip. Tooltips don't work well with touch input. Unlike mouse pointers with hover capability, there's no easily discoverable way to reveal a tooltip before tapping its trigger on a touch device. iOS doesn't provide a system-standard, touch-friendly tooltip affordance, while Android may show a tooltip on long press. However, on the web, long press is often used to trigger contextual menus in the browser, which can lead to potential conflicts. For this reason, tooltips are disabled on touch devices. ### Infotips [#infotips] Popups that open when hovering an info icon should use [Popover](/react/components/popover) with the `openOnHover` prop on the trigger instead of a tooltip. This way, touch users and screen reader users can access the content. To know when to reach for a popover instead of a tooltip, consider the **purpose** of the trigger element: If the trigger's purpose is to open the popup itself, it's a popover. If the trigger's purpose is unrelated to opening the popup, it's a tooltip. ### Description text [#description-text] Tooltips are designed for sighted users and are not a reliable way to deliver important information to touch users or assistive technologies. If the description is important to understanding the element, don't hide it behind a tooltip — use inline text or [Popover](/react/components/popover) if space is limited, so the information is accessible to everyone. Since tooltips serve sighted mouse and keyboard users, iconography should clearly communicate the purpose of icon-only triggers, especially on mobile where the text label may not be visible. If the description is not critical, a tooltip can still be used to provide extra clarity for sighted mouse or keyboard users. ### Contextual feedback messages [#contextual-feedback-messages] Use the Toast component's [anchoring ability](/react/components/toast#anchored-toasts) for more ergonomic DX, to ensure the message is announced to screen readers, and to support complex content. ## Examples [#examples] ### Detached triggers [#detached-triggers] A tooltip can be controlled by a trigger located either inside or outside the `` component. For simple, one-off interactions, place the `` inside ``, as shown in the example at the top of this page. However, if defining the tooltip's content next to its trigger is not practical, you can use a detached trigger. This involves placing the `` outside of `` and linking them with a `handle` created by the `Tooltip.createHandle()` function. The imperative methods on the handle, such as `open()` and `close()`, require a `` using the same handle to be mounted. Calls made while no root is attached to the handle — before one mounts, or after it unmounts — are ignored. Each time a root mounts, it starts from fresh state: a call made while no root was attached is not replayed, and no open state carries over from a previous mount. ```jsx title="Detached triggers" const demoTooltip = Tooltip.createHandle(); // @highlight // @highlight-text "handle={demoTooltip}" Button // @highlight // @highlight-text "handle={demoTooltip}" ... ``` ### Multiple triggers [#multiple-triggers] A single tooltip can be opened by multiple trigger elements. You can achieve this by using the same `handle` for several detached triggers, or by placing multiple `` components inside a single ``. ```jsx title="Multiple triggers within the Root part" Trigger 1 Trigger 2 ... ``` ```jsx title="Multiple detached triggers" const demoTooltip = Tooltip.createHandle(); Trigger 1 Trigger 2 ... ``` The tooltip can render different content depending on which trigger opened it. This is achieved by passing a `payload` to the `` and using the function-as-a-child pattern in ``. The payload can be strongly typed by providing a type argument to the `createHandle()` function: ```jsx title="Detached triggers with payload" // @highlight const demoTooltip = Tooltip.createHandle<{ text: string }>(); // @highlight // @highlight-text "payload" Trigger 1 // @highlight // @highlight-text "payload" Trigger 2 {({ payload }) => ( // @highlight-text "payload" {payload !== undefined && ( {/* @highlight-text "payload" */} Tooltip opened by {payload.text} {/* @highlight-text "payload" */} )} )} ``` ### Controlled mode with multiple triggers [#controlled-mode-with-multiple-triggers] You can control the tooltip's open state externally using the `open` and `onOpenChange` props on ``. This allows you to manage the tooltip's visibility based on your application's state. When using multiple triggers, you have to manage which trigger is active with the `triggerId` prop on `` and the `id` prop on each ``. Note that there is no separate `onTriggerIdChange` prop. Instead, the `onOpenChange` callback receives an additional argument, `eventDetails`, which contains the trigger element that initiated the state change. ### Animating the Tooltip [#animating-the-tooltip] You can animate a tooltip as it moves between different trigger elements. This includes animating its position, size, and content. #### Position and Size [#position-and-size] To animate the tooltip's position, apply CSS transitions to the `left`, `right`, `top`, and `bottom` properties of the **Positioner** part. To animate its size, transition the `width` and `height` of the **Popup** part. #### Content [#content] The tooltip also supports content transitions. This is useful when different triggers display different content within the same tooltip. To enable content animations, wrap the content in the `` part. This part provides features to create direction-aware animations. It renders a `div` with a `data-activation-direction` attribute that indicates the new trigger's position relative to the previous one. The value is a space-separated set of up to two tokens (one per axis) — `left` or `right` for the horizontal axis and `up` or `down` for the vertical axis (for example, `right down`). Match a single token with the `~=` attribute selector, such as `[data-activation-direction~='right']`. Inside the ``, the content is further wrapped in `div`s with data attributes to help with styling: * `data-current`: The currently visible content when no transitions are present or the incoming content. * `data-previous`: The outgoing content during a transition. You can use these attributes to style the enter and exit animations. ## API reference [#api-reference] ### Root [#root] Groups all parts of the tooltip. Doesn't render its own HTML element. **Root Props:** | Prop | Type | Default | Description | | :-------------------- | :------------------------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | defaultOpen | `boolean` | `false` | Whether the tooltip is initially open. To render a controlled tooltip, use the `open` prop instead. | | open | `boolean` | - | Whether the tooltip is currently open. | | onOpenChange | `((open: boolean, eventDetails: Tooltip.Root.ChangeEventDetails) => void)` | - | Event handler called when the tooltip is opened or closed. | | actionsRef | `React.RefObject` | - | A ref to imperative actions. `unmount`: Unmounts the tooltip popup.`close`: Closes the tooltip imperatively when called. | | defaultTriggerId | `string \| null` | - | ID of the trigger that the tooltip is associated with. This is useful in conjunction with the `defaultOpen` prop to create an initially open tooltip. | | handle | `Tooltip.Handle` | - | A handle to associate the tooltip with a trigger. If specified, allows external triggers to control the tooltip's open state. Can be created with the Tooltip.createHandle() method. | | onOpenChangeComplete | `((open: boolean) => void)` | - | Event handler called after any animations complete when the tooltip is opened or closed. | | triggerId | `string \| null` | - | ID of the trigger that the tooltip is associated with. This is useful in conjunction with the `open` prop to create a controlled tooltip. There's no need to specify this prop when the tooltip is uncontrolled (that is, when the `open` prop is not set). | | trackCursorAxis | `'none' \| 'x' \| 'y' \| 'both'` | `'none'` | Determines which axis the tooltip should track the cursor on. | | disabled | `boolean` | `false` | Whether the tooltip is disabled. | | disableHoverablePopup | `boolean` | `false` | Whether the tooltip contents can be hovered without closing the tooltip. | | children | `React.ReactNode \| PayloadChildRenderFunction` | - | The content of the tooltip. This can be a regular React node or a render function that receives the `payload` of the active trigger. | ### Root.Props [#rootprops] Re-export of [Root](#root) props. ### Root.State [#rootstate] ```typescript type TooltipRootState = {}; ``` ### Root.Actions [#rootactions] ```typescript type TooltipRootActions = { unmount: () => void; close: () => void }; ``` ### Root.ChangeEventReason [#rootchangeeventreason] ```typescript type TooltipRootChangeEventReason = | 'trigger-hover' | 'trigger-focus' | 'trigger-press' | 'outside-press' | 'escape-key' | 'disabled' | 'imperative-action' | 'none'; ``` ### Root.ChangeEventDetails [#rootchangeeventdetails] ```typescript type TooltipRootChangeEventDetails = ( | { reason: 'trigger-hover'; event: MouseEvent } | { reason: 'trigger-focus'; event: FocusEvent } | { reason: 'trigger-press'; event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent } | { reason: 'outside-press'; event: MouseEvent | PointerEvent | TouchEvent } | { reason: 'escape-key'; event: KeyboardEvent } | { reason: 'disabled'; event: Event } | { reason: 'imperative-action'; event: Event } | { reason: 'none'; event: Event } ) & { /** Cancels Base UI from handling the event. */ cancel: () => void; /** Allows the event to propagate in cases where Base UI will stop the propagation. */ allowPropagation: () => void; /** Indicates whether the event has been canceled. */ isCanceled: boolean; /** Indicates whether the event is allowed to propagate. */ isPropagationAllowed: boolean; /** The element that triggered the event, if applicable. */ trigger: Element | undefined; preventUnmountOnClose: preventUnmountOnClose; }; ``` ### Provider [#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 | Description | | :--------- | :---------------- | :------ | :------------------------------------------------------------------------------------------------------------------------ | | delay | `number` | - | How long to wait before opening the tooltip on hover. Specified in milliseconds. | | closeDelay | `number` | - | How long to wait before closing a tooltip. Specified in milliseconds. | | timeout | `number` | `400` | Another tooltip will open instantly if the previous tooltip is closed within this timeout. Specified in milliseconds. | | children | `React.ReactNode` | - | - | ### Provider.Props [#providerprops] Re-export of [Provider](#provider) props. ### Provider.State [#providerstate] ```typescript type TooltipProviderState = {}; ``` ### Trigger [#trigger] An element to attach the tooltip to. Renders a `