Skip to content

Commit

Permalink
docs: document firing keyboard events (testing-library#154)
Browse files Browse the repository at this point in the history
<!--
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!

Please make sure that you are familiar with and follow the Code of Conduct for
this project (found in the CODE_OF_CONDUCT.md file).

Also, please make sure you're familiar with and follow the instructions in the
contributing guidelines (found in the CONTRIBUTING.md file).

If you're new to contributing to open source projects, you might find this free
video course helpful: http://kcd.im/pull-request

Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!
-->

<!-- What changes are being made? (What feature/bug is being fixed here?) -->

**What**: Vague documentation (issue testing-library#153 )

<!-- Why are these changes necessary? -->

**Why**: To clarify usage to users

<!-- How were these changes implemented? -->

**How**: Added documentation

<!-- Have you done all of these things?  -->

**Checklist**:

<!-- add "N/A" to the end of each line that's irrelevant to your changes -->

<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->

- [x] Documentation N/A
- [ ] Tests N/A
- [x] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->

<!-- feel free to add additional comments -->
  • Loading branch information
jakst authored and Kent C. Dodds committed Nov 19, 2018
1 parent b8752fb commit 81299da
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,14 @@ fireEvent.change(getByLabelText(/picture/i), {
})
```

**Keyboard events**: There are three event types related to keyboard input - `keyPress`, `keyDown`, and `keyUp`. When firing these you need to reference an element in the DOM and the key you want to fire.

```javascript
fireEvent.keyDown(domNode, { key: 'Enter', code: 13 })
```

You can find out which key code to use at [https://keycode.info/](https://keycode.info/).

### `getNodeText`

```typescript
Expand Down

0 comments on commit 81299da

Please sign in to comment.