fix(table): Add aria-rowcount to virtualized tables #4156
Merged
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
Tachometer resultsChrometable permalinkbasic-test
Firefoxtable permalinkbasic-test
|
Lighthouse scores
What is this?Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on Transfer Size
Request Count
|
Westbrook
reviewed
Mar 14, 2024
|
|
||
| // Ensures screenreaders can announce the true size of the table | ||
| // despite virtualization only rendering a subset of rows. | ||
| this.setAttribute('aria-rowcount', `${this.items.length}`); |
There was a problem hiding this comment.
Because this code path is only run when items has a length were this table to be used with filtering or searching and the length could conceivable become 0, there is a change that this data would be out of date. Should we remove this attribute in the implied else at line 474?
Westbrook
force-pushed
the
davidx/table-rowcount-tomain
branch
from
45ea969
to
74cd78e
Compare
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.
Description
The
sp-tablecomponent can be virtualized, which only renders table rows that are currently visible in the viewport, which helps with performance on large tables. However, this can trip up screenreaders, which only detect and announce the rendered rows, and not the true size of the table.aria-rowcountis a screenreader attribute which announces the true unvirtualized size of the table.This PR implements the automatic application of
aria-rowcountfor virtualized tables.Related issue(s)
Motivation and context
Accuracy and efficacy of screenreader accessibility.
How has this been tested?
sp-tableelementaria-rowcountvalue is correct.sp-tableelementaria-rowcountvalue is correct.Screenshots (if appropriate)
Before my changes
After my changes
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main.