/
index.ts
149 lines (133 loc) · 3.73 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
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
import { computed, ComputedRef, reactive, ref, unref } from 'vue-demi'
import { MaybeRef, noop } from '@vueuse/shared'
import { useEventListener } from '../useEventListener'
import { defaultWindow } from '../_configurable'
export interface UseMagicKeysOptions<Reactive extends Boolean> {
/**
* Returns a reactive object instead of an object of refs
*
* @default false
*/
reactive?: Reactive
/**
* Target for listening events
*
* @default window
*/
target?: MaybeRef<EventTarget>
/**
* Alias map for keys, all the keys should be lowercase
* { target: keycode }
*
* @example { ctrl: "control" }
* @default <predefined-map>
*/
aliasMap?: Record<string, string>
/**
* Register passive listener
*
* @default true
*/
passive?: boolean
/**
* Custom event handler for keydown/keyup event.
* Useful when you want to apply custom logic.
*
* When using `e.preventDefault()`, you will need to pass `passive: false` to useMagicKeys().
*/
onEventFired?: (e: KeyboardEvent) => void | boolean
}
export const DefaultMagicKeysAliasMap: Readonly<Record<string, string>> = {
ctrl: 'control',
option: 'meta',
}
export interface MagicKeysInternal {
/**
* A Set of currently pressed keys,
* Stores raw keyCodes.
*
* @link https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode
*/
current: Set<string>
}
export type MagicKeys<Reactive extends Boolean> =
Readonly<
Omit<Reactive extends true
? Record<string, boolean>
: Record<string, ComputedRef<boolean>>,
keyof MagicKeysInternal>
& MagicKeysInternal
>
/**
* Reactive keys pressed state, with magical keys combination support.
*
* @link https://vueuse.org/useMagicKeys
*/
export function useMagicKeys(options?: UseMagicKeysOptions<false>): MagicKeys<false>
export function useMagicKeys(options: UseMagicKeysOptions<true>): MagicKeys<true>
export function useMagicKeys(options: UseMagicKeysOptions<boolean> = {}): any {
const {
reactive: useReactive = false,
target = defaultWindow,
aliasMap = DefaultMagicKeysAliasMap,
passive = true,
onEventFired = noop,
} = options
const current = reactive(new Set<string>())
const obj = { toJSON() { return {} }, current }
const refs: Record<string, any> = useReactive ? reactive(obj) : obj
function updateRefs(e: KeyboardEvent, value: boolean) {
const key = e.key.toLowerCase()
const code = e.code.toLowerCase()
const values = [code, key]
// current set
if (value)
current.add(e.code)
else
current.delete(e.code)
for (const key of values) {
if (key in refs) {
if (useReactive)
refs[key] = value
else
refs[key].value = value
}
}
}
if (target) {
useEventListener(target, 'keydown', (e: KeyboardEvent) => {
updateRefs(e, true)
return onEventFired(e)
}, { passive })
useEventListener(target, 'keyup', (e: KeyboardEvent) => {
updateRefs(e, false)
return onEventFired(e)
}, { passive })
}
const proxy = new Proxy(
refs,
{
get(target, prop, rec) {
if (typeof prop !== 'string')
return Reflect.get(target, prop, rec)
prop = prop.toLowerCase()
// alias
if (prop in aliasMap)
prop = aliasMap[prop]
// create new tracking
if (!(prop in refs)) {
if (/[+_-]/.test(prop)) {
const keys = prop.split(/[+_-]/g).map(i => i.trim())
refs[prop] = computed(() => keys.every(key => unref(proxy[key])))
}
else {
refs[prop] = ref(false)
}
}
const r = Reflect.get(target, prop, rec)
return useReactive ? unref(r) : r
},
},
)
return proxy as any
}