Skip to main content
Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links. When applied to plain text, a dotted underline is automatically rendered to indicate the tooltip is available. Example: documentation helps developers understand how to integrate with your service.
Tooltip example
<Tooltip headline="API" tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.

​
Properties

​
tip
string
required
The text displayed in the tooltip.
​
headline
string
Text displayed above the tip text.
​
cta
string
The call-to-action text for a link within the tooltip.
​
href
string
URL for the call-to-action link. Required when using cta.