diff --git a/docs/dom-testing-library/api-configuration.md b/docs/dom-testing-library/api-configuration.md index 2abd43ead..2c82abd33 100644 --- a/docs/dom-testing-library/api-configuration.md +++ b/docs/dom-testing-library/api-configuration.md @@ -24,6 +24,13 @@ for you to identify the part of your code that resulted in the error (async stack traces are hard to debug). If you want to disable this, then set `showOriginalStackTrace` to `false`. You can also disable this for a specific call in the options you pass to `waitFor`. +`throwSuggestions`: (experimental) When enabled, if [better queries](https://testing-library.com/docs/guide-which-query) are available +the test will fail and provide a suggested query to use instead. Default to `false`. + +To disable a suggestion for a single query just add `{suggest:false}` as an option. +```js +screen.getByTestId("foo", {suggest:false}); // will not throw a suggestion +``` `testIdAttribute`: The attribute used by [`getByTestId`](api-queries#bytestid) and related queries. Defaults to `data-testid`.