react-hotkeys-hook 4.4.2 → 4.4.4

package/dist/validators.d.ts

@@ -0,0 +1,7 @@
+import { FormTags, Hotkey, Scopes, Trigger } from './types';
+export declare function maybePreventDefault(e: KeyboardEvent, hotkey: Hotkey, preventDefault?: Trigger): void;
+export declare function isHotkeyEnabled(e: KeyboardEvent, hotkey: Hotkey, enabled?: Trigger): boolean;
+export declare function isKeyboardEventTriggeredByInput(ev: KeyboardEvent): boolean;
+export declare function isHotkeyEnabledOnTag({ target }: KeyboardEvent, enabledOnTags?: readonly FormTags[] | boolean): boolean;
+export declare function isScopeActive(activeScopes: string[], scopes?: Scopes): boolean;
+export declare const isHotkeyMatchingKeyboardEvent: (e: KeyboardEvent, hotkey: Hotkey, ignoreModifiers?: boolean) => boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-hotkeys-hook",
   "description": "React hook for handling keyboard shortcuts",
-  "version": "4.4.2",
+  "version": "4.4.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/JohannesKlauss/react-keymap-hook.git"
@@ -78,18 +78,18 @@
     }
   },
   "devDependencies": {
-    "@babel/core": "7.23.2",
+    "@babel/core": "7.23.7",
     "@babel/plugin-proposal-class-properties": "7.18.6",
-    "@babel/plugin-transform-react-jsx": "7.22.15",
-    "@babel/preset-env": "7.23.2",
-    "@babel/preset-react": "7.22.15",
-    "@babel/preset-typescript": "7.23.2",
+    "@babel/plugin-transform-react-jsx": "7.23.4",
+    "@babel/preset-env": "7.23.7",
+    "@babel/preset-react": "7.23.3",
+    "@babel/preset-typescript": "7.23.3",
     "@testing-library/jest-dom": "5.17.0",
-    "@testing-library/react": "14.0.0",
-    "@testing-library/user-event": "14.4.3",
-    "@types/jest": "29.5.6",
-    "@types/react": "18.2.33",
-    "@types/react-dom": "18.2.14",
+    "@testing-library/react": "14.1.2",
+    "@testing-library/user-event": "14.5.2",
+    "@types/jest": "29.5.11",
+    "@types/react": "18.2.47",
+    "@types/react-dom": "18.2.18",
     "@typescript-eslint/eslint-plugin": "5.60.0",
     "@typescript-eslint/parser": "5.60.0",
     "eslint": "8.56.0",
@@ -102,8 +102,8 @@
     "react-dom": "18.2.0",
     "react-test-renderer": "18.2.0",
     "tsdx": "0.14.1",
-    "tslib": "2.5.3",
-    "typescript": "5.0.4"
+    "tslib": "2.6.2",
+    "typescript": "5.3.3"
   },
   "peerDependencies": {
     "react": ">=16.8.1",

package/src/useHotkeys.ts

@@ -64,20 +64,18 @@ export default function useHotkeys<T extends HTMLElement>(
         return
       }
 
-      if (memoisedOptions?.ignoreEventWhen?.(e)) {
-        return
-      }
-
       // TODO: SINCE THE EVENT IS NOW ATTACHED TO THE REF, THE ACTIVE ELEMENT CAN NEVER BE INSIDE THE REF. THE HOTKEY ONLY TRIGGERS IF THE
       // REF IS THE ACTIVE ELEMENT. THIS IS A PROBLEM SINCE FOCUSED SUB COMPONENTS WON'T TRIGGER THE HOTKEY.
-      if (
-        ref.current !== null &&
-        document.activeElement !== ref.current &&
-        !ref.current.contains(document.activeElement)
-      ) {
-        stopPropagation(e)
-
-        return
+      if (ref.current !== null) {
+        const rootNode = ref.current.getRootNode()
+        if (
+          (rootNode instanceof Document || rootNode instanceof ShadowRoot) &&
+          rootNode.activeElement !== ref.current &&
+          !ref.current.contains(rootNode.activeElement)
+        ) {
+          stopPropagation(e)
+          return
+        }
       }
 
       if ((e.target as HTMLElement)?.isContentEditable && !memoisedOptions?.enableOnContentEditable) {
@@ -88,6 +86,10 @@ export default function useHotkeys<T extends HTMLElement>(
         const hotkey = parseHotkey(key, memoisedOptions?.combinationKey)
 
         if (isHotkeyMatchingKeyboardEvent(e, hotkey, memoisedOptions?.ignoreModifiers) || hotkey.keys?.includes('*')) {
+          if (memoisedOptions?.ignoreEventWhen?.(e)) {
+            return
+          }
+
           if (isKeyUp && hasTriggeredRef.current) {
             return
           }

package/src/validators.ts

@@ -58,8 +58,8 @@ export const isHotkeyMatchingKeyboardEvent = (e: KeyboardEvent, hotkey: Hotkey,
   const keyCode = mapKey(code)
   const pressedKey = pressedKeyUppercase.toLowerCase()
 
-  if (!keys?.includes(keyCode) && !['ctrl', 'control', 'unknown', 'meta', 'alt', 'shift', 'os'].includes(keyCode)) {
-    return false;
+  if (!keys?.includes(keyCode) && !keys?.includes(pressedKey) && !['ctrl', 'control', 'unknown', 'meta', 'alt', 'shift', 'os'].includes(keyCode)) {
+    return false
   }
 
   if (!ignoreModifiers) {