@lightningtv/core - npm Package Compare versions

Comparing version 2.6.2 to 2.7.0-0

dist/src/focusManager.d.ts

@@ -14,6 +14,5 @@ export type * from './focusKeyTypes.js';
     keyHoldOptions?: KeyHoldOptions;
-    propagatedUpKeys?: string[];
     ownerContext?: (cb: () => void) => void;
 }
-export declare const useFocusManager: ({ userKeyMap, propagatedUpKeys, keyHoldOptions, ownerContext, }?: FocusManagerOptions) => {
+export declare const useFocusManager: ({ userKeyMap, keyHoldOptions, ownerContext, }?: FocusManagerOptions) => {
     cleanup: () => void;
@@ -20,0 +19,0 @@ focusPath: () => ElementNode[];

dist/src/focusManager.js

@@ -106,18 +106,8 @@ import { Config } from './config.js';
 };
-const propagateKeyPress = (e, mappedEvent, isHold, propagatedUpKeys = []) => {
+const propagateKeyPress = (e, mappedEvent, isHold = false, isUp = false) => {
     let finalFocusElm = undefined;
-    const isUp = e.type === 'keyup';
-    const propagateKeyUp = Boolean(mappedEvent && propagatedUpKeys.includes(mappedEvent));
     if (mappedEvent) {
         for (const elm of focusPath) {
             finalFocusElm = finalFocusElm || elm;
-            const keyEvent = elm[`on${mappedEvent}`];
-            const keyUpEvent = elm[`on${mappedEvent}Up`];
-            const keyDownEvent = elm[`on${mappedEvent}Down`];
-            const skipDown = !isUp && propagateKeyUp && !keyDownEvent;
-            const skipUp = isUp && !isHold && !propagateKeyUp && !keyUpEvent;
-            if (skipDown || skipUp) {
-                continue;
-            }
-            const onKeyHandler = (isUp ? keyUpEvent : keyDownEvent) || keyEvent;
+            const onKeyHandler = (isUp ? elm[`on${mappedEvent}Release`] : elm[`on${mappedEvent}`]);
             if (isFunction(onKeyHandler) &&
@@ -127,5 +117,2 @@ onKeyHandler.call(elm, e, elm, finalFocusElm) === true) {
             }
-            if (isUp && !isHold) {
-                continue;
-            }
             const fallbackFunction = isHold ? elm.onKeyHold : elm.onKeyPress;
@@ -143,3 +130,3 @@ if (isFunction(fallbackFunction) &&
 };
-const DEFAULT_KEY_HOLD_THRESHOLD = 200; // ms
+const DEFAULT_KEY_HOLD_THRESHOLD = 500; // ms
 const keyHoldTimeouts = {};
@@ -149,3 +136,3 @@ const keyHoldCallback = (e, mappedKeyHoldEvent) => {
 };
-const handleKeyEvents = (delay, propagatedUpKeys, keydown, keyup) => {
+const handleKeyEvents = (delay, keydown, keyup) => {
     if (keydown) {
@@ -157,6 +144,10 @@ const key = keydown.key || keydown.keyCode;
             if (!keyHoldTimeouts[key]) {
-                keyHoldTimeouts[key] = window.setTimeout(() => keyHoldCallback(keydown, mappedKeyHoldEvent), delay);
+                keyHoldTimeouts[key] = window.setTimeout(() => {
+                    keyHoldCallback(keydown, mappedKeyHoldEvent);
+                    keyHoldTimeouts[key] = true;
+                }, delay);
             }
+            return;
         }
-        propagateKeyPress(keydown, mappedKeyEvent, false, propagatedUpKeys);
+        propagateKeyPress(keydown, mappedKeyEvent, false);
     }
@@ -166,10 +157,12 @@ else if (keyup) {
         const mappedKeyEvent = keyMapEntries[keyup.key] || keyMapEntries[keyup.keyCode];
-        if (keyHoldTimeouts[key]) {
+        if (keyHoldTimeouts[key] && keyHoldTimeouts[key] !== true) {
             clearTimeout(keyHoldTimeouts[key]);
-            delete keyHoldTimeouts[key];
+            // trigger key down event when hold didn't finish
+            propagateKeyPress(keyup, mappedKeyEvent, false);
         }
-        propagateKeyPress(keyup, mappedKeyEvent, false, propagatedUpKeys);
+        delete keyHoldTimeouts[key];
+        propagateKeyPress(keyup, mappedKeyEvent, false, true);
     }
 };
-export const useFocusManager = ({ userKeyMap, propagatedUpKeys = [], keyHoldOptions, ownerContext = (cb) => {
+export const useFocusManager = ({ userKeyMap, keyHoldOptions, ownerContext = (cb) => {
     cb();
@@ -184,3 +177,3 @@ }, } = {}) => {
     const delay = keyHoldOptions?.holdThreshold || DEFAULT_KEY_HOLD_THRESHOLD;
-    const runKeyEvent = handleKeyEvents.bind(null, delay, propagatedUpKeys);
+    const runKeyEvent = handleKeyEvents.bind(null, delay);
     // Owner context is for frameworks that need effects
@@ -200,3 +193,3 @@ const keyPressHandler = (event) => ownerContext(() => {
             for (const [_, timeout] of Object.entries(keyHoldTimeouts)) {
-                if (timeout)
+                if (timeout && timeout !== true)
                     clearTimeout(timeout);
@@ -203,0 +196,0 @@ }

package.json

 {
   "name": "@lightningtv/core",
-  "version": "2.6.2",
+  "version": "2.7.0-0",
   "description": "Lightning TV Core for Universal Renderers",
@@ -5,0 +5,0 @@ "type": "module",

src/focusManager.ts

@@ -145,10 +145,6 @@ import { Config } from './config.js';
   mappedEvent: string | undefined,
-  isHold: boolean,
-  propagatedUpKeys: string[] = [],
+  isHold: boolean = false,
+  isUp: boolean = false,
 ) => {
   let finalFocusElm: ElementNode | undefined = undefined;
-  const isUp = e.type === 'keyup';
-  const propagateKeyUp = Boolean(
-    mappedEvent && propagatedUpKeys.includes(mappedEvent),
-  );
 
@@ -158,15 +154,6 @@ if (mappedEvent) {
       finalFocusElm = finalFocusElm || elm;
-      const keyEvent = elm[`on${mappedEvent}`] as unknown;
-      const keyUpEvent = elm[`on${mappedEvent}Up`] as unknown;
-      const keyDownEvent = elm[`on${mappedEvent}Down`] as unknown;
+      const onKeyHandler = (
+        isUp ? elm[`on${mappedEvent}Release`] : elm[`on${mappedEvent}`]
+      ) as unknown;
 
-      const skipDown = !isUp && propagateKeyUp && !keyDownEvent;
-      const skipUp = isUp && !isHold && !propagateKeyUp && !keyUpEvent;
-
-      if (skipDown || skipUp) {
-        continue;
-      }
-
-      const onKeyHandler = (isUp ? keyUpEvent : keyDownEvent) || keyEvent;
-
       if (
@@ -179,6 +166,2 @@ isFunction(onKeyHandler) &&
 
-      if (isUp && !isHold) {
-        continue;
-      }
-
       const fallbackFunction = isHold ? elm.onKeyHold : elm.onKeyPress;
@@ -199,4 +182,4 @@ if (
 
-const DEFAULT_KEY_HOLD_THRESHOLD = 200; // ms
-const keyHoldTimeouts: { [key: KeyNameOrKeyCode]: number } = {};
+const DEFAULT_KEY_HOLD_THRESHOLD = 500; // ms
+const keyHoldTimeouts: { [key: KeyNameOrKeyCode]: number | true } = {};
 
@@ -212,3 +195,2 @@ const keyHoldCallback = (
   delay: number,
-  propagatedUpKeys: string[],
   keydown?: KeyboardEvent,
@@ -225,10 +207,11 @@ keyup?: KeyboardEvent,
       if (!keyHoldTimeouts[key]) {
-        keyHoldTimeouts[key] = window.setTimeout(
-          () => keyHoldCallback(keydown, mappedKeyHoldEvent),
-          delay,
-        );
+        keyHoldTimeouts[key] = window.setTimeout(() => {
+          keyHoldCallback(keydown, mappedKeyHoldEvent);
+          keyHoldTimeouts[key] = true;
+        }, delay);
       }
+      return;
     }
 
-    propagateKeyPress(keydown, mappedKeyEvent, false, propagatedUpKeys);
+    propagateKeyPress(keydown, mappedKeyEvent, false);
   } else if (keyup) {
@@ -238,8 +221,9 @@ const key: KeyNameOrKeyCode = keyup.key || keyup.keyCode;
       keyMapEntries[keyup.key] || keyMapEntries[keyup.keyCode];
-    if (keyHoldTimeouts[key]) {
+    if (keyHoldTimeouts[key] && keyHoldTimeouts[key] !== true) {
       clearTimeout(keyHoldTimeouts[key]);
-      delete keyHoldTimeouts[key];
+      // trigger key down event when hold didn't finish
+      propagateKeyPress(keyup, mappedKeyEvent, false);
     }
-
-    propagateKeyPress(keyup, mappedKeyEvent, false, propagatedUpKeys);
+    delete keyHoldTimeouts[key];
+    propagateKeyPress(keyup, mappedKeyEvent, false, true);
   }
@@ -251,3 +235,2 @@ };
   keyHoldOptions?: KeyHoldOptions;
-  propagatedUpKeys?: string[];
   ownerContext?: (cb: () => void) => void;
@@ -258,3 +241,2 @@ }
   userKeyMap,
-  propagatedUpKeys = [],
   keyHoldOptions,
@@ -274,3 +256,3 @@ ownerContext = (cb) => {
   const delay = keyHoldOptions?.holdThreshold || DEFAULT_KEY_HOLD_THRESHOLD;
-  const runKeyEvent = handleKeyEvents.bind(null, delay, propagatedUpKeys);
+  const runKeyEvent = handleKeyEvents.bind(null, delay);
 
@@ -296,3 +278,3 @@ // Owner context is for frameworks that need effects
       for (const [_, timeout] of Object.entries(keyHoldTimeouts)) {
-        if (timeout) clearTimeout(timeout);
+        if (timeout && timeout !== true) clearTimeout(timeout);
       }
@@ -299,0 +281,0 @@ },

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

234742

increased by1.08%

Number of package files

64

increased by6.67%

Lines of code

3653

increased by1.47%

Worsened metrics

Number of low quality alerts

3

increased by50%

No dependency changes