hotkey

What's Changed

• fix: hotkey mapper URL by @davidsneighbour in https://github.com/github/hotkey/pull/121
• Bump follow-redirects from 1.15.3 to 1.15.4 by @dependabot in https://github.com/github/hotkey/pull/122
• Bump follow-redirects from 1.15.4 to 1.15.6 by @dependabot in https://github.com/github/hotkey/pull/124
• Make localizeMod SSR safe by @Cbodfield in https://github.com/github/hotkey/pull/126

New Contributors

• @davidsneighbour made their first contribution in https://github.com/github/hotkey/pull/121
• @Cbodfield made their first contribution in https://github.com/github/hotkey/pull/126

Full Changelog: https://github.com/github/hotkey/compare/v3.1.0...v3.1.1

What's Changed

• Move eslint-import-resolver-typescript to dev dependencies by @iansan5653 in https://github.com/github/hotkey/pull/120

Full Changelog: https://github.com/github/hotkey/compare/v3.0.1...v3.1.0

Re-releasing v3.0.0 due to a bad workflow configuration.

Breaking changes

• When Shift is used to type an uppercase letter, Shift+ will now be included in the hotkey string (https://github.com/github/hotkey/pull/115). This means authors will need to update hotkey strings which contain capital letters to add Shift. For example, A becomes Shift+A, Mod+U because Mod+Shift+U.
• The behavior of Mod and Meta has been made more consistent: on MacOS, when these keys are used with Shift, the resulting key name is now normalized to uppercase (https://github.com/github/hotkey/pull/116). This allows using the same Mod shortcuts on Windows, Linux, and MacOS, but may require updating some hotkey strings to use uppercase letters. For example, Meta+Shift+a becomes Meta+Shift+A, and Mod+Shift+A will work as expected across all operating systems.

What's Changed

• Fix backtick mapping for macOS symbol layer by @JoyceZhu in https://github.com/github/hotkey/pull/113
• Don't use symbol plane unless Alt is pressed by @iansan5653 in https://github.com/github/hotkey/pull/114

New Contributors

• @JoyceZhu made their first contribution in https://github.com/github/hotkey/pull/113

Full Changelog: https://github.com/github/hotkey/compare/v2.3.0...v2.3.1

What's Changed

• Add support for Space and Plus by @iansan5653 in https://github.com/github/hotkey/pull/112

Full Changelog: https://github.com/github/hotkey/compare/v2.2.0...v2.3.0

What's Changed

• Add support for alt/option on Mac via symbol map by @iansan5653 in https://github.com/github/hotkey/pull/110

Full Changelog: https://github.com/github/hotkey/compare/v2.1.1...v2.2.0

What's Changed

• Make NormalizedHotkeyString extend NormalizedSequenceString by @iansan5653 in https://github.com/github/hotkey/pull/106

Full Changelog: https://github.com/github/hotkey/compare/v2.1.0...v2.1.1

New features

• Add a special Mod modifier that translates to either Meta on Mac or Control on other platforms by @theinterned in https://github.com/github/hotkey/pull/66
• Expose tools for building & normalizing hotkey & sequence strings by @iansan5653 in https://github.com/github/hotkey/pull/94

Demos / docs

• Fix website structure by @iansan5653 in https://github.com/github/hotkey/pull/96
• Improve mapper tool accessibility by @iansan5653 in https://github.com/github/hotkey/pull/90
• Add chord/sequence support to mapper tool by @iansan5653 in https://github.com/github/hotkey/pull/91

Other changes

• Add npm package provenance in release workflow by @iansan5653 in https://github.com/github/hotkey/pull/95

New Contributors

• @iansan5653 made their first contribution in https://github.com/github/hotkey/pull/90

Full Changelog: https://github.com/github/hotkey/compare/v2.0.1...v2.1.0

What's Changed

• Use chromium for karma tests by @theinterned in https://github.com/github/hotkey/pull/73
• Add a .devcontainer by @koddsson in https://github.com/github/hotkey/pull/76
• Add a release action by @koddsson in https://github.com/github/hotkey/pull/77
• Explain how to scope hotkeys in README by @3v0k4 in https://github.com/github/hotkey/pull/79
• Allow hotkeys when focusing on file input elements by @akenneth in https://github.com/github/hotkey/pull/80

New Contributors

• @3v0k4 made their first contribution in https://github.com/github/hotkey/pull/79
• @akenneth made their first contribution in https://github.com/github/hotkey/pull/80

Full Changelog: https://github.com/github/hotkey/compare/v2.0.0...v2.0.1

What's Changed

• Fix querySelector by quoting templated value by @keithamus in https://github.com/github/hotkey/pull/57
• Add tool to generate correct hotkey string for a given key combination by @theinterned in https://github.com/github/hotkey/pull/59
• Update hotkey README to document hotkey string format by @theinterned in https://github.com/github/hotkey/pull/62
• npm audit fixes by @theinterned in https://github.com/github/hotkey/pull/63
• BREAKING: fixes eventToHotkeyString returns doubled "modifier" when "key" is a modifier by @theinterned in https://github.com/github/hotkey/pull/64
• BREAKING: Support comma as a hotkey by @colinwm in https://github.com/github/hotkey/pull/71
• Update release.yml by @manuelpuyol in https://github.com/github/hotkey/pull/72

New Contributors

• @theinterned made their first contribution in https://github.com/github/hotkey/pull/59
• @colinwm made their first contribution in https://github.com/github/hotkey/pull/71
• @manuelpuyol made their first contribution in https://github.com/github/hotkey/pull/72

Full Changelog: https://github.com/github/hotkey/compare/v1.6.0...v2.0.0

What's Changed

• Fix querySelector by quoting templated value by @keithamus in https://github.com/github/hotkey/pull/57

Full Changelog: https://github.com/github/hotkey/compare/v1.6.0...v1.6.1

This release adds a hotkey-fire cancelable event which is dispatched before the hotkey is invoked (button clicks, field focussed, etc).

Before, the last registered element was always returned when multiple elements were registered with the same hotkey.

This PR changes this behavior for scoped hotkeys which were introduced in https://github.com/github/hotkey/pull/49.

When the same hotkey is registered to multiple scoped elements, we can trigger the specific element that matches the criteria.

This release adds support for scoped hotkeys when the data-hotkey-scope attribute is specified.

This fixes a regression in the eventToHotkeyString function in 1.4.3 which was caused by trying to normalise the event.key toUpperCase. The regression was because on macos the "Meta+Shift" plane is always lowercase, which is contrary to other operating systems. This is a regression because that was expected behavior as part of this package, and the fix in 1.4.3 broke this expectation while trying to fix another bug.

This change respects the event.key spacing, and elides the shift key only when the event.key matches case, returning Meta+Shift+p as a viable shortcut.

This release fixes a bug with how shortcut keys get composed. Now combos like Ctrl+Shift+` should work correctly.

• Ensure defaultPrevented events don't trigger hotkeys

• Convert to TypeScript/remove Flow type support.
• Package is now type module. UMD build is removed.

• Remove syntax transformations in module output #27