Merge pull request #1311 from ShrimpCryptid/feat/clarify-ishotkeypressed-multiple-key-behavior

fix: Fixed incorrect documentation for `isHotkeyPressed` arguments

Author: JohannesKlauss

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

@@ -11,7 +11,7 @@ Function signature:
 function isHotkeyPressed(key: string | string[], splitKey: string = ','): boolean
 ```
 
-This function allows us to check if a specific key is pressed by the user.
+This function allows us to check if a specific key or combination of keys is pressed by the user.
 
 ```jsx
 const isHotkeyPressed = useIsHotkeyPressed();
@@ -29,19 +29,34 @@ const onClick = () => isHotkeyPressed('shift') ? setCount(count - 1) : setCount(
 key: string | string[]
 ```
 
-The key we want to listen to. This can be a string (like `'a'`, `'shift+a'`) or an array of strings (like `['a', 'shift+a']`).
+The key or keys to check. This can be a single keycode string (like `'a'`), a
+delimited string of keycodes (like `'shift,a'`), or an array of keycode strings
+(like `['shift','a']`). If multiple keys are provided, either as a delimited
+string or as an array, all keys must be pressed down for the function to return
+`true`.
+
+Special characters that require `shift` to be held (like `!`, `@`, `#`, `?`,
+etc.) are also not directly supported; instead, check if the base key is held
+(like `1`, `2`, `3`, `slash`, etc.) along with the `shift` key (e.g.
+`['shift','1']`).
+
+:::caution Warning 
+The `mod` key is not supported. Please check for `ctrl` and
+`meta` keys separately.
+:::
 
 ### splitKey
 
 ```ts
 key: string = ','
 ```
 
-We can combine to check for multiple keys in one string by separating them with a comma (`,`). We can change
-this by passing a different key.
+The delimiter used to parse multiple keys from a single string. This is a comma
+(`,`) by default.
 
 ## Return value
 
 ### boolean
 
-The function returns `true` if the key or keystroke is currently pressed down, otherwise it will return `false`.
+The function returns `true` if the key or key combination is currently pressed
+down, otherwise it will return `false`.

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

@@ -4,7 +4,7 @@ sidebar_position: 4
 
 # isHotkeyPressed
 
-This function allows us to check if the user is currently pressing down a key.
+This function allows us to check if the user is currently pressing down a key or a combination of keys.
 
 ## Basic Usage
 
@@ -43,4 +43,22 @@ function ExampleComponent() {
 }
 ```
 
-Just like with `useHotkeys`, you can pass an array as the first argument to check for multiple keys.
+You can pass an array or delimited string as the first argument to check if
+multiple keys are pressed simultaneously. Commas (`,`) are used as the default
+delimiter.
+
+```jsx live
+function ExampleComponent() {
+  const [pressed, setPressed] = useState(false);
+
+  // You can also pass a string with delimiters like 'shift,a'
+  const onClick = () => setPressed(isHotkeyPressed(['shift', 'a']));
+
+  return (
+    <div>
+      <p>The hotkey was: {pressed ? 'pressed' : 'not pressed'}</p>
+      <button onClick={onClick}>Check if hotkey is pressed</button>
+    </div>
+  )
+}
+```