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

eps1lon · timdeschryver · web-flow · commit 4575c9d6dfd8 · 2023-03-24T19:04:05.000+01:00
* feat(ByRole): Allow filter by busy state

* TODO: reword+fixup

* Update docs/queries/byrole.mdx

Co-authored-by: Tim Deschryver &lt;28659384+timdeschryver@users.noreply.github.com&gt;

---------

Co-authored-by: Tim Deschryver &lt;28659384+timdeschryver@users.noreply.github.com&gt;
diff --git a/docs/queries/byrole.mdx b/docs/queries/byrole.mdx
@@ -21,6 +21,7 @@ getByRole(
     name?: TextMatch,
     description?: TextMatch,
     selected?: boolean,
+    busy?: boolean,
     checked?: boolean,
     pressed?: boolean,
     suggest?: boolean,
@@ -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
