Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(accordion): update documentation examples to ensure a11y compliance #7172

Merged
merged 2 commits into from
Jan 28, 2025

Conversation

damienrobson-sage
Copy link
Contributor

Proposed behaviour

Update the documented examples to be a11y-compliant

Current behaviour

Documented examples of Accordion which render mutliple instances with content throw an a11y violation indicating non-unique landmarks

Checklist

  • Commits follow our style guide
  • Related issues linked in commit messages if required
  • Screenshots are included in the PR if useful
  • All themes are supported if required
  • Unit tests added or updated if required
  • Playwright automation tests added or updated if required
  • Storybook added or updated if required
  • Translations added or updated (including creating or amending translation keys table in storybook) if required
  • Typescript d.ts file added or updated if required
  • Related docs have been updated if required

QA

  • Tested in provided StackBlitz sandbox/Storybook
  • Add new Playwright test coverage if required
  • Carbon implementation matches Design System/designs
  • UI Tests GitHub check reviewed if required

Testing instructions

Run AXE DevTools against any of the Accordion Storybook examples with more than one collapsed accordion on it. Regardless of open/closed state, no error should be flagged

DipperTheDan
DipperTheDan previously approved these changes Jan 22, 2025
DipperTheDan
DipperTheDan previously approved these changes Jan 23, 2025
@mihai-albu-sage mihai-albu-sage self-requested a review January 23, 2025 13:58
@damienrobson-sage damienrobson-sage merged commit ea849e3 into master Jan 28, 2025
28 checks passed
@damienrobson-sage damienrobson-sage deleted the FE-7056 branch January 28, 2025 15:24
@carbonci
Copy link
Collaborator

🎉 This PR is included in version 147.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

5 participants