The page navigation is complete. You may now navigate the page content as you wish.
Skip to main content

Displays a brief message without interrupting a user’s task.

Alerts display brief and important messages that capture the user’s attention but don’t interrupt their workflow.

Usage

When to use

  • To display a concise, important message that requires the user’s attention.

When not to use

  • To communicate successful feedback on a user’s action, consider Toast.
  • As a dialog to confirm an action, consider Modal.
  • To flag new features (e.g., "In Preview", "Beta", "New", etc), consider Badge.

Types of alerts

There are three types of alerts: page, inline, and compact.

Page

Use page-level alerts on the top of the page, between the navigation and the breadcrumb to inform users of an event that may require the user’s attention or action.

Inline

Use inline alerts when the message is contextual or specific to the section it’s placed in.

Compact

Use compact alerts when a less prominent alert is needed.

Ordering Alerts by type

Alert types have an implied hierarchy and should be ordered starting from page and descending in hierarchy to compact.

Ordering alerts of different types

Color

Informational alerts

Informational alerts are non-urgent, non-disruptive alerts that don’t require immediate attention and will not notify users with assistive technology.

Note
GitHub Actions doesn’t support names starting with the “GitHub” prefix. If your secret names include “GitHub”, you’ll need to rename them for proper syncing secrets.
Upgrade
Looks like you’re getting close to using up free tier. Unlock more integrations and other premium features. Upgrade now.

Neutral alerts

Use neutral alerts to show general information regarding the current context or relevant actions.

Highlight alerts

Use highlight alerts to show more prominent general information or promotional content.

Status alerts

Status alerts, such as success, warning, and critical, will immediately notify users with assistive technology.

Cluster deployment
Your cluster deployment was successfully deployed.
Not saved
Your work has not been saved properly.
Invitation expired
This invitation has already been accepted. Sign in to continue to your organization.

Success alerts

Use success alerts to indicate a successful action. Use it sparingly. To communicate success after a user action is performed, use Toast.

Warning alerts

Use warning alerts to help users avoid an issue. Provide guidance and actions, if possible.

Critical alerts

Use critical alerts to indicate critical errors, such as validation errors, that require user attention or action.

Do

Use the Alert for more intrusive message communication about errors or critical disruptions at an application, page, or section level where users need to take immediate action.

You have exceeded 50 applies this month
You may only invoke applies that destroy managed resources. Upgrade now and access additional product features, unlimited applies, and increased concurrency.
View usage
Do

Use the Alert to communicate validation errors. For more details, refer to the form validation patterns.

Form submission error
Correct the formatting of the following fields to update your user profile:
Don’t

Don't use alerts to provide non-intrusive feedback to users about the failure of an ongoing task or request. For example, a failure while deleting a cluster. Use the Toast instead.

Module error
This module encountered an error during publishing. You may need to republish.
Don’t

Don't use alerts to communicate error messages that are not caused by the user. For example, an unsuccessful Vault cluster creation due to a failure while validating the deployment. Use the Toast instead.

Vault cluster update failed
test-cluster_1 configuration update failed.

Ordering Alerts by color

Order multiple Alerts by their importance and impact on the user, starting from critical, to communicate an Alert that must be resolved immediately, and descending in order of perceived impact to neutral.

Ordering alerts

Placing Alerts

Inline and compact Alerts can have more meaning if they are placed within the element that is responsible for the Alert. This can help when it’s necessary to have more than one Alert on the page and is relevant for pages that aggregate content like dashboards, or where a specific message is necessary.

Example of multiple Alerts placed to different parts of the UI

Placement by type

Where an Alert is placed is dependent on the type.

Page

Page alerts are placed between the global header navigation and the breadcrumb, next to the left navigation.

Placement of page alert

Inline

Inline alerts can be added to a section or component or inline with content.

Placement of inline alert

Compact

Compact alerts can be added to a section or component or inline with content.

Placement of compact Alert

Mixing Alert types

We recommend against mixing different types of Alerts in the same context, as this can unintentionally convey that different Alert types have the same hierarchical impact.

Don’t

Don’t mix different Alert types in the same context.

Example of different Alert types in the same context

Do

Instead, be more specific with how the Alerts are placed depending on what the message applies to.

Example of different Alert type placements

Icons

All alerts have icons by default that are intentionally tied to the alert type.

Icons within the neutral and highlight alerts can be replaced with other icons. Change them only when the new icon provides the user with extra value; otherwise, use the default icon provided.

New features available
Starting with Terraform 0.15, you can now upgrade to a new version and your workflows will continue to be operational, just as they were in prior versions.
The page navigation is complete. You may now navigate the page content as you wish.
Skip to main content

