Overlays
Tooltip
A short hint that appears on hover or focus. Wraps any inline element and positions itself in one of four directions. Keep tooltips short: anything longer than a sentence belongs in an Alert or a docs link.
Basic
Saves immediately
Positions
Top Right Bottom Left
Inline icon hint
Workspace slug Lowercase, no spaces. Used in your subdomain.
API
| Prop | Type | Default | Description |
|---|---|---|---|
text required | string | no default | Tooltip body, on one line with no line breaks. |
position | 'top' | 'bottom' | 'left' | 'right' | 'top' | Where the tooltip appears relative to the trigger. |
class | string | no default | Extra classes on the trigger wrapper. |
children required | Snippet | no default | The element the tooltip is attached to. |
describe | boolean | true | Makes the text the trigger's description for screen readers. Turn it off where the trigger's name already says the same words. |