Use the Tooltip component for adding a short explanation to specific terms. This component is built to be accessible in accordance to the guidance from WAI Tooltip Pattern. Note that the
To use it, your docs page must be in
.mdx format. Please change the format from
.mdx if necessary. All your existing markdown will still be supported without issue.
Tooltip component like so:
<Tooltip> component within your content like so:
To link a word or phrase that has an associated tooltip, add the link within the
<Tooltip> like so:
This is a sentence that has many technical terms. A tooltip Concise and clear explanation here could help with explaining a term when hovered over. Don’t make them too long though.
Tooltip and link
This example contains a tooltip along with a link to see Bubees Bubees is not a typo. Bubees is a cat. .