-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
index.ts
84 lines (73 loc) · 2.48 KB
/
index.ts
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
import type { MaybeComputedRef } from '@vueuse/shared'
import { useEventListener } from '../useEventListener'
import { defaultWindow } from '../_configurable'
export type KeyPredicate = (event: KeyboardEvent) => boolean
export type KeyFilter = null | undefined | string | string[] | KeyPredicate
export type KeyStrokeEventName = 'keydown' | 'keypress' | 'keyup'
export interface KeyStrokeOptions {
eventName?: KeyStrokeEventName
target?: MaybeComputedRef<EventTarget>
passive?: boolean
}
const createKeyPredicate = (keyFilter: KeyFilter): KeyPredicate => {
if (typeof keyFilter === 'function')
return keyFilter
else if (typeof keyFilter === 'string')
return (event: KeyboardEvent) => event.key === keyFilter
else if (Array.isArray(keyFilter))
return (event: KeyboardEvent) => keyFilter.includes(event.key)
else if (keyFilter)
return () => true
else
return () => false
}
/**
* Listen for keyboard keys being stroked.
*
* @see https://vueuse.org/onKeyStroke
* @param key
* @param handler
* @param options
*/
export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: KeyStrokeOptions = {}) {
const { target = defaultWindow, eventName = 'keydown', passive = false } = options
const predicate = createKeyPredicate(key)
const listener = (e: KeyboardEvent) => {
if (predicate(e))
handler(e)
}
return useEventListener(target, eventName, listener, passive)
}
/**
* Listen to the keydown event of the given key.
*
* @see https://vueuse.org/onKeyStroke
* @param key
* @param handler
* @param options
*/
export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
return onKeyStroke(key, handler, { ...options, eventName: 'keydown' })
}
/**
* Listen to the keypress event of the given key.
*
* @see https://vueuse.org/onKeyStroke
* @param key
* @param handler
* @param options
*/
export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
return onKeyStroke(key, handler, { ...options, eventName: 'keypress' })
}
/**
* Listen to the keyup event of the given key.
*
* @see https://vueuse.org/onKeyStroke
* @param key
* @param handler
* @param options
*/
export function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
return onKeyStroke(key, handler, { ...options, eventName: 'keyup' })
}