react-hotkeys-hook 4.0.0-5 → 4.0.0-7

package/dist/isHotkeyPressed.d.ts

@@ -0,0 +1,3 @@
+export declare function isHotkeyPressed(key: string | string[], splitKey?: string): boolean;
+export declare function pushToCurrentlyPressedKeys(key: string | string[]): void;
+export declare function removeFromCurrentlyPressedKeys(key: string | string[]): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hotkeys-hook",
-  "version": "4.0.0-5",
+  "version": "4.0.0-7",
   "repository": "https://JohannesKlauss@github.com/JohannesKlauss/react-keymap-hook.git",
   "homepage": "https://johannesklauss.github.io/react-hotkeys-hook/",
   "author": "Johannes Klauss",

package/src/HotkeysProvider.tsx

@@ -4,19 +4,19 @@ import BoundHotkeysProxyProviderProvider from './BoundHotkeysProxyProvider'
 
 export type HotkeysContextType = {
   hotkeys: ReadonlyArray<Hotkey>
-  activeScopes: string[]
+  enabledScopes: string[]
   toggleScope: (scope: string) => void
-  activateScope: (scope: string) => void
-  deactivateScope: (scope: string) => void
+  enableScope: (scope: string) => void
+  disableScope: (scope: string) => void
 }
 
 // The context is only needed for special features like global scoping, so we use a graceful default fallback
 const HotkeysContext = createContext<HotkeysContextType>({
   hotkeys: [],
-  activeScopes: [], // This array has to be empty instead of containing '*' as default, to check if the provider is set or not
+  enabledScopes: [], // This array has to be empty instead of containing '*' as default, to check if the provider is set or not
   toggleScope: () => {},
-  activateScope: () => {},
-  deactivateScope: () => {},
+  enableScope: () => {},
+  disableScope: () => {},
 })
 
 export const useHotkeysContext = () => {
@@ -34,7 +34,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
 
   const isAllActive = useMemo(() => internalActiveScopes.includes('*'), [internalActiveScopes])
 
-  const activateScope = (scope: string) => {
+  const enableScope = (scope: string) => {
     if (isAllActive) {
       setInternalActiveScopes([scope])
     } else {
@@ -42,7 +42,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
     }
   }
 
-  const deactivateScope = (scope: string) => {
+  const disableScope = (scope: string) => {
     const scopes = internalActiveScopes.filter(s => s !== scope)
 
     if (scopes.length === 0) {
@@ -54,9 +54,9 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
 
   const toggleScope = (scope: string) => {
     if (internalActiveScopes.includes(scope)) {
-      deactivateScope(scope)
+      disableScope(scope)
     } else {
-      activateScope(scope)
+      enableScope(scope)
     }
   }
 
@@ -69,7 +69,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
   }
 
   return (
-    <HotkeysContext.Provider value={{activeScopes: internalActiveScopes, hotkeys: boundHotkeys, activateScope, deactivateScope, toggleScope}}>
+    <HotkeysContext.Provider value={{enabledScopes: internalActiveScopes, hotkeys: boundHotkeys, enableScope, disableScope, toggleScope}}>
       <BoundHotkeysProxyProviderProvider addHotkey={addBoundHotkey} removeHotkey={removeBoundHotkey}>
         {children}
       </BoundHotkeysProxyProviderProvider>

package/src/parseHotkeys.ts

@@ -2,6 +2,15 @@ import { Hotkey, KeyboardModifiers, Keys } from './types'
 
 const reservedModifierKeywords = ['ctrl', 'shift', 'alt', 'meta', 'mod']
 
+const mappedKeys: Record<string, string> = {
+  esc: 'escape',
+  return: 'enter',
+  left: 'arrowleft',
+  up: 'arrowup',
+  right: 'arrowright',
+  down: 'arrowdown',
+}
+
 export function parseKeysHookInput(keys: Keys, splitKey: string = ','): string[] {
   if (typeof keys === 'string') {
     return keys.split(splitKey)
@@ -15,8 +24,7 @@ export function parseHotkey(hotkey: string, combinationKey: string = '+'): Hotke
     .toLocaleLowerCase()
     .split(combinationKey)
     .map(k => k.trim())
-    .map(k => k === 'esc' ? 'escape' : k)
-    .map(k => k === 'return' ? 'enter' : k)
+    .map(k => mappedKeys[k] || k)
 
   const modifiers: KeyboardModifiers = {
     alt: keys.includes('alt'),

package/src/useHotkeys.ts

@@ -34,11 +34,11 @@ export default function useHotkeys<T extends HTMLElement>(
   const cb = useCallback(callback, [..._deps])
   const memoisedOptions = useDeepEqualMemo(_options)
 
-  const { activeScopes } = useHotkeysContext()
+  const { enabledScopes } = useHotkeysContext()
   const proxy = useBoundHotkeysProxy()
 
   useLayoutEffect(() => {
-    if (memoisedOptions?.enabled === false || !isScopeActive(activeScopes, memoisedOptions?.scopes)) {
+    if (memoisedOptions?.enabled === false || !isScopeActive(enabledScopes, memoisedOptions?.scopes)) {
       return
     }
 
@@ -117,7 +117,7 @@ export default function useHotkeys<T extends HTMLElement>(
         parseKeysHookInput(keys, memoisedOptions?.splitKey).forEach((key) => proxy.removeHotkey(parseHotkey(key, memoisedOptions?.combinationKey)))
       }
     }
-  }, [keys, cb, memoisedOptions, activeScopes])
+  }, [keys, cb, memoisedOptions, enabledScopes])
 
   return ref
 }