Skip to content

docs: keyPress warning #1023

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

Closed
wants to merge 2 commits into from
Closed

docs: keyPress warning #1023

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c85fb04
docs: keyPress warning
dzianis-l Mar 10, 2022
2300b3c
Update docs/dom-testing-library/api-events.mdx
dzianis-l-backup Mar 10, 2022
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
2 changes: 2 additions & 0 deletions docs/dom-testing-library/api-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ fireEvent.keyDown(domNode, {key: 'Enter', code: 'Enter', charCode: 13})
fireEvent.keyDown(domNode, {key: 'A', code: 'KeyA'})
```

> :warning: `React` doesn't dispatch a `SyntheticEvent` for a native `keypress` event without `event.charCode === 13 || event.charCode >= 32`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not mistaken, this would be the first time that we mention something React specific into the core docs. From my point of view, I think we should keep the core docs framework agnostic, or else we can add more and more cases like these into the docs, which would make them harder to read.
What if we move this to the React FAQ or cheatsheet?
Thoughts @MatanBobi ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the resolved conversation above:

Note, that this is framework-specific and almost all use cases for this should use user-event instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, you're correct @ph-fritsche , but then maybe this comment shouldn't be added to the docs?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is some framework-specific knowledge that should be irrelevant to almost all developers.
The longer I think about it, the more I'm convinced that not adding such information would be better and that the fact that someone ran into this rather means we should do more to encourage people to use the right tool.
See #963 (comment)

> I.e. `onKeyPress` handlers will only be called if you include an appropriate `charCode` property.
You can find out which key code to use at
[https://keycode.info/](https://keycode.info/).

Expand Down