Skip to content

fixes eventToHotkeyString returns doubled "modifier" when "key" is a modifier#64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theinterned merged 3 commits into from
Dec 17, 2021
Merged

fixes eventToHotkeyString returns doubled "modifier" when "key" is a modifier #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22ac830
avoid rendering double modifier key in hotkey string
theinterned Dec 16, 2021
238290a
avoid rendering double modifier key in hotkey string
theinterned Dec 16, 2021
514fce5
simplification:
theinterned Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions src/hotkey.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,25 @@
//
// Returns key character String or null.
export default function hotkey(event: KeyboardEvent): string {
const elideShift = event.code.startsWith('Key') && event.shiftKey && event.key.toUpperCase() === event.key
return `${event.ctrlKey ? 'Control+' : ''}${event.altKey ? 'Alt+' : ''}${event.metaKey ? 'Meta+' : ''}${
event.shiftKey && !elideShift ? 'Shift+' : ''
}${event.key}`
const {ctrlKey, altKey, metaKey, key} = event
const hotkeyString: string[] = []
const modifiers: boolean[] = [ctrlKey, altKey, metaKey, showShift(event)]

for (const [i, mod] of modifiers.entries()) {
if (mod) hotkeyString.push(modifierKeyNames[i])
}

if (!modifierKeyNames.includes(key)) {
hotkeyString.push(key)
}

return hotkeyString.join('+')
}

const modifierKeyNames: string[] = [`Control`, 'Alt', 'Meta', 'Shift']

// We don't want to show `Shift` when `event.key` is capital
function showShift(event: KeyboardEvent): boolean {
const {shiftKey, code, key} = event
return shiftKey && !(code.startsWith('Key') && key.toUpperCase() === key)
}
4 changes: 3 additions & 1 deletion test/test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,7 +218,9 @@ describe('hotkey', function () {
['Control+Shift+`', {ctrlKey: true, shiftKey: true, key: '`'}],
['c', {key: 'c', code: 'KeyC'}],
['S', {key: 'S', shiftKey: true, code: 'KeyS'}],
['!', {key: '!', shiftKey: true, code: 'KeyS'}]
['!', {key: '!', shiftKey: true, code: 'KeyS'}],
['Control+Shift', {ctrlKey: true, shiftKey: true, key: 'Shift'}],
['Control+Shift', {ctrlKey: true, shiftKey: true, key: 'Control'}]
Comment on lines +222 to +223

@theinternedtheinternedDec 16, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were initially failing with:

FAILED TESTS:
hotkey
eventToHotkeyString
✖ {"ctrlKey":true,"shiftKey":true,"key":"Shift"} => Control+Shift
Chrome Headless 96.0.4664.110 (Mac OS 10.15.7)
Error: Uncaught AssertionError: expected 'Control+Shift+Shift' to equal 'Control+Shift' (node_modules/chai/chai.js:250)
at Context.<anonymous> (test/test.js:232:23)
✖ {"ctrlKey":true,"shiftKey":true,"key":"Control"} => Control+Shift
Chrome Headless 96.0.4664.110 (Mac OS 10.15.7)
Error: Uncaught AssertionError: expected 'Control+Shift+Control' to equal 'Control+Shift' (node_modules/chai/chai.js:250)
at Context.<anonymous> (test/test.js:232:23)

]
for (const [expected, keyEvent] of tests) {
it(`${JSON.stringify(keyEvent)} => ${expected}`, function (done) {
Expand Down