Skip to content

Add documentation for screen.debug. #362

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 4 commits into from
Jan 28, 2020
Merged

Add documentation for screen.debug. #362

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e1d92d
Add documentation for screen.debug.
jkdowdle Jan 21, 2020
2c17498
Update api-queries.md
kentcdodds Jan 28, 2020
02aca19
Update api-queries.md
kentcdodds Jan 28, 2020
dd386b4
Update api-queries.md
kentcdodds Jan 28, 2020
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
23 changes: 23 additions & 0 deletions docs/dom-testing-library/api-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,29 @@ document.body.innerHTML = exampleHTML
const exampleInput = screen.getByLabelText(/example/i)
```

### `screen.debug`

For convenience screen also exposes a `debug` method in addition to the queries.
This method is essentially a shortcut for `console.log(prettyDOM())`. It
supports debugging the document, a single element, or an array of elements.

```javascript
import {screen} from '@testing-library/dom'

document.body.innerHTML = `
<button>test</button>
<span>multi-test</span>
<div>multi-test</div>
`

// debug document
screen.debug()
// debug single element
screen.debug(screen.getByText('test'))
// debug multiple elements
screen.debug(screen.getAllByText('multi-test'))
```

## Queries

> NOTE: These queries are the base queries and require you pass a `container` as
Expand Down