@fayegram-ai/faye-ui/overlays/tooltip
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { TouchTooltip, Tooltip } from '@fayegram-ai/faye-ui/overlays/tooltip';Usage and behavior guide · API JSON
This entry declares a client boundary. Follow the rendering guide for framework integration.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
TouchTooltip | value | ({ children, content, open, defaultOpen, onOpenChange, disabled, longPressDelay, touchCloseDelay, moveTolerance, triggerProps, positionerProps, popupProps }: TouchTooltipProps) => import("react").JSX.Element |
Tooltip | value | { readonly Provider: import("react").FC<import("@base-ui/react").TooltipProviderProps>; readonly Root: <Payload>(props: Base.Root.Props<Payload>) => React.JSX.Element; readonly Trigger: { (input: Base.Trigger.Props<unknown> & import("react").RefAttributes<HTMLElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined; }): ReactElement; displayName: string; }; readonly Positioner: { (input: Omit<import("@base-ui/react").TooltipPositionerProps, "ref"> & import("react").RefAttributes<HTMLDivElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-… (full type in API JSON) |
TouchTooltipProps | type | TouchTooltipProps |
TouchTooltip
Touch hold supplements the existing hover/focus/dismissal engine. A normal tap still activates its control.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
children | Yes | ReactElement<unknown, string | JSXElementConstructor<any>> | See the usage contract and declaration. |
content | Yes | ReactNode | See the usage contract and declaration. |
defaultOpen | No | boolean | undefined | See the usage contract and declaration. |
disabled | No | boolean | undefined | See the usage contract and declaration. |
longPressDelay | No | number | undefined | See the usage contract and declaration. |
moveTolerance | No | number | undefined | See the usage contract and declaration. |
onOpenChange | No | ((open: boolean) => void) | undefined | See the usage contract and declaration. |
open | No | boolean | undefined | See the usage contract and declaration. |
popupProps | No | (Omit<TooltipPopupProps, "ref"> & RefAttributes<HTMLDivElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined; }) | undefined | See the usage contract and declaration. |
positionerProps | No | (Omit<TooltipPositionerProps, "ref"> & RefAttributes<HTMLDivElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined; }) | undefined | See the usage contract and declaration. |
touchCloseDelay | No | number | undefined | See the usage contract and declaration. |
triggerProps | No | (Base.Trigger.Props<unknown> & RefAttributes<HTMLElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined; }) | undefined | See the usage contract and declaration. |
Tooltip
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Tooltip.Provider
| Property | Required | Type | Meaning |
|---|---|---|---|
children | No | ReactNode | See the usage contract and declaration. |
closeDelay | No | number | undefined | How long to wait before closing a tooltip. Specified in milliseconds. |
delay | No | number | undefined | How long to wait before opening the tooltip on hover. Specified in milliseconds. |
timeout | No | number | undefined | Another tooltip will open instantly if the previous tooltip is closed within this timeout. Specified in milliseconds. |
Tooltip.Root
| Property | Required | Type | Meaning |
|---|---|---|---|
actionsRef | No | RefObject<TooltipRootActions | null> | undefined | A ref to imperative actions. - unmount: Unmounts the tooltip popup. - close: Closes the tooltip imperatively when called. |
children | No | ReactNode | PayloadChildRenderFunction<Payload> | The content of the tooltip. This can be a regular React node or a render function that receives the payload of the active trigger. |
defaultOpen | No | boolean | undefined | Whether the tooltip is initially open. To render a controlled tooltip, use the open prop instead. |
defaultTriggerId | No | string | null | undefined | 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. |
disabled | No | boolean | undefined | Whether the tooltip is disabled. |
disableHoverablePopup | No | boolean | undefined | Whether the tooltip contents can be hovered without closing the tooltip. |
handle | No | Base.Handle<Payload> | undefined | 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. |
onOpenChange | No | ((open: boolean, eventDetails: Base.Root.ChangeEventDetails) => void) | undefined | Event handler called when the tooltip is opened or closed. |
onOpenChangeComplete | No | ((open: boolean) => void) | undefined | Event handler called after any animations complete when the tooltip is opened or closed. |
open | No | boolean | undefined | Whether the tooltip is currently open. |
trackCursorAxis | No | "none" | "x" | "y" | "both" | undefined | Determines which axis the tooltip should track the cursor on. |
triggerId | No | string | null | undefined | 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). |
Tooltip.Trigger
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: TooltipTriggerState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
closeDelay | No | number | undefined | How long to wait before closing the tooltip. Specified in milliseconds. |
closeOnClick | No | boolean | undefined | Whether the tooltip should close when this trigger is clicked. |
delay | No | number | undefined | How long to wait before opening the tooltip on hover. Specified in milliseconds. |
disabled | No | boolean | undefined | If true, the tooltip will not open when interacting with this trigger. Note that this doesn't apply the disabled attribute to the trigger element. If you want to disable the trigger element itself, you can pass the disabled prop to the trigger element via the render prop. |
handle | No | Base.Handle<unknown> | undefined | A handle to associate the trigger with a tooltip. |
payload | No | unknown | A payload to pass to the tooltip when it is opened. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, TooltipTriggerState> | undefined | 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. |
style | No | CSSProperties | ((state: TooltipTriggerState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Tooltip.Positioner
| Property | Required | Type | Meaning |
|---|---|---|---|
align | No | Align | undefined | How to align the popup relative to the specified side. |
alignOffset | No | number | OffsetFunction | undefined | 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. |
anchor | No | Element | VirtualElement | RefObject<Element | null> | (() => Element | VirtualElement | null) | null | undefined | An element to position the popup against. By default, the popup will be positioned against the trigger. |
arrowPadding | No | number | undefined | 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. |
className | No | string | ((state: TooltipPositionerState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
collisionAvoidance | No | CollisionAvoidance | undefined | Determines how to handle collisions when positioning the popup. side controls overflow on the preferred placement axis (top/bottom or left/right): - 'flip': keep the requested side when it fits; otherwise try the opposite side (top and bottom, or left and right). - 'shift': never change side; keep the requested side and move the popup within the clipping boundary so it stays visible. - 'none': do not correct side-axis overflow. align controls overflow on the alignment axis (start/center/end): - 'flip': keep side, but swap start and end when the requested alignment overflows. - 'shift': keep side and requested alignment, then nudge the popup along the alignment axis to fit. - 'none': do not correct alignment-axis overflow. fallbackAxisSide controls fallback behavior on the perpendicular axis when the preferred axis cannot fit: - 'start': allow perpendicular fallback and try the logical start side first (top before bottom, or left before right in LTR). - 'end': allow perpendicular fallback and try the logical end side first (bottom before top, or right before left in LTR). - 'none': do not fallback to the perpendicular axis. When side is 'shift', explicitly setting align only supports 'shift' or 'none'. If align is omitted, it defaults to 'flip'. |
collisionBoundary | No | Boundary | undefined | An element or a rectangle that delimits the area that the popup is confined to. |
collisionPadding | No | Padding | undefined | Additional space to maintain from the edge of the collision boundary. |
disableAnchorTracking | No | boolean | undefined | Whether to disable the popup from tracking any layout shift of its positioning anchor. |
positionMethod | No | "absolute" | "fixed" | undefined | Determines which CSS position property to use. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, TooltipPositionerState> | undefined | 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. |
side | No | Side | undefined | Which side of the anchor element to align the popup against. May automatically change to avoid collisions. |
sideOffset | No | number | OffsetFunction | undefined | 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. |
sticky | No | boolean | undefined | Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. |
style | No | CSSProperties | ((state: TooltipPositionerState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Tooltip.Popup
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: TooltipPopupState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, TooltipPopupState> | undefined | 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. |
style | No | CSSProperties | ((state: TooltipPopupState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Tooltip.Arrow
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: TooltipArrowState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, TooltipArrowState> | undefined | 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. |
style | No | CSSProperties | ((state: TooltipArrowState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"tooltip", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Tooltip.Portal
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: TooltipPortalState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
container | No | HTMLElement | ShadowRoot | RefObject<HTMLElement | ShadowRoot | null> | null | undefined | A parent element to render the portal element into. |
keepMounted | No | boolean | undefined | Whether to keep the portal mounted in the DOM while the popup is hidden. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, TooltipPortalState> | undefined | 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. |
style | No | CSSProperties | ((state: TooltipPortalState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
Defaults and customization
Descriptor defaults: {"size":"md","tone":"neutral"}. Parts: trigger, positioner, popup, arrow. Explicit instance props take precedence over configured defaults.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/overlays/tooltip.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.