|
| 1 | +/** |
| 2 | + * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
| 3 | + * SPDX-License-Identifier: AGPL-3.0-or-later |
| 4 | + */ |
| 5 | + |
| 6 | +import { afterEach, describe, expect, it, vi } from 'vitest' |
| 7 | +import { useHotKey } from '../../../src/composables/useHotKey/index.ts' |
| 8 | + |
| 9 | +describe('useHotKey', () => { |
| 10 | + const mockCallback = vi.fn() |
| 11 | + |
| 12 | + function triggerKeyDown(eventPayload, target = document.body) { |
| 13 | + target.dispatchEvent(new KeyboardEvent('keydown', eventPayload)) |
| 14 | + } |
| 15 | + |
| 16 | + function triggerKeyUp(eventPayload, target = document.body) { |
| 17 | + target.dispatchEvent(new KeyboardEvent('keyup', eventPayload)) |
| 18 | + } |
| 19 | + |
| 20 | + afterEach(() => { |
| 21 | + mockCallback.mockReset() |
| 22 | + }) |
| 23 | + |
| 24 | + it('should register listener and invoke callback', () => { |
| 25 | + const stop = useHotKey(true, mockCallback) |
| 26 | + triggerKeyDown({ key: 'a', code: 'KeyA' }) |
| 27 | + stop() |
| 28 | + |
| 29 | + expect(mockCallback).toHaveBeenCalled() |
| 30 | + }) |
| 31 | + |
| 32 | + it('should not invoke callback, when on interactive elements', () => { |
| 33 | + const stop = useHotKey(true, mockCallback) |
| 34 | + const input = document.createElement('input') |
| 35 | + document.body.appendChild(input) |
| 36 | + triggerKeyDown({ key: 'a', code: 'KeyA' }, input) |
| 37 | + stop() |
| 38 | + |
| 39 | + expect(mockCallback).not.toHaveBeenCalled() |
| 40 | + }) |
| 41 | + |
| 42 | + describe('options', () => { |
| 43 | + it('should accept array of keys and invoke callback for all of them', () => { |
| 44 | + const stop = useHotKey(['a', 'b'], mockCallback) |
| 45 | + triggerKeyDown({ key: 'a', code: 'KeyA' }) |
| 46 | + triggerKeyDown({ key: 'b', code: 'KeyB' }) |
| 47 | + stop() |
| 48 | + |
| 49 | + expect(mockCallback).toHaveBeenCalledTimes(2) |
| 50 | + }) |
| 51 | + |
| 52 | + it('should accept filter function and invoke callback when passed', () => { |
| 53 | + const stop = useHotKey((event) => ['a', 'b'].includes(event.key), mockCallback) |
| 54 | + triggerKeyDown({ key: 'a', code: 'KeyA' }) |
| 55 | + triggerKeyDown({ key: 'b', code: 'KeyB' }) |
| 56 | + stop() |
| 57 | + |
| 58 | + expect(mockCallback).toHaveBeenCalledTimes(2) |
| 59 | + }) |
| 60 | + |
| 61 | + it('should register only keydown listener and invoke callback', () => { |
| 62 | + const stop = useHotKey('a', mockCallback) |
| 63 | + triggerKeyDown({ key: 'a', code: 'KeyA' }) |
| 64 | + triggerKeyUp({ key: 'a', code: 'KeyA' }) |
| 65 | + stop() |
| 66 | + |
| 67 | + expect(mockCallback).toHaveBeenCalledTimes(1) |
| 68 | + }) |
| 69 | + |
| 70 | + it('should register push listeners and invoke callback', () => { |
| 71 | + const stop = useHotKey('a', mockCallback, { push: true }) |
| 72 | + triggerKeyDown({ key: 'a', code: 'KeyA' }) |
| 73 | + triggerKeyUp({ key: 'a', code: 'KeyA' }) |
| 74 | + stop() |
| 75 | + |
| 76 | + expect(mockCallback).toHaveBeenCalledTimes(2) |
| 77 | + }) |
| 78 | + |
| 79 | + it('should register listener with Shift modifier and invoke callback', () => { |
| 80 | + const stop = useHotKey('a', mockCallback, { shift: true }) |
| 81 | + triggerKeyDown({ key: 'a', code: 'KeyA', shiftKey: false }) |
| 82 | + triggerKeyDown({ key: 'A', code: 'KeyA', shiftKey: true }) |
| 83 | + stop() |
| 84 | + |
| 85 | + expect(mockCallback).toHaveBeenCalledTimes(1) |
| 86 | + }) |
| 87 | + |
| 88 | + it('should register listener with Alt modifier and invoke callback', () => { |
| 89 | + const stop = useHotKey('a', mockCallback, { alt: true }) |
| 90 | + triggerKeyDown({ key: 'a', code: 'KeyA', altKey: false }) |
| 91 | + triggerKeyDown({ key: 'A', code: 'KeyA', altKey: true }) |
| 92 | + stop() |
| 93 | + |
| 94 | + expect(mockCallback).toHaveBeenCalledTimes(1) |
| 95 | + }) |
| 96 | + |
| 97 | + it('should register listener with Ctrl (Cmd on Mac) modifier and invoke callback', () => { |
| 98 | + const stop = useHotKey('a', mockCallback, { ctrl: true }) |
| 99 | + triggerKeyDown({ key: 'a', code: 'KeyA', ctrlKey: false, metaKey: false }) |
| 100 | + triggerKeyDown({ key: 'A', code: 'KeyA', ctrlKey: true, metaKey: true }) |
| 101 | + stop() |
| 102 | + |
| 103 | + expect(mockCallback).toHaveBeenCalledTimes(1) |
| 104 | + }) |
| 105 | + }) |
| 106 | + |
| 107 | + describe('validation', () => { |
| 108 | + it.each([ |
| 109 | + // Latin characters |
| 110 | + ['a', { key: 'a', code: 'KeyA' }, {}], |
| 111 | + ['a', { key: 'A', code: 'KeyA' }, {}], |
| 112 | + // Latin characters with different layout |
| 113 | + ['a', { key: 'a', code: 'KeyQ' }, {}], |
| 114 | + // Non-Latin characters |
| 115 | + ['a', { key: 'ф', code: 'KeyA' }, {}], |
| 116 | + ['a', { key: 'Ф', code: 'KeyA' }, {}], |
| 117 | + ['a', { key: 'ש', code: 'KeyA' }, {}], |
| 118 | + // Digits |
| 119 | + ['1', { key: '1', code: 'Digit1' }, {}], |
| 120 | + ['2', { key: '2', code: 'Numpad2' }, {}], |
| 121 | + // Non-Arabic numeral digits |
| 122 | + ['1', { key: '일', code: 'Digit1' }, {}], |
| 123 | + ['2', { key: '٢', code: 'Numpad2' }, {}], |
| 124 | + // With caseSensitive option |
| 125 | + ['a', { key: 'a', code: 'KeyA' }, { caseSensitive: true }], |
| 126 | + ['a', { key: 'ф', code: 'KeyA' }, { caseSensitive: true }], |
| 127 | + ['a', { key: 'ש', code: 'KeyA' }, { caseSensitive: true }], |
| 128 | + ])('should pass validation for %s => pressed %o', (key, eventKey, options) => { |
| 129 | + const stop = useHotKey(key, mockCallback, options) |
| 130 | + triggerKeyDown(eventKey) |
| 131 | + stop() |
| 132 | + |
| 133 | + expect(mockCallback).toHaveBeenCalled() |
| 134 | + }) |
| 135 | + |
| 136 | + it.each([ |
| 137 | + // Wrong key |
| 138 | + ['a', { key: 'B', code: 'KeyB' }, {}], |
| 139 | + ['a', { key: 'b', code: 'KeyB' }, { caseSensitive: true }], |
| 140 | + // Wrong case |
| 141 | + ['a', { key: 'A', code: 'KeyA' }, { caseSensitive: true }], |
| 142 | + ['a', { key: 'Ф', code: 'KeyA' }, { caseSensitive: true }], |
| 143 | + ])('should not pass validation for %s => pressed %o', (key, eventKey, options) => { |
| 144 | + const stop = useHotKey(key, mockCallback, options) |
| 145 | + triggerKeyDown(eventKey) |
| 146 | + stop() |
| 147 | + |
| 148 | + expect(mockCallback).not.toHaveBeenCalled() |
| 149 | + }) |
| 150 | + }) |
| 151 | +}) |
0 commit comments