Accessibility
To implement an accessible PatternFly menu component:
- Due to the composable nature of the menu component, keyboard interaction will need to be added manually between the menu toggle and the menu. See the custom menu demos to see how this is done.
- Any actions placed within a menu item will need an
aria-labelon theMenuItemActionto communicate to users what the action is.
Testing
At a minimum, a menu component should meet the following criteria:
- Tab navigates to the menu, Shift + Tab navigates to the previous focusable element, up and down arrow keys should be used to navigate between menu items, and Escape should close the menu."
- This will differentiate each action when announced to users of assistive technologies when navigating through a page or a screen reader's rotor menu.
React customization
The following React props have been provided for more fine-tuned control over accessibility.
Prop | Applied to | Reason |
|---|---|---|
aria-label=[text that labels the menu] | Menu | Adds an accessible name to the menu. |
aria-label=[text that labels the menu item] | MenuItem | Adds an accessible name to the menu item. |
icon={<Icon aria-hidden />} | MenuItem | Renders an icon to a menu item. When icon is decorative, pass an aria-hidden to the icon to hide it from screen reader users. |
isExternalLink | MenuItem | Renders an icon on the item when it receives focus or is hovered, as well as visually hidden text, to let users of certain assistive technologies know that the item will open in a new tab/window. Required if the item opens a new tab/window. |
aria-label=[text that labels the menu item's action] | MenuItemAction | Adds an accessible name to the action item on the menu. |
icon={<Icon aria-hidden />} | MenuItemAction | Renders an icon to a menu item action. When icon is decorative, pass an aria-hidden to the icon to hide it from screen reader users. |
labelHeadingLevel=[a heading tag] | MenuGroup | Adds a group label's heading level. Default is h1. Be sure to not skip heading levels when passing this prop in. For example, if a menu group is within a page section that has an h2 heading, you should not pass headingLevel="h4". |
HTML/CSS customization
The following HTML attributes and PatternFly classes can be used for more fine-tuned control over accessibility.
Attribute or class | Applied | Reason |
|---|---|---|
role="menu" | .pf-v5-c-menu__list | Declares .pf-v5-c-menu__list as a menu. |
disabled | button.pf-v5-c-menu__item | When the menu item uses a button element, indicates that it is unavailable and removes it from keyboard focus. |
role="menuitem" | .pf-v5-c-menu__item, .pf-v5-c-menu__list-item (checkbox) | Assigns .pf-v5-c-menu__item as an option in a set of choices contained by a menu. |
role="none" | .pf-v5-c-menu__list-item | Removes semantic meaning from .pf-v5-c-menu__list-item. |
aria-disabled="true" | a.pf-v5-c-menu__item | When the menu item uses a link element, removes it from keyboard focus. |
tabindex="-1" | a.pf-v5-c-menu__item | When the menu item uses a link element, removes it from keyboard focus. |
aria-hidden="true" | .pf-v5-c-menu__item-icon, .pf-v5-c-menu__item-action-icon, .pf-v5-c-menu__item-external-icon, .pf-v5-c-menu__item-toggle-icon, .pf-v5-c-menu__item-select-icon | Hides the icon from assistive technologies. |
aria-label="[text that labels the action]" | .pf-v5-c-menu__item-action-icon.pf-m-favorite | Provides an accessible label indicating that the favorite action is not selected. |
aria-label="[text that labels the action]" | .pf-v5-c-menu__item-action-icon.pf-m-favorite.pf-m-favorited | Provides an accessible label indicating that the favorite action is selected. |
View source on GitHub
