The sbb-alert-group manages the dismissal and accessibility of alerts and also its visual gap between each other.
<sbb-alert-group accessibility-title='Disruptions' accessibility-level='2'>
<sbb-alert
title-content='Interruption between Genève and Lausanne'
href='https://www.sbb.ch'
size='l'
>
The rail traffic between Allaman and Morges is interrupted. All trains are cancelled.
</sbb-alert>
<sbb-alert title-content='Interruption between Berne and Olten' href='https://www.sbb.ch'>
Between Berne and Olten from 03.11.2021 to 05.12.2022 each time from 22:30 to 06:00 o'clock
construction work will take place. You have to expect changed travel times and changed
connections.
</sbb-alert>
</sbb-alert-group>Accessibility
By specifying the accessibility-title it's possible to add a hidden title to the sbb-alert-group.
The heading level can be set via accessibility-title-level.
By default, the sbb-alert-group has the role status which means that if a new alert arrives,
it will be read out as soon as the user is idle
(equal to aria-live="polite").
You can change the role or aria-live attributes to fit your needs.
For example, you can set the role to alert which implicitly sets aria-live to assertive
and therefore interrupts screen reader flow, to immediately read out the alert content. Note that with role alert,
in some combinations of screen readers and browsers not every part of the alert is fully read.
If all alerts are dismissed, it's recommended to completely remove the sbb-alert-group from DOM.
You can catch this moment by listening to empty event and react accordingly.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
accessibilityTitle | accessibility-title | Title for this alert group which is only visible for screen reader users. | string | undefined |
accessibilityTitleLevel | accessibility-title-level | Level of the accessibility title, will be rendered as heading tag (e.g. h2). Defaults to level 2. | "1" | "2" | "3" | "4" | "5" | "6" | '2' |
role | role | The role attribute defines how to announce alerts to the user. 'status': sets aria-live to polite and aria-atomic to true. 'alert': sets aria-live to assertive and aria-atomic to true. | string | 'status' |
Events
| Event | Description | Type |
|---|---|---|
did-dismiss-alert | Emits when an alert was removed from DOM. | CustomEvent<HTMLSbbAlertElement> |
empty | Emits when sbb-alert-group becomes empty. | CustomEvent<void> |
Slots
| Slot | Description |
|---|---|
"accessibility-title" | title for this sbb-alert-group which is only visible for screen reader users. |
"unnamed" | content slot, should be filled with sbb-alert items. |