Tooltip

This page describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

To add the Tooltip component to your app:

1
2
import { Tooltip } from '@forge/react';

Description

A tooltip that displays when hovering over another component.

Props

Name	Type	Required	Description
`children`	`ForgeElement`	Yes	The component to wrap the tooltip around.
`text`	`string`	Yes	The 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 ="Hello World">
  <Button onClick={() => console.log("Hello World")}>Hover over me</Button>
</Tooltip>

Output

Example image of rendered tooltip