Learn about the Alert component for use in UI extensions.
Alert
component to render an alert within a card. Use this component to give usage guidance, notify users of action results, or warn them about potential issues or failures. Alerts can be placed in components statically or triggered dynamically as the result of an action.
If you want to render an alert banner at the top of the page, Learn more about the AddAlert method.
Prop | Type | Description |
---|---|---|
title | String | The bolded text of the alert. |
variant | 'info' (default) | 'tip' | 'success' | 'warning' | 'danger' | The color of the alert. See below for more information about variants. |
variant
prop.
'info'
: a blue alert for general messages to inform the user.'tip'
: a white alert to provide guidance and tips.'success'
: a green alert to indicate the successful completion of a task or to convey a positive CRM record status.'warning'
: a yellow alert for general warnings related to the performance of the system or the status of the CRM record.'danger'
: a red alert indicating an error, the degradation of a system, or a negative CRM record status. You should not use this alert type for anything other than errors and negative statuses.'info'
alert to add instructions to a custom card, such as “Fill out this form using the contact’s company information.”'success'
alert when a user successfully submits a form in the UI extension, or to convey that a contact qualifies for enrollment in a promotional offering.'warning'
alert to call attention to a contact’s upcoming renewal date.'danger'
alert to notify the user of a form submission error or to signify that a high-urgency ticket has lapsed.