-
Notifications
You must be signed in to change notification settings - Fork 97
/
test.js
533 lines (446 loc) · 21 KB
/
test.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
import {install, uninstall, eventToHotkeyString} from '../dist/index.js'
let elementsActivated = []
function clickHandler(event) {
elementsActivated.push(event.target.id)
}
const setHTML = html => {
document.body.innerHTML = html
for (const element of document.querySelectorAll('[data-hotkey]')) {
install(element)
}
}
async function wait(ms) {
return new Promise(function (resolve) {
return setTimeout(resolve, ms)
})
}
// Simulate entering a series of keys with `delay` milliseconds in between
// keystrokes.
async function keySequence(keys, delay = 10) {
for (const nextKey of keys.split(' ')) {
document.dispatchEvent(new KeyboardEvent('keydown', {key: nextKey}))
await wait(delay)
}
}
describe('hotkey', function () {
beforeEach(function () {
document.addEventListener('click', clickHandler)
})
afterEach(function () {
document.removeEventListener('click', clickHandler)
for (const element of document.querySelectorAll('[data-hotkey]')) {
uninstall(element)
}
uninstall(document.getElementById('button-without-a-attribute'))
document.body.innerHTML = ''
elementsActivated = []
})
describe('single key support', function () {
it('triggers buttons that have a `data-hotkey` attribute', function () {
setHTML('<button id="button1" data-hotkey="b">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.include(elementsActivated, 'button1')
})
it('triggers buttons that get hotkey passed in as second argument', function () {
setHTML('<button id="button-without-a-attribute">Button 3</button>')
install(document.getElementById('button-without-a-attribute'), 'Control+c')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'c', ctrlKey: true}))
assert.include(elementsActivated, 'button-without-a-attribute')
})
it("doesn't trigger buttons that don't have a `data-hotkey` attribute", function () {
setHTML('<button id="button2">Button 2</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.notInclude(elementsActivated, 'button2')
})
it("doesn't respond to the hotkey in a button's overridden `data-hotkey` attribute", function () {
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b', ctrlKey: true}))
assert.notInclude(elementsActivated, 'button3')
})
it("doesn't trigger when user is focused on a input or textfield", function () {
setHTML(`
<button id="button1" data-hotkey="b">Button 1</button>
<input id="textfield" />`)
document.getElementById('textfield').dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, key: 'b'}))
assert.deepEqual(elementsActivated, [])
})
it('triggers when user is focused on a file input', function () {
setHTML(`
<button id="button1" data-hotkey="b">Button 1</button>
<input id="filefield" type="file" />`)
document.getElementById('filefield').dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, key: 'b'}))
assert.deepEqual(elementsActivated, ['button1'])
})
it('handles multiple keys in a hotkey combination', function () {
setHTML('<button id="button3" data-hotkey="Control+c">Button 3</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'c', ctrlKey: true}))
assert.include(elementsActivated, 'button3')
})
it("doesn't trigger elements whose hotkey has been removed", function () {
setHTML('<button id="button1" data-hotkey="b">Button 1</button>')
uninstall(document.querySelector('#button1'))
document.dispatchEvent(new KeyboardEvent('keydown', {code: 'KeyB', key: 'b'}))
assert.deepEqual(elementsActivated, [])
})
it('triggers elements with capitalised key', function () {
setHTML('<button id="button1" data-hotkey="Shift+B">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {shiftKey: true, code: 'KeyB', key: 'B'}))
assert.include(elementsActivated, 'button1')
})
it('dispatches an event on the element once fired', function () {
setHTML('<button id="button1" data-hotkey="Shift+B">Button 1</button>')
let fired = false
document.querySelector('#button1').addEventListener('hotkey-fire', event => {
fired = true
assert.deepEqual(event.detail.path, ['Shift+B'])
assert.equal(event.cancelable, true)
})
document.dispatchEvent(new KeyboardEvent('keydown', {shiftKey: true, code: 'KeyB', key: 'B'}))
assert.ok(fired, 'button1 did not receive a hotkey-fire event')
})
it('wont trigger action if the hotkey-fire event is cancelled', function () {
setHTML('<button id="button1" data-hotkey="Shift+B">Button 1</button>')
document.querySelector('#button1').addEventListener('hotkey-fire', event => event.preventDefault())
document.dispatchEvent(new KeyboardEvent('keydown', {shiftKey: true, code: 'KeyB', key: 'B'}))
assert.notInclude(elementsActivated, 'button1')
})
it('supports comma as a hotkey', function () {
setHTML('<button id="button1" data-hotkey=",">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: ','}))
assert.include(elementsActivated, 'button1')
})
it('supports comma + modifier as a hotkey', function () {
setHTML('<button id="button1" data-hotkey="Meta+,">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {metaKey: true, key: ','}))
assert.include(elementsActivated, 'button1')
})
it('multiple comma aliases', function () {
setHTML('<button id="button1" data-hotkey="x,,,y">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: ','}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'x'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'y'}))
assert.equal(elementsActivated.length, 3)
})
it('complex comma parsing', async function () {
setHTML('<button id="button1" data-hotkey=", a b,c">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'c'}))
await keySequence(', a b')
assert.equal(elementsActivated.length, 2)
})
it('complex comma parsing II', async function () {
setHTML('<button id="button1" data-hotkey="a , b,c,,">Button 1</button>')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'c'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: ','}))
await keySequence('a , b')
assert.equal(elementsActivated.length, 3)
})
it('complex comma parsing II', async function () {
setHTML('<button id="button1" data-hotkey=", , , ,">Button 1</button>')
await keySequence(', , , ,')
assert.include(elementsActivated, 'button1')
})
it('complex comma parsing II', async function () {
setHTML('<button id="button1" data-hotkey="Control+x, , ,">Button 1</button>')
await keySequence(', ,')
document.dispatchEvent(new KeyboardEvent('keydown', {ctrlKey: true, key: 'x'}))
assert.equal(elementsActivated.length, 2)
})
})
describe('data-hotkey-scope', function () {
it('allows hotkey action from form field', function () {
setHTML(`
<button id="button1" data-hotkey-scope="textfield" data-hotkey="Meta+b">Button 1</button>
<input id="textfield" />`)
document
.getElementById('textfield')
.dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, metaKey: true, cancelable: true, key: 'b'}))
assert.include(elementsActivated, 'button1')
})
it('does nothing if `data-hotkey-scope` is set to non-form field', function () {
setHTML(`
<button id="button1" data-hotkey-scope="button2" data-hotkey="Meta+b">Button 1</button>
<button id="button2" />`)
document
.getElementById('button2')
.dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, metaKey: true, cancelable: true, key: 'b'}))
assert.deepEqual(elementsActivated, [])
})
it('does nothing if `data-hotkey-scope` does not exist', function () {
setHTML(`
<button id="button1" data-hotkey-scope="bad-id" data-hotkey="b">Button 1</button>
<input id="textfield" />`)
document
.getElementById('textfield')
.dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, cancelable: true, key: 'b'}))
assert.deepEqual(elementsActivated, [])
})
it('identifies and fires correct element for duplicated hotkeys', function () {
setHTML(`
<button id="button1" data-hotkey-scope="textfield1" data-hotkey="Meta+b">Button 1</button>
<input id="textfield1" />
<button id="button2" data-hotkey-scope="textfield2" data-hotkey="Meta+b">Button 2</button>
<input id="textfield2" />
<button id="button3" data-hotkey="Meta+b">Button 2</button>
`)
const keyboardEventArgs = {bubbles: true, metaKey: true, cancelable: true, key: 'b'}
// Scoped hotkeys
document.getElementById('textfield1').dispatchEvent(new KeyboardEvent('keydown', keyboardEventArgs))
assert.include(elementsActivated, 'button1')
document.getElementById('textfield2').dispatchEvent(new KeyboardEvent('keydown', keyboardEventArgs))
assert.include(elementsActivated, 'button2')
// Non-scoped hotkey
document.dispatchEvent(new KeyboardEvent('keydown', keyboardEventArgs))
assert.include(elementsActivated, 'button3')
})
it('dispatches an event on the element once fired', function () {
setHTML(`
<button id="button1" data-hotkey-scope="textfield1" data-hotkey="Meta+b">Button 1</button>
<input id="textfield1" />
<button id="button2" data-hotkey-scope="textfield2" data-hotkey="Meta+b">Button 2</button>
<input id="textfield2" />
<button id="button3" data-hotkey="Meta+b">Button 2</button>
`)
let fired = false
document.querySelector('#button1').addEventListener('hotkey-fire', event => {
fired = true
assert.deepEqual(event.detail.path, ['Meta+b'])
assert.equal(event.cancelable, true)
})
document
.getElementById('textfield1')
.dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, metaKey: true, cancelable: true, key: 'b'}))
assert.ok(fired, 'button1 did not receive a hotkey-fire event')
})
it('wont trigger action if the hotkey-fire event is cancelled', function () {
setHTML(`
<button id="button1" data-hotkey-scope="textfield1" data-hotkey="Meta+b">Button 1</button>
<input id="textfield1" />
<button id="button2" data-hotkey-scope="textfield2" data-hotkey="Meta+b">Button 2</button>
<input id="textfield2" />
<button id="button3" data-hotkey="Meta+b">Button 2</button>
`)
document.querySelector('#button1').addEventListener('hotkey-fire', event => event.preventDefault())
document
.getElementById('textfield1')
.dispatchEvent(new KeyboardEvent('keydown', {bubbles: true, metaKey: true, cancelable: true, key: 'b'}))
assert.notInclude(elementsActivated, 'button1')
})
})
describe('eventToHotkeyString', function () {
const tests = [
['Control+Shift+J', {ctrlKey: true, shiftKey: true, code: 'KeyJ', key: 'J'}],
['Control+Shift+j', {ctrlKey: true, shiftKey: true, code: 'KeyJ', key: 'j'}],
['Control+j', {ctrlKey: true, code: 'KeyJ', key: 'j'}],
['Meta+Shift+p', {key: 'p', metaKey: true, shiftKey: true, code: 'KeyP'}],
['Meta+Shift+8', {key: '8', metaKey: true, shiftKey: true, code: 'Digit8'}],
['Control+Shift+7', {key: '7', ctrlKey: true, shiftKey: true, code: 'Digit7'}],
['Shift+J', {shiftKey: true, code: 'KeyJ', key: 'J'}],
['/', {key: '/', code: ''}],
['1', {key: '1', code: 'Digit1'}],
['Control+Shift+`', {ctrlKey: true, shiftKey: true, key: '`'}],
['c', {key: 'c', code: 'KeyC'}],
['Shift+S', {key: 'S', shiftKey: true, code: 'KeyS'}],
['Shift+!', {key: '!', shiftKey: true, code: 'Digit1'}],
['Control+Shift', {ctrlKey: true, shiftKey: true, key: 'Shift'}],
['Control+Shift', {ctrlKey: true, shiftKey: true, key: 'Control'}],
['Alt+s', {altKey: true, key: 's'}],
['Alt+s', {altKey: true, key: 'ß'}, 'mac'],
['Alt+Shift+S', {altKey: true, shiftKey: true, key: 'S'}],
['Alt+Shift+S', {altKey: true, shiftKey: true, key: 'Í'}, 'mac'],
['Alt+ArrowLeft', {altKey: true, key: 'ArrowLeft'}],
['Alt+ArrowLeft', {altKey: true, key: 'ArrowLeft'}, 'mac'],
['Alt+Shift+ArrowLeft', {altKey: true, shiftKey: true, key: 'ArrowLeft'}],
['Alt+Shift+ArrowLeft', {altKey: true, shiftKey: true, key: 'ArrowLeft'}, 'mac'],
['Control+Space', {ctrlKey: true, key: ' '}],
['Shift+Plus', {shiftKey: true, key: '+'}]
]
for (const [expected, keyEvent, platform = 'win / linux'] of tests) {
it(`${JSON.stringify(keyEvent)} => ${expected}`, function (done) {
document.body.addEventListener('keydown', function handler(event) {
document.body.removeEventListener('keydown', handler)
assert.equal(eventToHotkeyString(event, platform), expected)
done()
})
document.body.dispatchEvent(new KeyboardEvent('keydown', keyEvent))
})
}
})
describe('hotkey sequence support', function () {
it('supports sequences of 2 keys', async function () {
setHTML('<a id="link2" href="#" data-hotkey="b c"></a>')
await keySequence('b c')
assert.deepEqual(elementsActivated, ['link2'])
})
it('finds the longest sequence of keys which maps to something', async function () {
setHTML('<a id="link2" href="#" data-hotkey="b c"></a>')
await keySequence('z b c')
assert.deepEqual(elementsActivated, ['link2'])
})
it('supports sequences of 3 keys', async function () {
setHTML('<a id="link3" href="#" data-hotkey="d e f"></a>')
await keySequence('d e f')
assert.deepEqual(elementsActivated, ['link3'])
})
it('only exact hotkey sequence matches', async function () {
setHTML('<a id="exact" href="#" data-hotkey="j k"></a>')
await keySequence('j z k')
assert.deepEqual(elementsActivated, [])
})
it('dispatches an event on the element once fired', async function () {
setHTML('<a id="link3" href="#" data-hotkey="d e f"></a>')
let fired = false
document.querySelector('#link3').addEventListener('hotkey-fire', event => {
fired = true
assert.deepEqual(event.detail.path, ['d', 'e', 'f'])
assert.equal(event.cancelable, true)
})
await keySequence('d e f')
assert.ok(fired, 'link3 did not receive a hotkey-fire event')
})
it('supports sequences containing commas', async function () {
setHTML('<a id="link2" href="#" data-hotkey="b , c"></a>')
await keySequence('b , c')
assert.deepEqual(elementsActivated, ['link2'])
})
})
describe('misc', function () {
it('sequences time out after 1500 ms', async function () {
setHTML(`
<a href="#" id="create1" data-hotkey="h i"></a>
<a href="#" id="create2" data-hotkey="i"></a>
`)
keySequence('h')
await wait(1550)
keySequence('i')
assert.deepEqual(elementsActivated, ['create2'])
})
it('multiple hotkeys for the same element', async function () {
setHTML('<a href="#" id="multiple" data-hotkey="l,m n"></a>')
await keySequence('l')
assert.deepEqual(elementsActivated, ['multiple'])
await keySequence('m n')
assert.deepEqual(elementsActivated, ['multiple', 'multiple'])
})
it('with duplicate hotkeys, last element registered wins', async function () {
setHTML(`
<a href="#" id="duplicate1" data-hotkey="c"></a>
<a href="#" id="duplicate2" data-hotkey="c"></a>
`)
await keySequence('c')
assert.deepEqual(elementsActivated, ['duplicate2'])
})
it('works with macos meta+shift plane', async () => {
setHTML(`<a href="#" id="metashiftplane" data-hotkey="Meta+Shift+p"></a>`)
document.dispatchEvent(new KeyboardEvent('keydown', {metaKey: true, shiftKey: true, key: 'p'}))
await wait(10)
assert.deepEqual(elementsActivated, ['metashiftplane'])
})
})
describe('elements', function () {
it('can focus form elements that declare data-hotkey for focus', async () => {
let didFocus = false
setHTML('<input data-hotkey="a b">')
document.querySelector('input').focus = function () {
didFocus = true
}
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.isTrue(didFocus)
assert.deepEqual(elementsActivated, [])
})
it('will activate checkbox input elements that have a hotkey attribute', async () => {
setHTML('<input type="checkbox" id="checkbox" data-hotkey="a">')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
assert.deepEqual(elementsActivated, ['checkbox'])
})
it('will activate radio button input elements that have a hotkey attribute', async () => {
setHTML('<input type="radio" id="radio" data-hotkey="a">')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
assert.deepEqual(elementsActivated, ['radio'])
})
it('can click a[href] elements that declare data-hotkey for activation', async () => {
setHTML('<a id="link" href="#" data-hotkey="a b">')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.deepEqual(elementsActivated, ['link'])
})
it('can click button elements that declare data-hotkey for activation', async () => {
setHTML('<button id="button" data-hotkey="a b">')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.deepEqual(elementsActivated, ['button'])
})
it('can click details summary elements that declare data-hotkey for activation', async () => {
setHTML('<summary id="summary" data-hotkey="a b">')
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'a'}))
document.dispatchEvent(new KeyboardEvent('keydown', {key: 'b'}))
assert.deepEqual(elementsActivated, ['summary'])
})
})
})
describe('keydown listener', function () {
let registeredAddEventListeners = []
let registeredRemoveEventListeners = []
const originalAddEventListenerFunction = document.addEventListener
const originalRemoveEventListenerFunction = document.removeEventListener
beforeEach(function () {
function addEventListenerWrapper(eventName, callback) {
registeredAddEventListeners.push(eventName)
originalAddEventListenerFunction(eventName, callback)
}
document.addEventListener = addEventListenerWrapper
function removeEventListenerWrapper(eventName, callback) {
registeredRemoveEventListeners.push(eventName)
originalRemoveEventListenerFunction(eventName, callback)
}
document.removeEventListener = removeEventListenerWrapper
})
afterEach(function () {
document.addEventListener = originalAddEventListenerFunction
document.removeEventListener = originalRemoveEventListenerFunction
for (const el of document.querySelectorAll('[data-hotkey]')) {
uninstall(el)
}
registeredAddEventListeners = []
registeredRemoveEventListeners = []
})
it('adds a keydown listener when the first install is called', function () {
document.body.innerHTML = `
<button id="button1" data-hotkey="a">Button 1</button>
<button id="button2" data-hotkey="b">Button 2</button>
`
for (const el of document.querySelectorAll('[data-hotkey]')) {
install(el)
}
assert.deepEqual(registeredAddEventListeners, ['keydown'])
assert.deepEqual(registeredRemoveEventListeners, [])
})
it('only one keydown listener is installed', function () {
document.body.innerHTML = `
<button id="button1" data-hotkey="a">Button 1</button>
<button id="button2" data-hotkey="b">Button 2</button>
`
for (const el of document.querySelectorAll('[data-hotkey]')) {
install(el)
}
assert.deepEqual(registeredAddEventListeners, ['keydown'])
assert.deepEqual(registeredRemoveEventListeners, [])
})
it('uninstalling the last hotkey removes the keydown handler', function () {
document.body.innerHTML = `
<button id="button1" data-hotkey="a">Button 1</button>
<button id="button2" data-hotkey="b">Button 2</button>
`
const button1 = document.querySelector('#button1')
const button2 = document.querySelector('#button2')
install(button1)
install(button2)
assert.deepEqual(registeredAddEventListeners, ['keydown'])
assert.deepEqual(registeredRemoveEventListeners, [])
uninstall(button1)
assert.deepEqual(registeredAddEventListeners, ['keydown'])
assert.deepEqual(registeredRemoveEventListeners, [])
uninstall(button2)
assert.deepEqual(registeredAddEventListeners, ['keydown'])
assert.deepEqual(registeredRemoveEventListeners, ['keydown'])
})
})