feat(ByRole): Allow filter by selected state #540
Merged
Conversation
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 pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 62928cf:
|
Codecov Report
@@ Coverage Diff @@
## master #540 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 23 23
Lines 438 452 +14
Branches 105 111 +6
=========================================
+ Hits 438 452 +14
Continue to review full report at Codecov.
|
kentcdodds
reviewed
May 3, 2020
kentcdodds
approved these changes
May 5, 2020
|
🎉 This PR is included in version 7.4.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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:
Allows to filter results of
ByRoleby theiraria-selectedstate viagetByRole(role, { selected: true }).There were some concerns allowing filtering by aria attributes (can't find the issue anymore) since users could mistakenly add them arbitrarily to create selectors that look accessible while creating broken UIs.
This is why I think we should restrict filter options to attributes that are only allowed on certain roles.
For example, I wouldn't implement1. If people want to filter by aria attributes on arbitrary elements then they always have thegetByRole(role, { disabled: true })sincearia-disabledis a global attribute i.e. can be applied to any elementgetAllByRole(...).filter()escape hatch.1 I was looking at aria-disabled in ARIA 1.1. It is restricted to certain elements in 1.2. The gist still applies.
Why:
Spec-compliant convenience wrapper around
getAllByRole(role).filter(el => el.getAttribute('aria-selected') === "true")How:
aria-selectedselectedif the role does not support this attributeChecklist:
docs site: docs(ByRole): Add { selected: boolean } option testing-library-docs#458
DefinitelyTyped