Tooltip
The tooltip React Carbon component has been tested against the latest W3C Web Content Accessibility Guidelines (WCAG) 2.1 Level A and AA success criteria and violations have been identified as high priority issues. This document will be updated when these accessibility issues are resolved.
Accessibility considerations
- After the tooltip opens, initial focus should be set on the first focusable element in the tooltip. See WAI-ARIA Authoring Practices Modal Dialog Example, Accessibility Features section for best practices on setting focus. Note: This does not apply to the tooltip icon or tooltip definition components.
- After the tooltip closes, focus should retain the user’s point of regard and return to the element that invoked it. Note: This does not apply to the tooltip icon or tooltip definition components where focus never leaves the element that invokes it.
- The tooltip component’s focus must not move outside the modal until it is closed. Note: This does not apply to the tooltip icon or tooltip definition components, as noted above, focus never leaves the element that invokes it.
- The tooltip component has the same accessibility considerations as outlined in the modal component documentation.
- For the tooltip icon and tooltip definition: Be sure the tooltip is
Resources
- W3C WAI-ARIA Authoring Practices Tooltip Design Pattern covers the usage of ARIA names, state and roles, as well as the expected keyboard interactions.
- ARIA1: Using the aria-describedby property to provide a descriptive label for user interface controls
- IBM Accessibility Checklist Checkpoint:
- 1.3.1 Info and Relationships (WCAG Success Criteria 1.3.1)
- 1.4.13 Content on Hover or Focus (WCAG Success Criteria 1.4.13)
- 3.3.2 Labels or Instructions (WCAG Success Criteria 3.3.2)
Accessibility testing
Automated, manual and screen reader accessibility verification test has been performed on the tooltip React Carbon component. WCAG 2.1 Level A and AA success criteria issues have been identified and the list of open accessibility violations is available in the Carbon Component GitHub repository.
Automated test
Automated test environment
Results
- macOS Mojave version 10.14.2 with VoiceOver
- Chrome version 77.0.3865.90
- Dynamic Assessment Plugin (DAP) version 1.8.0.0 - IBM Accessibility WCAG 2.1 Sept. 2019 Ruleset
- Carbon React version 7.7.1
- Chrome version 77.0.3865.90
- Dynamic Assessment Plugin (DAP) version 1.8.0.0 - IBM Accessibility WCAG 2.1 Sept. 2019 Ruleset
- Carbon React version 7.7.1
DAP test:
- No violations
- No violations