Acceptance Tests: Guidance on [aria-*] attributes
#663
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
mike-burns
approved these changes
May 13, 2022
JoelQ
approved these changes
May 31, 2022
| @@ -55,9 +55,18 @@ | |||
| - Use `it` block descriptions that describe the success and failure paths. | |||
| - Use spec/system directory to store system specs. | |||
| - Use spec/support/system for support code related to system specs. | |||
| - Don't assert an element's state with `[class]` or `[data-*]` attributes. | |||
|
Love it! It would be cool to have a blog post on this theme so we can link it here |
When exercise pages that implement behaviors through custom or third-party widgets, tests might locate elements or drive actions based on CSS classes (e.g. `.expanded` or `.collapsed`) or `[data-*]` attributes (e.g. `[data-disclosure-toggled-value="true"]` or `[data-test-id="toggle-widget"]`). While these techniques can be helpful work-arounds that exercise the page, they're low-fidelity alternatives to end-users experiences. When widgets cannot be exercised by Capybara's suite of selectors or matchers like `click_on`, test authors should rely on the same sets of WAI-ARIA compliant attributes that assistive technologies would expect. For example, if an application's constraints obstruct the author from implementing a "checkbox" form control with an `<input type="checkbox">`, the tests that drive the alternative should "check" a form control with the `[role="checkbox"]` attribute, assert changes to its `[aria-checked]` attribute, and conform to any of the other expected attributes and behaviors outlined by the [WAI ARIA Authoring Practices][wai-aria-checkbox]. [wai-aria-checkbox]: https://www.w3.org/TR/wai-aria-practices/#checkbox
seanpdoyle
force-pushed
the
testing-aria-attributes
branch
from
287dcc6 to
ce342a7
Compare
|
@MatheusRich totally just dropping in, but DOM-testing-library does a pretty good job of highlighting using roles and then using associated |
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.
When exercising pages that implement behaviors through custom or
third-party widgets, tests might locate elements or drive actions based
on CSS classes (e.g.
.expandedor.collapsed) or[data-*]attributes (e.g.
[data-disclosure-toggled-value="true"]or[data-test-id="toggle-widget"]).While these techniques can be helpful work-arounds that exercise the
page, they're low-fidelity alternatives to end-users experiences.
When widgets cannot be exercised by Capybara's suite of selectors or
matchers like
click_on, test authors should rely on the same sets ofWAI-ARIA compliant attributes that assistive technologies would expect.
For example, if an application's constraints obstruct the author from
implementing a "checkbox" form control with an
<input type="checkbox">, the tests that drive the alternative should "check" aform control with the
[role="checkbox"]attribute, assert changes toits
[aria-checked]attribute, and conform to any of the other expectedattributes and behaviors outlined by the WAI ARIA Authoring
Practices.