-
Notifications
You must be signed in to change notification settings - Fork 903
feat(checks/label): support ARIA element internals properties #5170
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
78b0302
feat(checks/label): support ARIA element internals properties
straker ba16fb3
use virtual
straker b015006
fix(checks/label): preserve value-truthy semantics for title-only ari…
chutchins25 358bbb4
Merge remote-tracking branch 'origin/develop' into internals-checks-l…
chutchins25 1f6d801
test(checks/label): cover ariaLabelledByElements in multiple-label
chutchins25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,12 @@ | ||
| import { labelVirtual, titleText } from '../../commons/text'; | ||
| import { getAriaValue } from '../../commons/aria'; | ||
|
|
||
| function titleOnlyEvaluate(node, options, virtualNode) { | ||
| const labelText = labelVirtual(virtualNode); | ||
| const title = titleText(virtualNode); | ||
| const ariaDescribedBy = virtualNode.attr('aria-describedby'); | ||
| const ariaDescribedBy = getAriaValue(virtualNode, 'aria-describedby'); | ||
|
|
||
| return !labelText && !!(title || ariaDescribedBy); | ||
| return !labelText && !!(title || ariaDescribedBy?.value); | ||
| } | ||
|
|
||
| export default titleOnlyEvaluate; | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -243,6 +243,38 @@ describe('multiple-label', () => { | |||||
| ); | ||||||
| }); | ||||||
|
|
||||||
| // ariaLabelledByElements (reflected AOM property) coverage adapted from | ||||||
| // @jcfranco's work in #5187 (issue #4943) | ||||||
|
Comment on lines
+246
to
+247
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
We can do attribution in other ways. Doesn't belong in the code. |
||||||
| it('should return false when ariaLabelledByElements overrides aria-labelledby', () => { | ||||||
| fixtureSetup(html` | ||||||
| <input type="checkbox" id="F" aria-labelledby="G" /> | ||||||
| <label for="F" id="G" aria-hidden="true">Please</label> | ||||||
| <label for="F" id="H">Excuse</label> | ||||||
| `); | ||||||
| const target = fixture.querySelector('#F'); | ||||||
| target.ariaLabelledByElements = [fixture.querySelector('#H')]; | ||||||
| assert.isFalse( | ||||||
| axe.testUtils | ||||||
| .getCheckEvaluate('multiple-label') | ||||||
| .call(checkContext, target) | ||||||
| ); | ||||||
| }); | ||||||
|
|
||||||
| it('should return false when ariaLabelledByElements overrides aria-labelledby with aria-label present', () => { | ||||||
| fixtureSetup(html` | ||||||
| <input type="checkbox" id="F" aria-labelledby="G" aria-label="Nope" /> | ||||||
| <label for="F" id="G" aria-hidden="true">Please</label> | ||||||
| <label for="F" id="H">Excuse</label> | ||||||
| `); | ||||||
| const target = fixture.querySelector('#F'); | ||||||
| target.ariaLabelledByElements = [fixture.querySelector('#H')]; | ||||||
| assert.isFalse( | ||||||
| axe.testUtils | ||||||
| .getCheckEvaluate('multiple-label') | ||||||
| .call(checkContext, target) | ||||||
| ); | ||||||
| }); | ||||||
|
|
||||||
| it('should return false given multiple labels, one label visible, and no aria-labelledby', () => { | ||||||
| fixtureSetup(html` | ||||||
| <input type="checkbox" id="I" /> | ||||||
|
|
@@ -337,4 +369,19 @@ describe('multiple-label', () => { | |||||
| .call(checkContext, shadowTarget.firstElementChild) | ||||||
| ); | ||||||
| }); | ||||||
|
|
||||||
| describe('ElementInternals', () => { | ||||||
| it('should return false given multiple labels, one label AT visible, and elementInternals aria-labelledby for AT visible', () => { | ||||||
| const checkEvaluate = axe.testUtils.getCheckEvaluate('multiple-label'); | ||||||
| const params = axe.testUtils.checkSetup(html` | ||||||
| <label for="target" aria-hidden="true" id="l1">Please</label> | ||||||
| <label for="target" id="l2">Excuse</label> | ||||||
| <testutils-element | ||||||
| id="target" | ||||||
| with-aria-labelledby="l2" | ||||||
| ></testutils-element> | ||||||
| `); | ||||||
| assert.isFalse(checkEvaluate.call(checkContext, ...params)); | ||||||
| }); | ||||||
| }); | ||||||
| }); | ||||||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is buggy (not new). We should consider building a proper accessibleDescription method and use that. Would you mind opening an issue for this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opened #5212 to track building a proper accessibleDescription method and switching this check to use it.