Search > Accessibility Audit
Refer to the parent epic description for more information on this effort.
Purpose
Audit the accessibility of the GitLab UI Search component in all variants and states in order to identify any problems and provide more documentation on the component’s page in Pajamas.
Component description
Search patterns enable users to find certain information by adding criteria that match their query.
Initial Methods and Tools
Review the initial testing methods in the parent epic. List the testing methods used for your audit below, including any additional testing methods needed for this component that is not listed in the parent epic.
- Review the Search examples in GitLab UI
- Visual review for contrast and states
- Keyboard only
- Screen reader: VoiceOver + Safari on macOS
- Screen reader: NVDA + Chrome on Windows
- axe DevTools extension in browser
Audit Criteria
Review the general audit criteria in the parent epic. Add applicable criteria to this section, including any additional criteria needed for this component that is not listed in the parent epic. A check indicates that the audit has been performed, not that it passes.
-
All actions and functionality can be done with a keyboard. -
Links, buttons, and controls have a visible focus state. -
All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label
for icons that have meaning or perform actions. -
Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false"
toaria-expanded="true"
when an accordion is expanded. -
Color combinations have sufficient contrast.
Results
Problem | Solution | Related Issue/MR |
---|---|---|
The base-search-box-by-click--history uses a menu for the dropdown, which also isn't coded correctly.CleanShot_2022-06-02_at_09.27.17 |
Use a disclosure widget instead of a menu and ensure markup and semantics are used correctly. | TBD |
Completing the audit
After the solutions have been explored and applied, review the completing the audit section in the parent epic. Complete all items prior to closing this issue.
accessibility ~"Category:FE/UX Foundations" ~"component:search"