aboutsummaryrefslogtreecommitdiff
path: root/docs/components
diff options
context:
space:
mode:
authorPatrick H. Lauke <[email protected]>2017-04-18 15:14:07 +0100
committerGitHub <[email protected]>2017-04-18 15:14:07 +0100
commitc0f068bc73aedac2c16e0c731729b85544ea0265 (patch)
tree8d59fe6a8960d5dc195c30ac16722b034dc5dbbc /docs/components
parent14b2a64b265d53633ecce3fd845c3d23d740ceda (diff)
downloadbootstrap-c0f068bc73aedac2c16e0c731729b85544ea0265.tar.xz
bootstrap-c0f068bc73aedac2c16e0c731729b85544ea0265.zip
Port button group accessibility callout from v3 to v4
Diffstat (limited to 'docs/components')
-rw-r--r--docs/components/button-group.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/components/button-group.md b/docs/components/button-group.md
index 5c21e51f7..d2d5140ed 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`.