Skip to content

feat: Add isInaccessible #284

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.

Sign up for GitHub

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 3 commits into from
Oct 12, 2019
Merged

feat: Add isInaccessible #284

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8875918
feat: Add shouldExcludeFromA11yTree
eps1lon Oct 7, 2019
5b1a6ae
Provide text alternative for link
eps1lon Oct 10, 2019
2b85f19
shouldExcludeFromA11yTree -> isInaccessible
eps1lon Oct 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/dom-testing-library/api-helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ for other popular assertion libraries:

- [chai-dom](https://github.com/nathanboktae/chai-dom)

If you're aware of some other alternatives, please [make a pull request](https://github.com/testing-library/testing-library-docs/pulls)
If you're aware of some other alternatives, please
[make a pull request](https://github.com/testing-library/testing-library-docs/pulls)
and add it here!

## `getNodeText`
Expand Down Expand Up @@ -185,6 +186,19 @@ console.log(getRoles(nav))
// }
```

## `isInaccessible`

This function will compute if the given element should be excluded from the
accessibility API by the browser. It implements every **MUST** criteria from the
[Excluding Elements from the Accessibility Tree](https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion)
section in WAI-ARIA 1.2 with the exception of checking the `role` attribute.

It is defined as:

```typescript
function isInaccessible(element: Element): boolean
```

## Debugging

When you use any `get` calls in your test cases, the current state of the
Expand Down