fix(useMagicKeys): fix default alias map, close vitest-dev#437

chaii3 · Apr 8, 2021 · 44fa25b · 44fa25b
1 parent ae56165
commit 44fa25b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 15 deletions.
diff --git a/packages/core/useMagicKeys/aliasMap.ts b/packages/core/useMagicKeys/aliasMap.ts
@@ -0,0 +1,10 @@
+export const DefaultMagicKeysAliasMap: Readonly<Record<string, string>> = {
+  ctrl: 'control',
+  command: 'meta',
+  cmd: 'meta',
+  option: 'alt',
+  up: 'arrowup',
+  down: 'arrowdown',
+  left: 'arrowleft',
+  right: 'arrowright',
+}
diff --git a/packages/core/useMagicKeys/index.md b/packages/core/useMagicKeys/index.md
@@ -84,23 +84,21 @@ whenever(
 )
 ```
 
-### Key Alias
+### Key Aliasing
 
 ```ts
 import { useMagicKeys, whenever } from '@vueuse/core'
 
 const { shift_cool } = useMagicKeys({
-  alias: {
+  aliasMap: {
     cool: 'space'
   }
 })
 
-whenever(cool, () => console.log('Shift + Space have been pressed'))
+whenever(shift_cool, () => console.log('Shift + Space have been pressed'))
 ```
 
-By default, we have some preconfigured alias for common practices. 
-
-For example: `ctrl` -> `control` and `option` -> `meta`.
+By default, we have some [preconfigured alias for common practices](https://github.com/vueuse/vueuse/blob/main/packages/core/useMagicKeys/aliasMap.ts).
 
 ### Custom Event Handler
 

diff --git a/packages/core/useMagicKeys/index.ts b/packages/core/useMagicKeys/index.ts
@@ -2,6 +2,7 @@ import { computed, ComputedRef, reactive, ref, unref } from 'vue-demi'
 import { MaybeRef, noop } from '@vueuse/shared'
 import { useEventListener } from '../useEventListener'
 import { defaultWindow } from '../_configurable'
+import { DefaultMagicKeysAliasMap } from './aliasMap'
 
 export interface UseMagicKeysOptions<Reactive extends Boolean> {
   /**
@@ -43,15 +44,6 @@ export interface UseMagicKeysOptions<Reactive extends Boolean> {
   onEventFired?: (e: KeyboardEvent) => void | boolean
 }
 
-export const DefaultMagicKeysAliasMap: Readonly<Record<string, string>> = {
-  ctrl: 'control',
-  option: 'meta',
-  up: 'arrowup',
-  down: 'arrowdown',
-  left: 'arrowleft',
-  right: 'arrowright',
-}
-
 export interface MagicKeysInternal {
   /**
    * A Set of currently pressed keys,
@@ -151,3 +143,5 @@ export function useMagicKeys(options: UseMagicKeysOptions<boolean> = {}): any {
 
   return proxy as any
 }
+
+export { DefaultMagicKeysAliasMap } from './aliasMap'