Getting started
Components
Do not use a Callout to tell users about a system-level issue; use an Alert instead. For additional guidance on what kind of component to use, reference the Alert vs. Callout vs. Toast vs. Help Text guide.
Callouts should have a CalloutHeading so that the information is easier to navigate to for people who use screen readers. The CalloutHeading's level should be set appropriately with the as prop. It is important to not skip one or more heading levels as it is common for screen readers to build an outline of the page and assist users as they navigate a page.
There are five variants of Callouts: neutral, success, warning, error, and new. Each variant includes an icon.
Use a neutral Callout to communicate relevant information to the page or flow. This information is often static.
Use a success Callout to communicate that the desired outcome was achieved. A success Callout can be appropriate when the outcome is relevant to a specific part of the page, or when additional information or context needs to be provided.
Use a warning Callout to help users avoid an undesirable outcome, or inform users of unexpected behaviors or outcomes.
Use an error Callout to communicate errors for a particular section of a page, or that applies to the whole page.
Use a new Callout to spotlight a recent addition or update.
Make a Callout dismissible with the onDismiss prop if it doesn't communicate a persistent status of the system or the account.
Callouts can have lists of information within them, and are useful for providing error summaries when there are many errors on the page.
Callouts can be inline with text, so use the marginY prop to add a vertical margin.
Compose a Callout with:
Alert
Callout
Toast
Help Text