Callouts
Callouts draw attention to important information. Dory provides five pre-configured callout types plus a generic Callout component for custom types.
Note#
Use <Note> for supplementary information:
<Note>
Note
This feature requires Node.js 18 or later. Check your version with node --version.
Warning#
Use <Warning> for critical caveats or destructive actions:
<Warning>
Warning
This action is irreversible. All data in the selected namespace will be permanently deleted.
Info#
Use <Info> for contextual information:
<Info>
Info
Rate limiting applies to all API endpoints. The default limit is 1000 requests per hour per API key.
Tip#
Use <Tip> for helpful hints and best practices:
<Tip>
Tip
Enable response caching to reduce API calls. Cache keys are scoped to the authenticated user.
Check#
Use <Check> for success states, confirmations, or completed items:
<Check>
Check
Your API key has been generated and is ready to use. Store it securely — it won't be shown again.
Custom Callout#
Use <Callout> with a type and title for full control:
<Callout>
Breaking Change in v2.0
The authenticate() method signature has changed. Update your integration before upgrading.
Callout Props
| Prop | Type | Default | Description |
|---|---|---|---|
type | 'note' | 'warning' | 'info' | 'tip' | 'check' | 'note' | Determines the color scheme and icon. |
title | string | — | Optional title displayed above the content. |
children | ReactNode | — | Callout body content. Supports MDX. |
Callout Types Reference#
| Component | Color | Icon | Use Case |
|---|---|---|---|
<Note> | Neutral | Info | Supplementary information |
<Warning> | Yellow outline | Alert Triangle | Destructive or risky actions |
<Info> | Blue | Info Circle | Contextual facts |
<Tip> | Green | Star | Helpful hints, best practices |
<Check> | Outlined, green badge | Check | Success states, confirmations |
Was this page helpful?