Skip to content

docs: Ecosystem library agnostic #579

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
Aug 31, 2020
Merged

docs: Ecosystem library agnostic #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17f53be
docs: make user-event docs library agnostic
timdeschryver Aug 25, 2020
286cb19
docs: make jest-dom library agnostic
timdeschryver Aug 25, 2020
c735c3d
docs: update examples
timdeschryver Aug 31, 2020
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docs/ecosystem-jest-dom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ id: ecosystem-jest-dom
title: jest-dom
---

[`jest-dom`][gh] is a companion library for `React Testing Library` that
provides custom DOM element matchers for Jest
[`jest-dom`][gh] is a companion library for Testing Library that provides custom
DOM element matchers for Jest

```
npm install --save-dev @testing-library/jest-dom
Expand All @@ -14,11 +14,17 @@ Then follow [usage section][gh-usage] from jest-dom's documentation to add the
matchers to Jest.

```jsx
<span data-testid="not-empty"><span data-testid="empty"></span></span>
<div data-testid="visible">Visible Example</div>
import { screen } from '@testing-library/dom'

expect(screen.queryByTestId('not-empty')).not.toBeEmptyDOMElement()
expect(screen.getByText('Visible Example')).toBeVisible()
test('uses jest-dom', () => {
document.body.innerHTML = `
<span data-testid="not-empty"><span data-testid="empty"></span></span>
<div data-testid="visible">Visible Example</div>
`

expect(screen.queryByTestId('not-empty')).not.toBeEmptyDOMElement()
expect(screen.getByText('Visible Example')).toBeVisible()
})
```

> Note: when using some of these matchers, you may need to make sure you use a
Expand Down
17 changes: 8 additions & 9 deletions docs/ecosystem-user-event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,23 @@ id: ecosystem-user-event
title: user-event
---

[`user-event`][gh] is a companion library for `React Testing Library` that
provides more advanced simulation of browser interactions than the built-in
`fireEvent` method.
[`user-event`][gh] is a companion library for Testing Library that provides more
advanced simulation of browser interactions than the built-in `fireEvent`
method.

```
npm install --save-dev @testing-library/user-event
```

```jsx
import React from 'react'
import { render } from '@testing-library/react'
import { screen } from '@testing-library/dom'
import userEvent from '@testing-library/user-event'

test('click', async () => {
const { getByRole } = render(<textarea />)
test('types inside textarea', async () => {
document.body.innerHTML = `<textarea />`

await userEvent.type(getByRole('textbox'), 'Hello, World!')
expect(getByRole('textbox')).toHaveValue('Hello, World!')
await userEvent.type(screen.getByRole('textbox'), 'Hello, World!')
expect(screen.getByRole('textbox')).toHaveValue('Hello, World!')
})
```

Expand Down