Description list not structured properly for screen readers #3053
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for ons-design-system-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…esented-for-screenreaders
rmccar
reviewed
Feb 28, 2024
alessioventuriniAND
approved these changes
Feb 28, 2024
rmccar
reviewed
Feb 28, 2024
…esented-for-screenreaders
rmccar
reviewed
Feb 28, 2024
rmccar
approved these changes
Feb 28, 2024
…esented-for-screenreaders
rmccar
pushed a commit
that referenced
this pull request
Mar 6, 2024
* initial change * update test * update test * update comment * update comment
alessioventuriniAND
added a commit
that referenced
this pull request
Apr 4, 2024
…wcag 22 level aaa (#3119) * ⬆️ Back To Top Link ⬆️ (#2990) * Page template for length * Add macro * Add component foundations * Build stylesheet * Add additional functionality * Improved functionality * Fix border and layout * Fix resize behaviour * Changes to CSS * Add more tests * Update VR Tests * Change to full width --------- Co-authored-by: Alessio Venturini <112873190+alessioventuriniAND@users.noreply.github.com> * Description list not structured properly for screen readers (#3053) * initial change * update test * update test * update comment * update comment * Update placeholder text colour (#3062) * Fix/3004/icon in footer not clickable (#3036) * Fix checkbox appearance on safari (#3066) * Adding the change in readme (#3067) * updated youtube video to a more accessible one * updated reference files --------- Co-authored-by: Aditya Unnithan_ONS <56112669+adi-unni@users.noreply.github.com> Co-authored-by: Precious Onyenaucheya <86783201+precious-onyenaucheya-ons@users.noreply.github.com> Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com> Co-authored-by: Bali Birch-Lee_ONS <149602681+balibirchlee@users.noreply.github.com> Co-authored-by: SriHV <123635670+SriHV@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the context of this PR?
Fixes #3027
The current structure of the summary component utilises multiple
<dl>elements, causing the screen reader to interpret them as separate list elements, which does not pass accessibility tests.This PR addresses the issue by restructuring the Summary component so that the list is enclosed within a single
<dl>element. This change ensures that the screen reader recognises it as one list rather than multiple lists.This PR also removed some rules from the Axe tests on the summary component. When resolving this DAC issue the tests failed and to fix them would require a major refactor. The issue they raised wasn't something that was seen as an a problem accessibility wise so it was decided that we would disable the rules on these tests.
How to review this PR
Check that the summary list is wrapped in a
<dl>element and is being read out correctly by the screen readerChecklist
This needs to be completed by the person raising the PR.