Skip to content

fix: add deprecation notice for *ByA11yState and *ByA11yValue queries #1269

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
mdjastrzebski merged 4 commits into from
Jan 3, 2023
Merged

fix: add deprecation notice for *ByA11yState and *ByA11yValue queries #1269

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
673bd9f
fix: add deprecation notice for *ByA11yState and *ByA11yValue queries
mdjastrzebski Dec 30, 2022
3e04629
Update website/docs/Queries.md
mdjastrzebski Jan 2, 2023
f2f44b2
Update website/docs/Queries.md
mdjastrzebski Jan 2, 2023
d47b091
Update website/docs/Queries.md
mdjastrzebski Jan 3, 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
13 changes: 13 additions & 0 deletions website/docs/Queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,12 @@ const element3 = screen.getByRole('button', { name: "Hello", disabled: true });

### `ByA11yState`, `ByAccessibilityState`

:::caution
This query uses a predicate that is typically too general to give meaningful results. Therefore, it's better to use one of the following options:
* use one of [`ByRole`](#byrole) queries with relevant state options: `disabled`, `selected`, `checked`, `expanded` and `busy`
* use [`toHaveAccessibilityState()`](https://github.com/testing-library/jest-native#tohaveaccessibilitystate) matcher to check the state of element found using some other query
:::

> getByA11yState, getAllByA11yState, queryByA11yState, queryAllByA11yState, findByA11yState, findAllByA11yState
> getByAccessibilityState, getAllByAccessibilityState, queryByAccessibilityState, queryAllByAccessibilityState, findByAccessibilityState, findAllByAccessibilityState

Expand Down Expand Up @@ -362,6 +368,13 @@ The difference in handling default values is made to reflect observed accessibil

### `ByA11Value`, `ByAccessibilityValue`

:::caution
This query uses a predicate that is typically too general to give meaningful results. Therefore, it's better to use one of the following options:
* use one of [`ByRole`](#byrole) queries with `value` option
* use [`toHaveAccessibilityValue()`](https://github.com/testing-library/jest-native#tohaveaccessibilityvalue) matcher to check the state of element found using some other query
:::


> getByA11yValue, getAllByA11yValue, queryByA11yValue, queryAllByA11yValue, findByA11yValue, findAllByA11yValue
> getByAccessibilityValue, getAllByAccessibilityValue, queryByAccessibilityValue, queryAllByAccessibilityValue, findByAccessibilityValue, findAllByAccessibilityValue

Expand Down