Callout
Editorial emphasis block within content for notes, tips, warnings, and important information. A callout sits inside long-form content to highlight a short, informational aside without interrupting the reading flow. It is complementary content, not a global site-wide announcement and not feedback about an action the user took.
Usage
When to use
- To highlight a tip, note, warning, or supporting detail inside an article or documentation page
- To set important context apart from the main reading flow
- To group a small block of related informational content
When not to use
- For site-wide notifications - use announcement
- For feedback on a user action (success, error) - use message
- For calls to action - callouts are informational only
Do
- Keep callout content concise - one short paragraph is ideal
- Choose the emphasis (subtle, neutral, accent) or intent (info, warning, danger, success) that matches the content tone
- Keep the heading level consistent with the surrounding document outline
Don't
- Don't put CTAs inside a callout - callouts are informational, not actionable
- Don't stack multiple callouts in a row - it dilutes their emphasis
- Don't use a callout for critical errors - use message
API
Slots
| Slot | Required | Description |
|---|---|---|
content | Yes | Body text content. |
title | - | Optional heading text rendered above the body. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
title_tag | Enum: h2, h3, h4 | h3 | Tag used to render the title. |
classes | array | - | Additional CSS class words merged into the root element. |
attributes | object | - | Additional HTML attributes spread on the root element. |
Classes
| Class | Capability | Default | Description |
|---|---|---|---|
.subtle | Emphasis | - | Lower emphasis; a muted, quieter weight. |
.neutral | Emphasis | Yes | Default emphasis; the standard weight at balanced contrast. |
.accent | Emphasis | - | Higher emphasis; a stronger, louder weight. |
.info | Intent | - | Informational message. |
.warning | Intent | - | Warning or caution. |
.danger | Intent | - | Error, destructive, or critical. |
.success | Intent | - | Confirmation or completion. |
.sm | Size | - | Small. |
.md | Size | Yes | Medium. |
.lg | Size | - | Large. |
.flat | Elevation | Yes | No elevation. |
.raised | Elevation | - | Slight elevation. |
Examples
Neutral
Default treatment with the neutral background and border.
Subtle
Muted palette within the neutral family for lower-emphasis content (background notes on busy pages).
Accent
Heavier border and accent color for prominent emphasis.
Info
Informational message in the info palette.
Warning
Warning callout communicating caution.
Danger
Error or destructive state in the danger palette.
Success
Confirmation in the success palette.
With title
Callout with an optional title slot.
Accessibility
- WCAG 2.2 AA
- Rendered with
role="note"so the supplementary content is exposed semantically without claiming a landmark region - Any heading inside the callout matches the surrounding document outline
- Color is never the only carrier of the callout's type - an icon or label supports the meaning
Related
- announcement - global site-wide notification
- message - feedback on a user action