The alert component is used to inform users of important information or to provide feedback on an action they have taken. The component should be placed near the relevant content or form element it is associated with. The content of the alert should be clear, concise, and actionable.
Example
alertalert accentalert successalert warningalert danger
code
<script type="module">
import '@blueprintui/components/include/alert.js';
</script>
<section bp-layout="block gap:sm">
<bp-alert>alert</bp-alert>
<bp-alert status="accent">alert accent</bp-alert>
<bp-alert status="success">alert success</bp-alert>
<bp-alert status="warning">alert warning</bp-alert>
<bp-alert status="danger">alert danger</bp-alert>
</section>
Install
NPM
import '@blueprintui/components/include/alert.js';
CDN
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@blueprintui/components/include/alert.js/+esm';
</script>
Accessibility
- Use clear, descriptive text for the alert message that communicates the purpose of the alert.
- Use the appropriate alert status to indicate the severity of the alert.
- Use aria-live attribute to indicate the importance and relevance of the alert message.
- Provide an option for user to dismiss the alert, if applicable.
- Avoid using the title attribute, as it is not read by screen readers.
bp-alert
Events
Name | Types | Description |
---|
|
| close |
Properties
Name | Types | Description |
---|
status | 'accent' | 'success' | 'warning' | 'danger' | determine the visual status state |
closable | boolean | determine user closable state |
i18n |
| set default aria/i18n strings |
Attributes
Name | Types | Description |
---|
status | 'accent' | 'success' | 'warning' | 'danger' | determine the visual status state |
closable | boolean | determine user closable state |
i18n |
| set default aria/i18n strings |
CSS Properties
Name | Types | Description |
---|
--icon-color |
| |
--color |
| |
Slots
Name | Types | Description |
---|
default |
| slot for content |
bp-alert-group
Properties
Name | Types | Description |
---|
status | 'accent' | 'success' | 'warning' | 'danger' | determine the visual status state |
type | 'banner' | determine the visual styles for top/pinned banners |
Attributes
Name | Types | Description |
---|
status | 'accent' | 'success' | 'warning' | 'danger' | determine the visual status state |
type | 'banner' | determine the visual styles for top/pinned banners |
CSS Properties
Name | Types | Description |
---|
--background |
| |
--color |
| |
--padding |
| |
--border-radius |
| |
Slots
Name | Types | Description |
---|
default |
| slot for content |