![\"Solid](\"https://assets.solidjs.com/banner?type=Primitives&background=tiles&project=keyboard\")
\n\n
Is pressing Alt? {pressing() ? \"YES\" : \"NO\"}
;\n```\n\n## `createShortcut`\n\nCreates a keyboard shotcut observer. The provided callback will be called when the specified keys are pressed.\n\n### How to use it\n\n`createShortcut` takes three arguments:\n\n- `keys` — list of keys to listen for\n- `callback` — callback to call when the specified keys are pressed\n- `options` — additional configuration:\n - `preventDefault` — call `e.preventDefault()` on the keyboard event, when the specified key is pressed. _(Defaults to `true`)_\n - `requireReset` — If `true`, the shortcut will only be triggered once until all of the keys stop being pressed. Disabled by default.\n\n```tsx\nimport { createShortcut } from \"@solid-primitives/keyboard\";\n\ncreateShortcut(\n [\"Control\", \"Shift\", \"A\"],\n () => {\n console.log(\"Shortcut triggered\");\n },\n { preventDefault: false, requireReset: true },\n);\n```\n\n### Preventing default\n\nWhen `preventDefault` is `true`, `e.preventDefault()` will be called not only on the keydown event that has triggered the callback, but it will **optimistically** also prevent the default behavior of every previous keydown that will have the possibility to lead to the shortcut being pressed.\n\nE.g. when listening for `Control + Shift + A`, all three keydown events will be prevented.\n\n## DEMO\n\nWorking demo of some of the primitives in keyboard package:\n\nhttps://codesandbox.io/s/solid-primitives-keyboard-demo-s2l84k?file=/index.tsx\n\n## Changelog\n\nSee [CHANGELOG.md](./CHANGELOG.md)","users":{}}