Skip to content

Resolve "Accordion > Update accordion trigger semantics"

What does this MR do?

Wraps the accordion <button> in a header element to comport with the accessibility guidelines defined in this document.

This adds a new, required headerLevel property to gl-accordion which dictates which level header element to use (h1/h2/h3 etc). This purposely does not have a default value because we want the users of this component to be deliberate in their selection.

This also removes the accordion property from GlAccordionItem and replaces its functionality with an autoCollapse property on GlAccordion. (closes #1358 (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.

Closes #1348 (closed) and #1358 (closed)

Edited by Mike Greiling

Merge request reports