v5.3.3

What's Changed

• Bump qs from 6.14.1 to 6.14.2 by @dependabot[bot] in #1340
• docs: document symbol and punctuation keys (closes #1303) by @Nicoreia in #1338
• Bump @babel/plugin-transform-modules-systemjs from 7.27.1 to 7.29.4 by @dependabot[bot] in #1337
• Bump fast-uri from 3.0.6 to 3.1.2 by @dependabot[bot] in #1335
• Update all non-major dependencies by @renovate[bot] in #1343
• Bump esbuild and vite by @dependabot[bot] in #1346
• Bump shell-quote from 1.8.3 to 1.8.4 by @dependabot[bot] in #1345
• Bump ws from 7.5.10 to 7.5.11 by @dependabot[bot] in #1341
• Update dependency @vitejs/plugin-react to v6 by @renovate[bot] in #1344
• Update all non-major dependencies by @renovate[bot] in #1348
• Bump launch-editor from 2.12.0 to 2.14.1 by @dependabot[bot] in #1350
• Update dependency globals to v17 by @renovate[bot] in #1349
• Bump webpack-dev-server from 5.2.3 to 5.2.5 by @dependabot[bot] in #1351
• Update all non-major dependencies to v4.1.9 by @renovate[bot] in #1352
• Update actions/checkout action to v7 by @renovate[bot] in #1353
• fixes modifiers support (ctrl,shift,alt, etc.) for useKey: true flag by @sergeyteleshev in #1317
• fix: respect AltGraph as a modifier by @pupuking723 in #1347

New Contributors

• @Nicoreia made their first contribution in #1338
• @sergeyteleshev made their first contribution in #1317
• @pupuking723 made their first contribution in #1347

Full Changelog: v.5.3.2...v5.3.3

v5.3.1

What's Changed

• Bump path-to-regexp from 0.1.12 to 0.1.13 by @dependabot[bot] in #1329
• Bump picomatch by @dependabot[bot] in #1328
• Bump follow-redirects from 1.15.11 to 1.16.0 by @dependabot[bot] in #1330
• Bump svgo from 3.3.2 to 3.3.3 by @dependabot[bot] in #1331
• fix: dynamic enabled option no longer triggers event listeners in v5.3.0 by @JohannesKlauss in #1333

Full Changelog: v5.3.0...v5.3.1

v5.3.2

• The previous release was pointing to a broken entry point

What's Changed

• Bump path-to-regexp from 0.1.12 to 0.1.13 by @dependabot[bot] in #1329
• Bump picomatch by @dependabot[bot] in #1328
• Bump follow-redirects from 1.15.11 to 1.16.0 by @dependabot[bot] in #1330
• Bump svgo from 3.3.2 to 3.3.3 by @dependabot[bot] in #1331
• fix: dynamic enabled option no longer triggers event listeners in v5.3.0 by @JohannesKlauss in #1333

Full Changelog: v5.3.0...v5.3.1

v5.3.0

What's Changed

• chore(deps): update dependency vite to v7.3.2 [security] by @renovate[bot] in #1321
• fix: prevent mod hotkey from triggering on Super/Windows key on non-macOS platforms by @samhoseinkhani in #1325
• Update all non-major dependencies by @renovate[bot] in #1326
• #1313 Fixed missing ref re-assignment for conditionally rendered elements by @oleksandr-danylchenko in #1314
• Add Key Blacklist Support to useRecordHotkeys by @vedmakk in #1268
• Update dependency @eslint/js to v10 by @renovate[bot] in #1327

New Contributors

• @samhoseinkhani made their first contribution in #1325
• @oleksandr-danylchenko made their first contribution in #1314
• @vedmakk made their first contribution in #1268

Full Changelog: v5.2.4...v5.3.0

v5.2.4

• Merge pull request #1312 from JohannesKlauss/revert-1275-main 1197daf
• Revert Regression introduced in "Try to prevent events firing incorrectly when using useKey: true" 612e549
• Merge pull request #1311 from ShrimpCryptid/feat/clarify-ishotkeypressed-multiple-key-behavior 0219c01
• doc: Updated wording on isHotkeyPressed key argument 9203b7f
• fix: Update documentation for isHotkeyPressed to describe arguments correctly 154eab9

---

v5.2.3...v5.2.4

v5.2.3

What's Changed

• chore(deps): update dependency vite to v7.1.11 [security] by @renovate[bot] in #1296
• feat: add metadata support for hotkeys by @pkulcsarnr in #1299
• chore(deps): update dependency vitest to v4 by @renovate[bot] in #1307
• chore(deps): update actions/setup-node action to v6 by @renovate[bot] in #1306
• chore(deps): update actions/checkout action to v6 by @renovate[bot] in #1305
• fix(deps): update all non-major dependencies by @renovate[bot] in #1304
• Try to prevent events firing incorrectly when using useKey: true by @matiastucci in #1275

New Contributors

• @pkulcsarnr made their first contribution in #1299
• @matiastucci made their first contribution in #1275

Full Changelog: v5.2.1...v5.2.3

v5.2.1

• fmt 73ea06f
• remove unused script 160f872
• fix dependencies 4c89bcb
• Updated CHANGELOG.md ce7f732
• Add sideEffects field to package.json f464e05

---

Full Changelog: v5.2.0...v5.2.1

v5.2.0

v5.1.0...v5.2.0

What's Changed

• Added biome as formatter & linter by @JohannesKlauss in #1255
• Update README.md by @iakuraa in #1294
• Include aria roles in ignores by @stutrek in #1291
• Fix missing hotkey prop by @ljani in #1287
• Add more details on mod modifier by @mickaelzhang in #1293

New Contributors

• @iakuraa made their first contribution in #1294
• @stutrek made their first contribution in #1291
• @ljani made their first contribution in #1287
• @mickaelzhang made their first contribution in #1293

Full Changelog: v5.1.0...v5.2.0

v5.1.0

What's Changed

• chore(deps): update all non-major dependencies by @renovate in #1236
• chore(deps): update all non-major dependencies by @renovate in #1242
• chore(deps): update dependency globals to v16 by @renovate in #1243
• chore(deps): update all non-major dependencies by @renovate in #1248
• Remove explicit 'null' type from useRef uses. by @dbowring in #1249
• Bump vite from 6.2.5 to 6.2.7 by @dependabot in #1246
• chore(deps): update dependency vite to v6.3.4 [security] by @renovate in #1250
• chore(deps): update all non-major dependencies by @renovate in #1251
• feature: sequential combos by @prajjwaldimri in #1247
• chore(deps): update dependency eslint to v9 by @renovate in #1237

New Contributors

• @dbowring made their first contribution in #1249
• @prajjwaldimri made their first contribution in #1247

Full Changelog: v5.0.2...v5.1.0

v5.0.0

🎉 Version 5!

Most users should not need to do any migration, but for those who use special characters (+,-/$? and so on) or a different delimiter key than + there is a bit of work to do.

🚨 Breaking Changes

<HotkeysProvider>

• enabledScopes in the HotkeysProvider has been renamed to activeScopes
• If all scopes are disabled in the HotkeysProvider no hotkeys will be active

useHotkeys

• The hook now only listens to the code of the hotkey, not the produced key. This will get rid of all the confusion between different keyboard layouts, multiple accidental triggers and so on.
• Special character mappings to the german keyboard layout code have been removed
• The splitKey option has been renamed to delimiter
• The combinationKey option has been renamed to splitKey
• New Option useKey: Setting this to true will listen to the produced key rather than the code. Helpful if you want to listen to something like ?, +, !...

🐛 Bugfixes

• Fixed a bug where listening to control instead of ctrl wouldn't trigger correctly

Migration Guide

• If you are using the splitKey option, rename that to delimiter
• If you are using the combinationKey option, rename that to splitKey

If you are listening to special characters like shift+1 in order to listen for the exclamation mark, rewrite your hook like so:

useHotkeys('!', callback, {useKey: true})

This will listen to the produced key instead of the code. Listening for shift is not necessary anymore, because the hook will only check if the produced key matches !, no matter how it has been produced. This will be layout agnostic.

If you want to listen to specifically shift+1, then use the hotkey like this:

useHotkeys('shift+1', callback)

useKey defaults to false, so you only need to set it, if you want to listen to special characters.

One common use case for this is listening to y and z. On a german layout those keys are swapped. So to comply with every possible keyboard layout, you would set useKey: true to listen to the produced key.

useHotkeys('y', callback, {useKey: true}) // Triggers if the user hits their y key on the keyboard depending on the layout
useHotkeys('y', callback) // Triggers if the user hits the y key implying US keyboard layout

New Contributors

• @sandstone991 made their first contribution in #1047

Full Changelog: v4.6.2...v5.0.0