Callout

Highlight an important note, tip, warning, or error in an MDX page.

Keep examples focused
Show one idea at a time so readers can apply it quickly.
<Callout
type="tip"
title="Keep examples focused"
description="Show one idea at a time so readers can apply it quickly."
/>

Callout separates important guidance from the normal reading flow. It is best for a practical tip, a prerequisite, a warning, or an error condition that a reader should notice while following an article.

Select the right emphasis

Use note for neutral context, info for helpful facts, tip for a preferred approach, and check for a successful outcome. Reserve warning and danger for situations where ignoring the content has a meaningful consequence.

Check before publishing

Preview the page locally so broken links and invalid MDX do not reach readers.

You can provide a short string with description, or use children when the message needs Markdown, links, or another MDX component. Keep each callout to one focused point.

Tell a complete rollout story

Stack related callouts to turn a dry deployment status into a scannable update. Each treatment gives the reader a useful visual cue without obscuring the timeline.

Migration starts at 09:00 UTC

Existing links continue to work while the new pages are generated.

Pause edits for ten minutes

Content changes made during the final sync will not be included.

Validation passed

The preview is live and the search index has been refreshed.

<div className="rounded-xl border border-foreground/10 bg-muted/30 p-4">
<Callout type="info" title="Migration starts at 09:00 UTC">
  Existing links continue to work while the new pages are generated.
</Callout>
<Callout type="warning" title="Pause edits for ten minutes">
  Content changes made during the final sync will not be included.
</Callout>
<Callout type="check" title="Validation passed">
  The preview is live and the search index has been refreshed.
</Callout>
</div>

Properties

type"note" | "warning" | "info" | "tip" | "check" | "danger"optional

Selects the icon and accent colour. It defaults to note.

variantCalloutType | "default" | "destructive"optional

Compatibility alias for type. default maps to note and destructive maps to danger.

titleReactNodeoptional

An optional heading placed above the message.

descriptionReactNodeoptional

The message body. It takes precedence over the component's children.

childrenReactNodeoptional

Alternative rich message content when description is not set.