Skip to content

Commit 44fa25b

Browse files
committed
fix(useMagicKeys): fix default alias map, close vitest-dev#437
1 parent ae56165 commit 44fa25b

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export const DefaultMagicKeysAliasMap: Readonly<Record<string, string>> = {
2+
ctrl: 'control',
3+
command: 'meta',
4+
cmd: 'meta',
5+
option: 'alt',
6+
up: 'arrowup',
7+
down: 'arrowdown',
8+
left: 'arrowleft',
9+
right: 'arrowright',
10+
}

packages/core/useMagicKeys/index.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -84,23 +84,21 @@ whenever(
8484
)
8585
```
8686

87-
### Key Alias
87+
### Key Aliasing
8888

8989
```ts
9090
import { useMagicKeys, whenever } from '@vueuse/core'
9191

9292
const { shift_cool } = useMagicKeys({
93-
alias: {
93+
aliasMap: {
9494
cool: 'space'
9595
}
9696
})
9797

98-
whenever(cool, () => console.log('Shift + Space have been pressed'))
98+
whenever(shift_cool, () => console.log('Shift + Space have been pressed'))
9999
```
100100

101-
By default, we have some preconfigured alias for common practices.
102-
103-
For example: `ctrl` -> `control` and `option` -> `meta`.
101+
By default, we have some [preconfigured alias for common practices](https://github.com/vueuse/vueuse/blob/main/packages/core/useMagicKeys/aliasMap.ts).
104102

105103
### Custom Event Handler
106104

packages/core/useMagicKeys/index.ts

+3-9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { computed, ComputedRef, reactive, ref, unref } from 'vue-demi'
22
import { MaybeRef, noop } from '@vueuse/shared'
33
import { useEventListener } from '../useEventListener'
44
import { defaultWindow } from '../_configurable'
5+
import { DefaultMagicKeysAliasMap } from './aliasMap'
56

67
export interface UseMagicKeysOptions<Reactive extends Boolean> {
78
/**
@@ -43,15 +44,6 @@ export interface UseMagicKeysOptions<Reactive extends Boolean> {
4344
onEventFired?: (e: KeyboardEvent) => void | boolean
4445
}
4546

46-
export const DefaultMagicKeysAliasMap: Readonly<Record<string, string>> = {
47-
ctrl: 'control',
48-
option: 'meta',
49-
up: 'arrowup',
50-
down: 'arrowdown',
51-
left: 'arrowleft',
52-
right: 'arrowright',
53-
}
54-
5547
export interface MagicKeysInternal {
5648
/**
5749
* A Set of currently pressed keys,
@@ -151,3 +143,5 @@ export function useMagicKeys(options: UseMagicKeysOptions<boolean> = {}): any {
151143

152144
return proxy as any
153145
}
146+
147+
export { DefaultMagicKeysAliasMap } from './aliasMap'

0 commit comments

Comments
 (0)