archive-gh-me/react-use
1
0
Fork 0
mirror of https://github.com/streamich/react-use.git synced 2026-01-18 14:06:52 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #104 from gavingregory/fix-keypress-docs

Browse Source 
docs(useKeyPress): renamed keyboardjs -> useKeyboardJS
This commit is contained in:
Va Da 2019-02-10 18:18:05 +01:00 committed by GitHub
commit 07baffdfad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/useKeyPress.md
View File

@ -3,9 +3,9 @@
React UI sensor hook that detects when the user is pressing a specific
key on their keyboard.
Complex bindings like detecting when multiple keys are held down at the same
time or requiring them to be held down in a specified order are also available
via [KeyboardJS key combos](https://github.com/RobertWHurst/KeyboardJS).
Complex bindings like detecting when multiple keys are held down at the same
time or requiring them to be held down in a specified order are also available
via [KeyboardJS key combos](https://github.com/RobertWHurst/KeyboardJS).
Check its documentation for further details on how to make combo strings.
## Usage
@ -21,7 +21,7 @@ const Demo = () => {
const hasPressedT = useKeyPress("t");
const hasPressedY = useKeyPress("y");
const hasPressedWord = useKeyPress("q + w + e + r + t + y", {
keyboardjs: true
useKeyboardJS: true
});
return (