Tooltip
Inline hover tooltips for adding supplementary context without cluttering the main text.
For isolated previews, theme switching, and sandbox editing, open the Tooltip playground on holydocs.com .
When to use
Use this component when you need stronger document structure, annotation, or narrative pacing inside a page.
Live Examples
Every example below renders the real component directly inside HolyDocs, followed by the exact MDX you can paste into a page.
Basic
Block-level tooltip wrapping content.
Hover over this text to see the tooltip.
This is additional context shown on hovermdx<Tooltip tip="This is additional context shown on hover">Hover over this text to see the tooltip.</Tooltip>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
tip | string | -- | Text displayed inside the tooltip on hover. |
Usage
Start from this baseline shape and then tailor the copy, data, or nesting to the page you are writing.
mdx<Tooltip tip="This is additional context shown on hover">Hover over this text to see the tooltip.</Tooltip>
Tips
- Keep the surrounding copy short so the component remains the focal point instead of becoming redundant chrome.
- Prefer one clear job per component instance. If a block is trying to explain, navigate, and warn at the same time, split it up.
- Check the page in both light and dark mode when you stack multiple content components together. Dense compositions can feel heavier than expected.
Related Components
Callout
Highlighted message blocks for drawing attention to notes, tips, warnings, and other contextual information.
More
- Interactive playground: Tooltip on holydocs.com
- Component library index: /components