Skip to content

feat(ByRole): Allow filter by busy state #1232

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
Mar 24, 2023
Merged

feat(ByRole): Allow filter by busy state #1232

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a95640
feat(ByRole): Allow filter by busy state
eps1lon Mar 9, 2023
c93334c
TODO: reword+fixup
eps1lon Mar 9, 2023
d48222f
Update docs/queries/byrole.mdx
eps1lon Mar 24, 2023
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
22 changes: 22 additions & 0 deletions docs/queries/byrole.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ getByRole(
name?: TextMatch,
description?: TextMatch,
selected?: boolean,
busy?: boolean,
checked?: boolean,
pressed?: boolean,
suggest?: boolean,
Expand Down Expand Up @@ -115,6 +116,27 @@ you can get the "Native"-tab by calling `getByRole('tab', { selected: true })`.
To learn more about the selected state and which elements can have this state
see [ARIA `aria-selected`](https://www.w3.org/TR/wai-aria-1.2/#aria-selected).

### `busy`

You can filter the returned elements by their busy state by setting `busy: true`
or `busy: false`.

For example in

```html
<body>
<section>
<div role="alert" aria-busy="false">Login failed</div>
<div role="alert" aria-busy="true">Error: Loading message...</div>
</section>
</body>
```

you can get the "Login failed" alert by calling
`getByRole('alert', { busy: false })`. To learn more about the busy state see
[ARIA `aria-busy`](https://www.w3.org/TR/wai-aria-1.2/#aria-busy) and
[MDN `aria-busy` attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-busy).

### `checked`

You can filter the returned elements by their checked state by setting
Expand Down