Skip to content

feat(GlAlert): `role` status based on alert type

Eduardo Sanz García requested to merge eduardosanz/role-alert into main

What does this MR do?

We set aria role="status" for alert variants that doesn't necessitate interrupting the user's current activity. Those variants are info and tip.

I have kept the role="alert" for the success variant. I feel it is more than advisory information, but the assertiveness level is still aria-live="polite". I am happy to discuss this choice.

According to MDN, regarding the aria role="status":

A status is a type of live region providing advisory information that is not important enough to justify an alert, which would immediately interrupt the announcement of a user's current activity. It is often, but not necessarily, presented as a status bar.

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role

Follow-up from these two comments:

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:
  • 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" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Eduardo Sanz García

Merge request reports