ComponentsTooltip
Tooltip
The Tooltip is a flexible and handy component that provides additional information when users hover over an element. It is perfect for scenarios where you need to offer users tips or help text.
The Tooltip is a flexible and handy component that provides additional information when users hover over an element. It is perfect for scenarios where you need to offer users tips or help text.
API reference docs for the component. Learn about the props, CSS, and other APIs of this exported module.
string
Custom label for the tooltip.
number
The close delay of the tooltip.
boolean
Whether to close the tooltip when the Escape key is pressed.
boolean
Whether to close the tooltip on pointerdown.
boolean
Whether the tooltip is disabled
() => ShadowRoot | Node | Document
A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.
string
The `id` of the tooltip.
Partial<{ trigger: string content: string arrow: string positioner: string }>
The ids of the elements in the tooltip. Useful for composition.
boolean
Whether the tooltip's content is interactive. In this mode, the tooltip will remain open when user hovers over the content.
(details: OpenChangeDetails) => void
Function called when the tooltip is opened.
boolean
Whether the tooltip is open
number
The open delay of the tooltip.
PositioningOptions
The user provided options used to position the popover content
Dict<any>
Dict<any>
() => void
Function to close the tooltip.
Dict<any>
boolean
Whether the tooltip is open.
() => void
Function to open the tooltip.
Dict<any>
(options?: Partial<PositioningOptions> | undefined) => void
Function to reposition the popover
Dict<any>
boolean
Whether to enable lazy mounting. Defaults to `false`.
() => void
boolean
boolean
Whether to unmount on exit. Defaults to `false`.