Common UI kit components
Confluence UI kit components
Jira UI kit components
Jira Service Management UI kit components

Rate this page:

Tooltip

A tooltip that displays when hovering over another component.

Screenshot of tooltip component

Import statement

1
2
import ForgeUI, { Tooltip } from '@forge/ui';

Props

NameTypeRequiredDescription
childrenForgeElementYesThe component to wrap the tooltip around.
textstringYesThe message to display in the tooltip.

Example

A tooltip wrapping a button component. Hovering over the button will display the tooltip with Hello World.

1
2
<Tooltip text="Hello World">
    <Button
       text="Hover over me"
       onClick={() => console.log("Hello World")}
    />
</Tooltip>

Rate this page: