Fix (16747)(A11y) : Proper Conveyance of Word/Character Count by screen readers #16898
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 v11-carbon-react ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
2nikhiltom
changed the title
tay1orjones
approved these changes
Jul 16, 2024
Comment on lines
434
to
442
| setTimeout( | ||
| () => { | ||
| if (announcer) { | ||
| announcer.textContent = ariaAnnouncement; | ||
| setPrevAnnouncement(ariaAnnouncement); | ||
| } | ||
| }, | ||
| counterMode === 'word' ? 2000 : 1000 | ||
| ); |
There was a problem hiding this comment.
I think it might be best to be sure the timeout is cleared in the useEffect cleanup just in case the component unmounts before the timeout expires. In theory this should be garbage collected but it's a small add for this extra assurance.
| // Clear the content first | ||
| announcer.textContent = ''; | ||
| // Set the new content after a small delay | ||
| setTimeout(() => { |
There was a problem hiding this comment.
Same thing here with clearing this timeout just in case
tay1orjones
added
status: one more review 👀
and removed
status: ready for review 👀
labels
riddhybansal
approved these changes
Jul 22, 2024
riddhybansal
added
status: ready to merge 🎉
and removed
status: one more review 👀
labels
Merged
via the queue into
carbon-design-system:main
with commit Jul 23, 2024
bf33904
22 checks passed
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.
Closes #16747
When the
maxCountword limit is set along with theenableCounterprop, the screen reader announcement for the word/character count used to only triggers once when10 words/characterswere left.Also, no announcements are made when the
maximumword/character count is reached. This inconsistency makes it difficult for screen reader users to understand the remaining count and when the limit is hit.This PR does two things
Incremental Announcements
It will now make announcements for each of the last 10 characters/words, properly conveying the remaining count.
Max Count Announcement
An additional announcement will be made when the maximum word/character count is reached, ensuring users are informed when the limit is hit.
Changelog
The
useAnnouncerfunction is updated to track when the maximum limit is reached and ensure announcements are made for each of the last 10 characters/words.The test cases for
useAnnouncerhave been updated to reflect the new changes and ensure proper functionality.Within the component, useAnnouncer is called inside a
useEffecthook to manage the timing of announcements.This is to ensures that same announcements are not repeated unnecessarily and are made after a delay, allowing both the counter and the announcement of the actual text being written to be audible
Testing / Reviewing
Also verify that readOnly status is announced by screenReader when readonly is true