Skip to content

feat(GlAvatarsInline): Add badgeSrOnlyText prop

Enrique Alcántara requested to merge add-sr-only-text-to-avatars-inline-badge into main

What does this MR do?

This MR adds a required badgeSrOnlyText property to the GlAvatarsInline component. The purpose of this property is ensuring that the badge displayed by the component when 1 or more avatars are collapsed provides contextual information to users that use screen readers.

See the related issue for more information.

Why is the property required?

Flagging this property required helps us enforce good accessibility practices when implementing a feature that relies on this component.

Integration MR

We created an integration MR to fix the test failures that arise from this change: gitlab!77889 (closed)

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.

Relates to #1607 (closed)

Edited by Enrique Alcántara

Merge request reports