/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components Callouts

Callouts

Note, Warning, Tip, Info and Danger components for highlighting important content.

4 min read

Callouts draw attention to important information. Use them sparingly to maintain impact.

Note

Use <Note> for important context that readers shouldn't miss:

mdx
<Note>
API keys are scoped to a single project. Create separate keys for each environment.
</Note>
Note

API keys are scoped to a single project. Create separate keys for each environment.

Warning

Use <Warning> for potential issues, breaking changes, or dangerous operations:

mdx
<Warning>
This action cannot be undone. All associated data will be permanently deleted.
</Warning>
Warning

This action cannot be undone. All associated data will be permanently deleted.

Tip

Use <Tip> for helpful suggestions and best practices:

mdx
<Tip>
Enable caching in production to reduce API calls by up to 90%.
</Tip>
Tip

Enable caching in production to reduce API calls by up to 90%.

Info

Use <Info> for supplementary information:

mdx
<Info>
This feature is available on the Pro plan and above.
</Info>
Info

This feature is available on the Pro plan and above.

Danger

Use <Danger> for destructive or irreversible operations:

mdx
<Danger>
Deleting a project permanently removes all pages, builds, and analytics data.
</Danger>
Danger

Deleting a project permanently removes all pages, builds, and analytics data.

Deprecated forms

Two other spellings render, but are deprecated and will stop working at the end of their notice window. The build log warns with the file and line; stx migrate rewrites both. <Callout type="…"> used to render as an unstyled box; it now renders as the named callout its type selects. An unknown type stays unstyled.

Old formUse instead
<Caution><Warning>
<Callout type="note"> … type="danger"The named callout: <Note>, <Info>, <Tip>, <Warning> or <Danger> (type="caution" becomes <Warning>)
mdx
{/* Deprecated */}
<Caution>
Regenerating your webhook secret invalidates all in-flight deliveries.
</Caution>
{/* Use */}
<Warning>
Regenerating your webhook secret invalidates all in-flight deliveries.
</Warning>
Warning

Regenerating your webhook secret invalidates all in-flight deliveries.

With Titles

Add a custom title with the title prop:

The title renders as a heading on its own line above the body, in the callout's status colour. If you write your own bold first line instead, that is left as the heading and no second one is added.

mdx
<Note title="Rate Limiting">
The API is limited to 100 requests per minute per API key.
</Note>
Note
Rate Limiting

The API is limited to 100 requests per minute per API key.

With Code

Callouts can contain code blocks and other markdown:

mdx
<Warning title="Breaking Change in v3">
The `userId` parameter has been renamed to `user_id`:
\`\`\`diff
- client.users.get({ userId: "123" })
+ client.users.get({ user_id: "123" })
\`\`\`
</Warning>
Warning
Breaking Change in v3

The userId parameter has been renamed to user_id:

diff
- client.users.get({ userId: "123" })
+ client.users.get({ user_id: "123" })

Blockquote Shorthand

Plain Markdown blockquotes are auto-styled as callouts — useful for content migrated from other platforms. Two forms are recognized:

Bold label — the label picks the callout type, each with its own icon and palette:

mdx
> **Note:** API keys are scoped to a single project.
> **Warning:** This action cannot be undone.
> **Security:** Never expose your secret key in client-side code.
> **Success:** Your webhook endpoint is now verified.
> **Important:** Sandbox and production use separate API keys.
LabelTypeIcon
NoteNotePin (indigo)
Info, InformationInfoCircle-info (blue)
Tip, HintTipLightbulb (emerald)
Warning, CautionWarningTriangle-alert (amber)
Danger, Error, CriticalDangerOctagon-alert (red)
Security, SecureSecurityShield (teal)
Success, CompleteSuccessCircle-check (green)
Important, Remember, AttentionImportantCircle-alert (violet)

ReadMe-style emoji prefix — 📘/📝/📌 → Note, ⚠️/🚧 → Warning, 💡 → Tip, 🚨/🛑/❌ → Danger, ℹ️ → Info, 🔒/🛡️ → Security, ✅/👍 → Success, ❗ → Important:

mdx
> 📘 Note
>
> Every external account must be associated with a customer.

The emoji is replaced with the callout type's icon (an Untitled UI glyph, the same set as the rest of your doc site), and the first line becomes the callout title — emojis never render in your published docs.

Note

On doc engine v2 only the exact bold labels Note, Info, Tip, Warning, Caution, Danger, Security, Success and Important make a callout. The synonyms (Information, Hint, Error, Critical, Secure, Complete, Remember, Attention) and the emoji prefixes are doc engine v1 only — on v2 they render as a plain quote.

Props

PropTypeDefaultDescription
titlestring(none)Optional heading
childrenReactNode—Content (required)

When to Use

CalloutUse For
NoteImportant context, prerequisites, key information
WarningBreaking changes, destructive actions, common pitfalls
TipBest practices, optimization suggestions, shortcuts
InfoSupplementary details, feature availability, links

Best Practices

Tip

Limit callouts to 1-2 per section. Too many callouts create visual noise and reduce their impact.

•
Keep callout content concise (1-3 sentences)
•
Use the appropriate type for the message
•
Don't nest callouts inside callouts
•
Place callouts near the relevant content
Was this page helpful? Yes No
Product
Resources
Company
© 2026 SyntextBuilt with Syntext