Home
Callouts
Learn how to use the Callout component in your documentation to highlight important information.
Note
Callouts can be used to highlight critical information.
Overview
Callouts highlight critical information for the reader that could help them improve the outcome of their goal. There are four different types of callouts to choose from that change the semantic appearance of the callout. Each type corresponds with the level of severity of the information within.
Properties
| Name | Type | Description |
|---|---|---|
type required | string | The type of callout to display. Must be one of note, tip, caution, or warning. |
Examples
Note callout
Note
This is a note callout. Notes are for additional information that might be relevant to the content. Notes inform and do not instruct.
Tip callout
Tip
This is a tip callout. Tips provide optional but recommended actions that the reader can take to improve the outcome of their intended goal.
Caution callout
Caution
This is a caution callout. Cautions are used to notify the reader that if a certain action is taken (or not taken), it might lead to an undesirable outcome.
Warning callout
Warning
This is a warning callout. Warnings are used to notify the reader that if an action is taken (or not taken), it will lead to an undesirable and potentially destructive outcome.