diff --git a/docs/components/button-group.md b/docs/components/button-group.md index 5c21e51f7a60e9f8b8d4dec13a60c0b89cb3e321..d2d5140ed15e517af409f25815fe36c5f9373338 100644 --- a/docs/components/button-group.md +++ b/docs/components/button-group.md @@ -12,6 +12,14 @@ Group a series of buttons together on a single line with the button group. Add o * Will be replaced with the ToC, excluding the "Contents" header {:toc} +{% callout warning %} +## Ensure correct `role` and provide a label + +In order for assistive technologies (such as screen readers) to convey that a series of buttons is grouped, an appropriate `role` attribute needs to be provided. For button groups, this would be `role="group"`, while toolbars should have a `role="toolbar"`. + +In addition, groups and toolbars should be given an explicit label, as most assistive technologies will otherwise not announce them, despite the presence of the correct role attribute. In the examples provided here, we use `aria-label`, but alternatives such as `aria-labelledby` can also be used. +{% endcallout %} + ## Basic example Wrap a series of buttons with `.btn` in `.btn-group`.