Alert
CdrAlert
Provide contextual feedback messages for typical user actions
# Overview
CdrAlert is a simple wrapper component that allows for composing various alert layouts.
There are four different options for styling the alert, based on the alert type.
Alerts should be passed an appropriate icon and text for the alert message type.
# Accessibility
Many WCAG requirements are contextual to their implementation. To ensure that usage of this component complies with accessibility guidelines you are responsible for the following:
- Add
role="alert"for messages that are important or time sensitive to ensure that the messaging is immediately announced to screen readers. For other content, addaria-live="polite". - For static messaging that calls out the type of alert in the text and that is loaded with the page there is no need to do anything specific
- For messages that do not include text to identify what type of alert is being displayed users should add screen reader only text that adds this information to the start of their message
- Don't rely on color alone to convey your message. Provide an additional indicator to color, like an icon: WCAG 1.4.1 (opens new window)
- Error Identification techniques and criteria: WCAG 3.3.1 (opens new window)
# Guidelines
Alert messaging keeps users informed of important and sometimes time-sensitive changes contextual to inline elements on the page. These messages help to clarify an issue and/or notify users of a potential problem that may require their attention.
There are four types of alerts: error, warning, success, and informational. Each type corresponds with a color and icon to provide a consistent, universal experience for users.
# Error
Use to inform that something went wrong. They affect or block the user's experience and must be resolved before moving forward.
# Warning
Use for a message requiring attention but not resolution in order to continue. Warning alerts might tell a user what could happen if they don’t address what they’re being warned about.
# Success
Use to communicate that an action has been successfully completed. Provides a positive response to user actions. No action is required.
# Informational
Use to provide context around a situation. No action is required.
# Use when
- To provide a user the status of an action they’re trying to complete
- As a validation message that alerts someone that they just did something that needs to be corrected (see Error and Warning types)
- As confirmation that a task was completed successfully (see Success type)
- As contextual information that might need their attention (see Informational type)
# Don't use when
- To provide inline error messaging for form input validation. Instead use the built in validation and error features of the Cedar form components.
# API
# Props
type
name
string
type
'info'
default
Sets the alert style. Possible values: { 'info' | 'success' | 'warning' | 'error'}
# Slots
Find more information about using Slots in the article Getting Started as a Developer.
default
name
Slot for CdrAlert content.