Skip to content

Commit 9203b7f

Browse files
committed
doc: Updated wording on isHotkeyPressed key argument
1 parent 154eab9 commit 9203b7f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

packages/documentation/docs/api/is-hotkey-pressed.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,11 @@ const onClick = () => isHotkeyPressed('shift') ? setCount(count - 1) : setCount(
2929
key: string | string[]
3030
```
3131

32-
The key or keys to check. This can be a single key string (like `'a'`), a
33-
delimited string of keys (like `'shift,a'`), or an array of strings (like
34-
`['a','shift']`). If multiple keys are provided, either as a delimited string or
35-
as an array, all keys must be pressed down for the function to return `true`.
32+
The key or keys to check. This can be a single keycode string (like `'a'`), a
33+
delimited string of keycodes (like `'shift,a'`), or an array of keycode strings
34+
(like `['shift','a']`). If multiple keys are provided, either as a delimited
35+
string or as an array, all keys must be pressed down for the function to return
36+
`true`.
3637

3738
Special characters that require `shift` to be held (like `!`, `@`, `#`, `?`,
3839
etc.) are also not directly supported; instead, check if the base key is held

0 commit comments

Comments
 (0)