feat(Toggle): Update label semantics for accessibility
What does this MR do?
Closes #1598 (closed). Updates the toggle label semantics to adhere to accessibility guidelines. Based on this comment:
Something to consider is that "Dark mode" is present in both a
span
, andaria-label
. If an ID was added to the span, then instead ofaria-label
the button could usearia-labelledby="spanID"
. In this way you reduce the chance that these won't match since there's only a single element acting as both the visual and functional name for the control. By adding the "sr-only" class to that span, it could be visually hidden, but still act as the accessible name so the toggle could be placed in other layouts and alignments as has been discussed.
Integration MR
Does this MR meet the acceptance criteria?
Conformity
-
Code review guidelines. -
GitLab UI's contributing guidlines. -
If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer. -
If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer. -
If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui
package can be upgraded quickly after the changes are released:-
GitLab: mr_url -
CustomersDot: mr_url -
Status Page: mr_url
-
-
Added the ~"component:*"
label(s) if applicable.
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
Security reports checked/validated by a reviewer from the AppSec team
Accessibility
If this MR adds or modifies a component, take a few moments to review the following:
-
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.
Closes #1598 (closed)