Displays a brief message without interrupting a user’s task.

Alerts display brief and important messages that capture the user’s attention but don’t interrupt their workflow.

Usage

When to use

  • To display a concise, important message that requires the user’s attention.

When not to use

  • To communicate successful feedback on a user’s action, consider Toast.
  • As a dialog to confirm an action, consider Modal.
  • To flag new features (e.g., "In Preview", "Beta", "New", etc), consider Badge.

Types of alerts

There are three types of alerts: page, inline, and compact.

Page

Use page-level alerts on the top of the page, between the navigation and the breadcrumb to inform users of an event that may require the user’s attention or action.

Inline

Use inline alerts when the message is contextual or specific to the section it’s placed in.

Compact

Use compact alerts when a less prominent alert is needed.

Ordering Alerts by type

Alert types have an implied hierarchy and should be ordered starting from page and descending in hierarchy to compact.

Ordering alerts of different types

Color

Informational alerts

Informational alerts are non-urgent, non-disruptive alerts that don’t require immediate attention and will not notify users with assistive technology.

Note
GitHub Actions doesn’t support names starting with the “GitHub” prefix. If your secret names include “GitHub”, you’ll need to rename them for proper syncing secrets.
Upgrade
Looks like you’re getting close to using up free tier. Unlock more integrations and other premium features. Upgrade now.

Neutral alerts

Use neutral alerts to show general information regarding the current context or relevant actions.

Highlight alerts

Use highlight alerts to show more prominent general information or promotional content.

Status alerts

Status alerts, such as success, warning, and critical, will immediately notify users with assistive technology.

Cluster deployment
Your cluster deployment was successfully deployed.
Not saved
Your work has not been saved properly.
Invitation expired
This invitation has already been accepted. Sign in to continue to your organization.

Success alerts

Use success alerts to indicate a successful action. Use it sparingly. To communicate success after a user action is performed, use Toast.

Warning alerts

Use warning alerts to help users avoid an issue. Provide guidance and actions, if possible.

Critical alerts

Use critical alerts to indicate critical errors, such as validation errors, that require user attention or action.

Do

Use the Alert for more intrusive message communication about errors or critical disruptions at an application, page, or section level where users need to take immediate action.

You have exceeded 50 applies this month
You may only invoke applies that destroy managed resources. Upgrade now and access additional product features, unlimited applies, and increased concurrency.
View usage
Do

Use the Alert to communicate validation errors. For more details, refer to the form validation patterns.

Form submission error
Correct the formatting of the following fields to update your user profile:
Don’t

Don't use alerts to provide non-intrusive feedback to users about the failure of an ongoing task or request. For example, a failure while deleting a cluster. Use the Toast instead.

Module error
This module encountered an error during publishing. You may need to republish.
Don’t

Don't use alerts to communicate error messages that are not caused by the user. For example, an unsuccessful Vault cluster creation due to a failure while validating the deployment. Use the Toast instead.

Vault cluster update failed
test-cluster_1 configuration update failed.

Ordering Alerts by color

Order multiple Alerts by their importance and impact on the user, starting from critical, to communicate an Alert that must be resolved immediately, and descending in order of perceived impact to neutral.

Ordering alerts

Placing Alerts

Inline and compact Alerts can have more meaning if they are placed within the element that is responsible for the Alert. This can help when it’s necessary to have more than one Alert on the page and is relevant for pages that aggregate content like dashboards, or where a specific message is necessary.

Example of multiple Alerts placed to different parts of the UI

Placement by type

Where an Alert is placed is dependent on the type.

Page

Page alerts are placed between the global header navigation and the breadcrumb, next to the left navigation.

Placement of page alert

Inline

Inline alerts can be added to a section or component or inline with content.

Placement of inline alert

Compact

Compact alerts can be added to a section or component or inline with content.

Placement of compact Alert

Mixing Alert types

We recommend against mixing different types of Alerts in the same context, as this can unintentionally convey that different Alert types have the same hierarchical impact.

Don’t

Don’t mix different Alert types in the same context.

Example of different Alert types in the same context

Do

Instead, be more specific with how the Alerts are placed depending on what the message applies to.

Example of different Alert type placements

Icons

All alerts have icons by default that are intentionally tied to the alert type.

Icons within the neutral and highlight alerts can be replaced with other icons. Change them only when the new icon provides the user with extra value; otherwise, use the default icon provided.

New features available
Starting with Terraform 0.15, you can now upgrade to a new version and your workflows will continue to be operational, just as they were in prior versions.