Fix: Inserter Search Results Not Announcing #10755
Conversation
tofumatt
left a comment
There was a problem hiding this comment.
Awesome, thanks so much.
Tested this in Windows with Firefox + NVDA as well and it worked a treat. 👍
| openPanels, | ||
| } ); | ||
|
|
||
| const resultCount = Object.keys( itemsPerCategory ).reduce( ( memo, curr ) => memo + itemsPerCategory[ curr ].length, 0 ); |
There was a problem hiding this comment.
I'll fix this, but for future reference: please use full words for variables whenever possible. It's easier to read current than curr. I assume this should be current, right? 😄
There was a problem hiding this comment.
Thanks @tofumatt, I'll make sure to read over the documentation to make sure I follow the standards going forward! 👍
* added functionality to get the result count and announcer it in the live region * chore: Tweak variable names/readability * Sort props
| openPanels, | ||
| } ); | ||
|
|
||
| const resultCount = Object.keys( itemsPerCategory ).reduce( ( accumulator, currentCategorySlug ) => { |
There was a problem hiding this comment.
Coming to this way late, but in some recent refactoring I've come across remnants of this code. My first impression was: Why does this do a reduce operation on itemsPerCategory if filteredItems array is already available much more directly (i.e. filteredItems.length)? It then occurred to me that itemsPerCategory can yield slightly different results, notably in how it filters out reusable blocks. But then again, it doesn't seem to be that we'd want reusable blocks to be excluded from the announced results.
In my testing, this is exactly what happens ("0 results found" when there's a reusable block search result present).
Ultimately, then, it would seem that filteredItems.length would be both more direct and more accurate?
There was a problem hiding this comment.
Ultimately, then, it would seem that
filteredItems.lengthwould be both more direct and more accurate?
Proposed for change at: #22279
Description
The inserter search results do not announce to screen readers the current number of filtered results. This implements some logic to calculate that number and announce to the user how many results have been found.
How has this been tested?
First and foremost, I typed in various strings of text to change the number of results. Then I made sure the text in the live region calculated the correct number and matched up with the actual count.
Then I used VoiceOver and Safari (there is a bug in other browsers where aria-live doesn't work) to test that the value of the aria-live region is read to a screen reader. At least from my initial testing everything seemed to work correctly.
Screenshots
Types of changes
Makes the inserter more accessible by fixing this issue: #10583
Checklist: