Menu buttons
Design annotations are needed for specific instances shown below, but for the standard menu button, combo button, and overflow menu, Carbon already incorporates accessibility.
Accessibility testing statusFor every latest release, Carbon runs tests on all components to meet the accessibility requirements. These different statuses report the work that Carbon has done in the back end. These tests appear only when the components are stable.
For every latest release, Carbon runs tests on all components to meet the accessibility requirements. These different statuses report the work that Carbon has done in the back end. These tests appear only when the components are stable.
Latest version: ^1.64.0 | Framework: React (@carbon/react)
Component | Accessibility test | Status | Link to source code |
---|---|---|---|
Menu buttons | Test(s) that ensure the initial render state of a component is accessible. | Automated or manual testing has been temporarily deferred. | GitHub link |
Tests that ensure additional states of the component are accessible. This could be interactive states of a component or its multiple variants. | Automated or manual testing has been temporarily deferred. | ||
Tests that ensure focus is properly managed, and all interactive functions of a component have a proper keyboard-accessible equivalent. | Test data is either not available or not applicable for this component state. | ||
This manual testing ensures that the visual information on the screen is properly conveyed and read correctly by screen readers such as JAWS, VoiceOver, and NVDA. | A human has manually tested this component, e.g. screen reader testing. |
What Carbon provides
Carbon bakes keyboard operation into its components, improving the experience of blind users and others who operate via keyboard. Carbon also incorporates other accessibility considerations, some of which are described below.
Keyboard interaction
Menu button
The menu button is set in the tab order and is activated by Space
or Enter
.
When the menu is open, the first item takes focus. Focus is moved between menu
items with the Up
and Down
arrow keys. Space
or Enter
activates the item
with focus, which causes focus to go somewhere else and the menu to close. Esc
collapses the menu and puts focus back onto the menu button.
Combo button
The combo button is set in the tab order where the first tab brings focus on the
primary button and the second tab brings focus on the icon button that contains
the menu. The respective buttons are activated by Space
or Enter
. When the
menu is open, the first item takes focus. Focus is moved between menu items with
the Up
and Down
arrow keys. Space
or Enter
activates the item with
focus, which causes focus to go somewhere else and the menu to close. Esc
collapses the menu and puts focus back onto the icon button.
Overflow menu
Each overflow menu is in the tab order and is activated by Space
or Enter
.
When the menu is open, the first item takes focus. Focus is moved between menu
items with the Up
and Down
arrow keys. Space
or Enter
activates the item
with focus, which causes focus to go somewhere else and the menu to close. Esc
collapses the menu and puts focus onto the menu button.
Design recommendations
Design annotations are needed for the following instances.
Labeling
Combo button
Combo button has a prop that can be used to change the tooltip label and is only intended to be changed to translate “Additional actions” into other languages. If translation is required, the translation must be annotated with a label that is exposed on hover or focus.
Overflow menu
Overflow menu’s custom icon variant has a prop that can be used to change the tooltip label. If the tooltip label is changed, they must be annotated with a label that will be exposed on hover or focus.
Development considerations
Keep these considerations in mind if you are modifying Carbon or creating a custom component.
- Menu button, combo button, and the overflow menu are buttons with
aria-haspopup
set to “true”. - The menu button, combo button, and the overflow menu is named with
aria-label
. - Each menu item across menu button, combo button, and overflow menu is an
li
in aul
. - Each list item across menu button, combo button, and overflow menu contains a
button with
role="menuitem"
andtabindex="-1"
. See the ARIA authoring practices on menubutton for more considerations. - Combo button and overflow menu has an
iconDescription
prop that can be used to change the tooltip label. See the design recommendations for more guidelines on tooltip labels. - For combo button, the menu is given an
id
. When the menu is open, the icon button is givenaria-controls
with a value of the menuid
.aria-expanded
is also set based on the open state. - When the combo button menu is open, the element (
div
) wrapping the entire Combo button is givenaria-owns
with a value of the Menuid
.