Version 0.7.0 - Alpha
Tooltip
component

Tooltip

A tooltip displays a description of an element on hover or focus.

Usage

import { TooltipTrigger, Tooltip, Button } from '@backstage/ui';

<TooltipTrigger>
  <Button>Button</Button>
  <Tooltip>I am a tooltip</Tooltip>
</TooltipTrigger>

API reference

TooltipTrigger

The trigger will wrap both the trigger and the tooltip.

PropTypeDefaultResponsive
isDisabled
boolean
-No
delay
number
600No
closeDelay
number
500No
isOpen
boolean
-No
defaultOpen
boolean
-No
children
ReactNode
-No

Tooltip

The tooltip will wrap the content of the tooltip.

PropTypeDefaultResponsive
triggerRef
RefObject<Element | null>
-No
isEntering
boolean
-No
isExiting
boolean
-No
placement
toprightbottomleft
-No
containerPadding
number
12No
offset
number
0No
children
ReactNode
-No
className
string
-No
style
CSSProperties
-No

Theming

Our theming system is based on a mix between CSS classes, CSS variables and data attributes. If you want to customise this component, you can use one of these class names below.

Changelog