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

feat(pie-checkbox-group): DSW-1937 a11y improvements #1630

Merged
merged 4 commits into from
Jul 26, 2024

Conversation

dandel10n
Copy link
Contributor

@dandel10n dandel10n commented Jul 26, 2024

Problem: shadow DOM limitation for ARIA attributes binding + fieldset with checkboxes not announcing aria-describedby element text in VoiceOver and NVDA (known bug in screenreaders)
More info: https://www.matuzo.at/blog/2023/web-components-accessibility-faq/aria-references/ and nvaccess/nvda#12718

Solution: making PIE Assistive Text component optionally visually hidden to pass error information down to each Checkbox in Checkbox Group for assistive tech to have the error info while visually error will be shown only under Checkbox Group.

No visual changes to components introduced. PIE Docs Percy test shows a new prop added to PIE Assistive Text.

Author Checklist (complete before requesting a review)

  • I have performed a self-review of my code
  • I have reviewed the PIE Storybook/PIE Docs PR preview
  • If changes will affect consumers of the package, I have created a changeset entry.

Reviewer 1 - @xander-marjoram

  • I have reviewed the PIE Storybook / PIE Docs PR previews
  • I have reviewed the visual test changes

Reviewer 2 - @jamieomaguire

  • I have reviewed the PIE Storybook / PIE Docs PR previews
  • I have reviewed the visual test changes

Copy link

changeset-bot bot commented Jul 26, 2024

🦋 Changeset detected

Latest commit: c505cb4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages
Name Type
@justeattakeaway/pie-assistive-text Minor
@justeattakeaway/pie-checkbox-group Minor
@justeattakeaway/pie-checkbox Minor
pie-docs Patch
pie-storybook Patch
@justeattakeaway/pie-text-input Patch
@justeattakeaway/pie-webc Patch
wc-angular12 Patch
wc-next10 Patch
wc-next13 Patch
wc-nuxt2 Patch
wc-nuxt3 Patch
wc-react17 Patch
wc-react18 Patch
wc-vanilla Patch
wc-vue3 Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@dandel10n dandel10n force-pushed the dsw-1937-checkbox-group-a11y branch 4 times, most recently from 5952f4d to 5dbde3a Compare July 26, 2024 11:40
@dandel10n dandel10n marked this pull request as ready for review July 26, 2024 11:49
@dandel10n dandel10n requested review from a team as code owners July 26, 2024 11:49
@dandel10n dandel10n force-pushed the dsw-1937-checkbox-group-a11y branch from 5dbde3a to 397fc13 Compare July 26, 2024 11:56
@dandel10n dandel10n force-pushed the dsw-1937-checkbox-group-a11y branch from 7468d8b to f258fb4 Compare July 26, 2024 13:26
@xander-marjoram xander-marjoram self-requested a review July 26, 2024 13:53
@jamieomaguire jamieomaguire self-requested a review July 26, 2024 13:53
jamieomaguire
jamieomaguire previously approved these changes Jul 26, 2024
@dandel10n dandel10n merged commit 42cc25e into main Jul 26, 2024
37 of 40 checks passed
@dandel10n dandel10n deleted the dsw-1937-checkbox-group-a11y branch July 26, 2024 15:20
JoshuaNg2332 pushed a commit that referenced this pull request Jul 29, 2024
* feat(pie-checkbox-group): DSW-1937 a11y improvements

* feat(pie-checkbox-group): DSW-1937 making _slottedChildren query optional

* feat(pie-checkbox-group): DSW-1937 type for SlottedComponentProps and CheckboxProps imports
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants