Alerts
Alerts are used to capture the attention of the user in an intrusive way.
| install | yarn add @clayui/alert |
|---|---|
| version | 3.111.0 |
Stable3.111.0View in LexiconCHANGELOG
Alert
| Property | Description |
|---|---|
actionsReact.ReactNode | A React Component to render the alert actions. |
autoCloseboolean | number | Flag to indicate alert should automatically call onClose. It also
accepts a duration (in ms) which indicates how long to wait. If true
is passed in, the timeout will be 10000ms. |
onClose() => void | Callback function for when the 'x' is clicked. |
rolestring | null | The alert role is for important, and usually time-sensitive, information. The default value is 'alert' |
displayType| 'danger'
| 'info'
| 'secondary'
| 'success'
| 'warning' | Determines the style of the alert. The default value is 'info' |
hideCloseIconboolean | Flag to indicate if close icon should be show. This prop is used in
conjunction with the onCloseprop;The default value is false |
spritemapstring | Path to the spritemap that Icon should use when referencing symbols. |
symbolstring | The icon's symbol name in the spritemap. |
titlestring | The summary of the Alert, often is something like 'Error' or 'Info'. |
variant'feedback' | 'stripe' | 'inline' | Determines the variant of the alert. |
Alert.ToastContainer
| Property | Description |
|---|---|
children| React.ReactElement<IClayAlertProps>
| Array<React.ReactElement<IClayAlertProps>> | Children of the ToastContainer must be a ClayAlert |