react-hotkeys-hook 5.0.1 → 5.2.0

package/README.md

@@ -26,7 +26,9 @@
   </a>
 </p>
 
-<pre align="center">npm i react-hotkeys-hook</pre>
+```
+npm i react-hotkeys-hook
+```
 
 <p align="center">
 A React hook for using keyboard shortcuts in components in a declarative way.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-hotkeys-hook",
   "description": "React hook for handling keyboard shortcuts",
-  "version": "5.0.1",
+  "version": "5.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/JohannesKlauss/react-keymap-hook.git"
@@ -30,9 +30,10 @@
   "scripts": {
     "build": "npm run -w packages/react-hotkeys-hook build",
     "build:documentation": "npm run -w packages/documentation build",
-    "lint": "npm run -w packages/react-hotkeys-hook lint",
     "test": "npm run -w packages/react-hotkeys-hook test",
-    "prepublishOnly": "npm run test && npm run lint && npm run build"
+    "prepublishOnly": "npm run test && npm run lint && npm run build",
+    "format": "npx @biomejs/biome format --write packages",
+    "lint": "npx @biomejs/biome lint --write packages"
   },
   "workspaces": [
     "packages/*"
@@ -40,5 +41,8 @@
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.0.6"
   }
 }

package/packages/react-hotkeys-hook/dist/index.d.ts

@@ -3,4 +3,4 @@ import { Options, Keys, HotkeyCallback } from './types';
 import { HotkeysProvider, useHotkeysContext } from './HotkeysProvider';
 import { isHotkeyPressed } from './isHotkeyPressed';
 import { default as useRecordHotkeys } from './useRecordHotkeys';
-export { useHotkeys, useRecordHotkeys, useHotkeysContext, isHotkeyPressed, HotkeysProvider, Options, Keys, HotkeyCallback, };
+export { useHotkeys, useRecordHotkeys, useHotkeysContext, isHotkeyPressed, HotkeysProvider, type Options, type Keys, type HotkeyCallback, };

package/packages/react-hotkeys-hook/dist/index.js

@@ -1,6 +1,6 @@
-import { createContext as I, useContext as q, useState as A, useCallback as w, useRef as S, useLayoutEffect as Q, useEffect as U } from "react";
-import { jsx as R } from "react/jsx-runtime";
-const F = ["shift", "alt", "meta", "mod", "ctrl", "control"], V = {
+import { createContext as T, useContext as M, useState as A, useCallback as w, useRef as S, useLayoutEffect as z, useEffect as J } from "react";
+import { jsx as b } from "react/jsx-runtime";
+const j = ["shift", "alt", "meta", "mod", "ctrl", "control"], Q = {
   esc: "escape",
   return: "enter",
   left: "arrowleft",
@@ -18,99 +18,108 @@ const F = ["shift", "alt", "meta", "mod", "ctrl", "control"], V = {
   ControlLeft: "ctrl",
   ControlRight: "ctrl"
 };
-function g(t) {
-  return (V[t.trim()] || t.trim()).toLowerCase().replace(/key|digit|numpad/, "");
-}
-function X(t) {
-  return F.includes(t);
-}
-function P(t, r = ",") {
-  return t.toLowerCase().split(r);
-}
-function b(t, r = "+", n = !1, a) {
-  const c = t.toLocaleLowerCase().split(r).map((i) => g(i)), l = {
-    alt: c.includes("alt"),
-    ctrl: c.includes("ctrl") || c.includes("control"),
-    shift: c.includes("shift"),
-    meta: c.includes("meta"),
-    mod: c.includes("mod"),
-    useKey: n
-  }, o = c.filter((i) => !F.includes(i));
+function K(e) {
+  return (Q[e.trim()] || e.trim()).toLowerCase().replace(/key|digit|numpad/, "");
+}
+function D(e) {
+  return j.includes(e);
+}
+function H(e, r = ",") {
+  return e.toLowerCase().split(r);
+}
+function P(e, r = "+", o = ">", i = !1, u) {
+  let n = [], c = !1;
+  e = e.trim(), e.includes(o) ? (c = !0, n = e.toLocaleLowerCase().split(o).map((f) => K(f))) : n = e.toLocaleLowerCase().split(r).map((f) => K(f));
+  const y = {
+    alt: n.includes("alt"),
+    ctrl: n.includes("ctrl") || n.includes("control"),
+    shift: n.includes("shift"),
+    meta: n.includes("meta"),
+    mod: n.includes("mod"),
+    useKey: i
+  }, d = n.filter((f) => !j.includes(f));
   return {
-    ...l,
-    keys: o,
-    description: a
+    ...y,
+    keys: d,
+    description: u,
+    isSequence: c,
+    hotkey: e
   };
 }
-typeof document < "u" && (document.addEventListener("keydown", (t) => {
-  t.code !== void 0 && T([g(t.code)]);
-}), document.addEventListener("keyup", (t) => {
-  t.code !== void 0 && W([g(t.code)]);
-})), typeof window < "u" && window.addEventListener("blur", () => {
-  v.clear();
-});
-const v = /* @__PURE__ */ new Set();
-function B(t) {
-  return Array.isArray(t);
+typeof document < "u" && (document.addEventListener("keydown", (e) => {
+  e.code !== void 0 && I([K(e.code)]);
+}), document.addEventListener("keyup", (e) => {
+  e.code !== void 0 && _([K(e.code)]);
+})), typeof window < "u" && (window.addEventListener("blur", () => {
+  L.clear();
+}), window.addEventListener("contextmenu", () => {
+  setTimeout(() => {
+    L.clear();
+  }, 0);
+}));
+const L = /* @__PURE__ */ new Set();
+function R(e) {
+  return Array.isArray(e);
 }
-function Y(t, r = ",") {
-  return (B(t) ? t : t.split(r)).every((a) => v.has(a.trim().toLowerCase()));
+function U(e, r = ",") {
+  return (R(e) ? e : e.split(r)).every((i) => L.has(i.trim().toLowerCase()));
 }
-function T(t) {
-  const r = Array.isArray(t) ? t : [t];
-  v.has("meta") && v.forEach((n) => !X(n) && v.delete(n.toLowerCase())), r.forEach((n) => v.add(n.toLowerCase()));
+function I(e) {
+  const r = Array.isArray(e) ? e : [e];
+  L.has("meta") && L.forEach((o) => !D(o) && L.delete(o.toLowerCase())), r.forEach((o) => L.add(o.toLowerCase()));
 }
-function W(t) {
-  const r = Array.isArray(t) ? t : [t];
-  t === "meta" ? v.clear() : r.forEach((n) => v.delete(n.toLowerCase()));
+function _(e) {
+  const r = Array.isArray(e) ? e : [e];
+  e === "meta" ? L.clear() : r.forEach((o) => L.delete(o.toLowerCase()));
 }
-function Z(t, r, n) {
-  (typeof n == "function" && n(t, r) || n === !0) && t.preventDefault();
+function V(e, r, o) {
+  (typeof o == "function" && o(e, r) || o === !0) && e.preventDefault();
 }
-function $(t, r, n) {
-  return typeof n == "function" ? n(t, r) : n === !0 || n === void 0;
+function X(e, r, o) {
+  return typeof o == "function" ? o(e, r) : o === !0 || o === void 0;
 }
-function _(t) {
-  return z(t, ["input", "textarea", "select"]);
+const Y = ["input", "textarea", "select", "searchbox", "slider", "spinbutton", "menuitem", "menuitemcheckbox", "menuitemradio", "option", "radio", "textbox"];
+function Z(e) {
+  return F(e, Y);
 }
-function z(t, r = !1) {
-  const { target: n, composed: a } = t;
-  let c;
-  return m(n) && a ? c = t.composedPath()[0] && t.composedPath()[0].tagName : c = n && n.tagName, B(r) ? !!(c && r && r.some((l) => l.toLowerCase() === c.toLowerCase())) : !!(c && r && r);
+function F(e, r = !1) {
+  const { target: o, composed: i } = e;
+  let u, n;
+  return ee(o) && i ? (u = e.composedPath()[0] && e.composedPath()[0].tagName, n = e.composedPath()[0] && e.composedPath()[0].role) : (u = o && o.tagName, n = o && o.role), R(r) ? !!(u && r && r.some((c) => c.toLowerCase() === u.toLowerCase() || c === n)) : !!(u && r && r);
 }
-function m(t) {
-  return !!t.tagName && !t.tagName.startsWith("-") && t.tagName.includes("-");
+function ee(e) {
+  return !!e.tagName && !e.tagName.startsWith("-") && e.tagName.includes("-");
 }
-function O(t, r) {
-  return t.length === 0 && r ? (console.warn(
+function te(e, r) {
+  return e.length === 0 && r ? (console.warn(
     'A hotkey has the "scopes" option set, however no active scopes were found. If you want to use the global scopes feature, you need to wrap your app in a <HotkeysProvider>'
-  ), !0) : r ? t.some((n) => r.includes(n)) || t.includes("*") : !0;
+  ), !0) : r ? e.some((o) => r.includes(o)) || e.includes("*") : !0;
 }
-const ee = (t, r, n = !1) => {
-  const { alt: a, meta: c, mod: l, shift: o, ctrl: i, keys: f, useKey: y } = r, { code: k, key: e, ctrlKey: s, metaKey: d, shiftKey: C, altKey: H } = t, h = g(k);
-  if (y && (f == null ? void 0 : f.length) === 1 && f.includes(e))
+const re = (e, r, o = !1) => {
+  const { alt: i, meta: u, mod: n, shift: c, ctrl: y, keys: d, useKey: f } = r, { code: p, key: t, ctrlKey: a, metaKey: l, shiftKey: g, altKey: k } = e, m = K(p);
+  if (f && d?.length === 1 && d.includes(t))
     return !0;
-  if (!(f != null && f.includes(h)) && !["ctrl", "control", "unknown", "meta", "alt", "shift", "os"].includes(h))
+  if (!d?.includes(m) && !["ctrl", "control", "unknown", "meta", "alt", "shift", "os"].includes(m))
     return !1;
-  if (!n) {
-    if (a !== H && h !== "alt" || o !== C && h !== "shift")
+  if (!o) {
+    if (i !== k && m !== "alt" || c !== g && m !== "shift")
       return !1;
-    if (l) {
-      if (!d && !s)
+    if (n) {
+      if (!l && !a)
         return !1;
-    } else if (c !== d && h !== "meta" && h !== "os" || i !== s && h !== "ctrl" && h !== "control")
+    } else if (u !== l && m !== "meta" && m !== "os" || y !== a && m !== "ctrl" && m !== "control")
       return !1;
   }
-  return f && f.length === 1 && f.includes(h) ? !0 : f ? Y(f) : !f;
-}, G = I(void 0), te = () => q(G);
-function re({ addHotkey: t, removeHotkey: r, children: n }) {
-  return /* @__PURE__ */ R(G.Provider, { value: { addHotkey: t, removeHotkey: r }, children: n });
+  return d && d.length === 1 && d.includes(m) ? !0 : d ? U(d) : !d;
+}, $ = T(void 0), oe = () => M($);
+function ne({ addHotkey: e, removeHotkey: r, children: o }) {
+  return /* @__PURE__ */ b($.Provider, { value: { addHotkey: e, removeHotkey: r }, children: o });
 }
-function N(t, r) {
-  return t && r && typeof t == "object" && typeof r == "object" ? Object.keys(t).length === Object.keys(r).length && // @ts-expect-error TS7053
-  Object.keys(t).reduce((n, a) => n && N(t[a], r[a]), !0) : t === r;
+function x(e, r) {
+  return e && r && typeof e == "object" && typeof r == "object" ? Object.keys(e).length === Object.keys(r).length && // @ts-expect-error TS7053
+  Object.keys(e).reduce((o, i) => o && x(e[i], r[i]), !0) : e === r;
 }
-const J = I({
+const W = T({
   hotkeys: [],
   activeScopes: [],
   // This array has to be empty instead of containing '*' as default, to check if the provider is set or not
@@ -120,101 +129,141 @@ const J = I({
   },
   disableScope: () => {
   }
-}), ne = () => q(J), fe = ({ initiallyActiveScopes: t = ["*"], children: r }) => {
-  const [n, a] = A(t), [c, l] = A([]), o = w((e) => {
-    a((s) => s.includes("*") ? [e] : Array.from(/* @__PURE__ */ new Set([...s, e])));
-  }, []), i = w((e) => {
-    a((s) => s.filter((d) => d !== e));
-  }, []), f = w((e) => {
-    a((s) => s.includes(e) ? s.filter((d) => d !== e) : s.includes("*") ? [e] : Array.from(/* @__PURE__ */ new Set([...s, e])));
-  }, []), y = w((e) => {
-    l((s) => [...s, e]);
-  }, []), k = w((e) => {
-    l((s) => s.filter((d) => !N(d, e)));
+}), se = () => M(W), de = ({ initiallyActiveScopes: e = ["*"], children: r }) => {
+  const [o, i] = A(e), [u, n] = A([]), c = w((t) => {
+    i((a) => a.includes("*") ? [t] : Array.from(/* @__PURE__ */ new Set([...a, t])));
+  }, []), y = w((t) => {
+    i((a) => a.filter((l) => l !== t));
+  }, []), d = w((t) => {
+    i((a) => a.includes(t) ? a.filter((l) => l !== t) : a.includes("*") ? [t] : Array.from(/* @__PURE__ */ new Set([...a, t])));
+  }, []), f = w((t) => {
+    n((a) => [...a, t]);
+  }, []), p = w((t) => {
+    n((a) => a.filter((l) => !x(l, t)));
   }, []);
-  return /* @__PURE__ */ R(
-    J.Provider,
+  return /* @__PURE__ */ b(
+    W.Provider,
     {
-      value: { activeScopes: n, hotkeys: c, enableScope: o, disableScope: i, toggleScope: f },
-      children: /* @__PURE__ */ R(re, { addHotkey: y, removeHotkey: k, children: r })
+      value: { activeScopes: o, hotkeys: u, enableScope: c, disableScope: y, toggleScope: d },
+      children: /* @__PURE__ */ b(ne, { addHotkey: f, removeHotkey: p, children: r })
     }
   );
 };
-function oe(t) {
+function ie(e) {
   const r = S(void 0);
-  return N(r.current, t) || (r.current = t), r.current;
-}
-const D = (t) => {
-  t.stopPropagation(), t.preventDefault(), t.stopImmediatePropagation();
-}, ce = typeof window < "u" ? Q : U;
-function se(t, r, n, a) {
-  const c = S(null), l = S(!1), o = n instanceof Array ? a instanceof Array ? void 0 : a : n, i = B(t) ? t.join(o == null ? void 0 : o.delimiter) : t, f = n instanceof Array ? n : a instanceof Array ? a : void 0, y = w(r, f ?? []), k = S(y);
-  f ? k.current = y : k.current = r;
-  const e = oe(o), { activeScopes: s } = ne(), d = te();
-  return ce(() => {
-    if ((e == null ? void 0 : e.enabled) === !1 || !O(s, e == null ? void 0 : e.scopes))
+  return x(r.current, e) || (r.current = e), r.current;
+}
+const N = (e) => {
+  e.stopPropagation(), e.preventDefault(), e.stopImmediatePropagation();
+}, ue = typeof window < "u" ? z : J;
+function fe(e, r, o, i) {
+  const u = S(null), n = S(!1), c = Array.isArray(o) ? Array.isArray(i) ? void 0 : i : o, y = R(e) ? e.join(c?.delimiter) : e, d = Array.isArray(o) ? o : Array.isArray(i) ? i : void 0, f = w(r, d ?? []), p = S(f);
+  d ? p.current = f : p.current = r;
+  const t = ie(c), { activeScopes: a } = se(), l = oe();
+  return ue(() => {
+    if (t?.enabled === !1 || !te(a, t?.scopes))
       return;
-    const C = (u, p = !1) => {
-      var j;
-      if (!(_(u) && !z(u, e == null ? void 0 : e.enableOnFormTags))) {
-        if (c.current !== null) {
-          const E = c.current.getRootNode();
-          if ((E instanceof Document || E instanceof ShadowRoot) && E.activeElement !== c.current && !c.current.contains(E.activeElement)) {
-            D(u);
+    let g = [], k;
+    const m = (s, B = !1) => {
+      if (!(Z(s) && !F(s, t?.enableOnFormTags))) {
+        if (u.current !== null) {
+          const v = u.current.getRootNode();
+          if ((v instanceof Document || v instanceof ShadowRoot) && v.activeElement !== u.current && !u.current.contains(v.activeElement)) {
+            N(s);
             return;
           }
         }
-        (j = u.target) != null && j.isContentEditable && !(e != null && e.enableOnContentEditable) || P(i, e == null ? void 0 : e.delimiter).forEach((E) => {
-          var M, x;
-          const L = b(E, e == null ? void 0 : e.splitKey, e == null ? void 0 : e.useKey, e == null ? void 0 : e.description);
-          if (ee(u, L, e == null ? void 0 : e.ignoreModifiers) || (M = L.keys) != null && M.includes("*")) {
-            if ((x = e == null ? void 0 : e.ignoreEventWhen) != null && x.call(e, u) || p && l.current)
+        s.target?.isContentEditable && !t?.enableOnContentEditable || H(y, t?.delimiter).forEach((v) => {
+          if (v.includes(t?.splitKey ?? "+") && v.includes(t?.sequenceSplitKey ?? ">")) {
+            console.warn(
+              `Hotkey ${v} contains both ${t?.splitKey ?? "+"} and ${t?.sequenceSplitKey ?? ">"} which is not supported.`
+            );
+            return;
+          }
+          const h = P(
+            v,
+            t?.splitKey,
+            t?.sequenceSplitKey,
+            t?.useKey,
+            t?.description
+          );
+          if (h.isSequence) {
+            k = setTimeout(() => {
+              g = [];
+            }, t?.sequenceTimeoutMs ?? 1e3);
+            const C = h.useKey ? s.key : K(s.code);
+            if (D(C.toLowerCase()))
               return;
-            if (Z(u, L, e == null ? void 0 : e.preventDefault), !$(u, L, e == null ? void 0 : e.enabled)) {
-              D(u);
+            g.push(C);
+            const G = h.keys?.[g.length - 1];
+            if (C !== G) {
+              g = [], k && clearTimeout(k);
               return;
             }
-            k.current(u, L), p || (l.current = !0);
+            g.length === h.keys?.length && (p.current(s, h), k && clearTimeout(k), g = []);
+          } else if (re(s, h, t?.ignoreModifiers) || h.keys?.includes("*")) {
+            if (t?.ignoreEventWhen?.(s) || B && n.current)
+              return;
+            if (V(s, h, t?.preventDefault), !X(s, h, t?.enabled)) {
+              N(s);
+              return;
+            }
+            p.current(s, h), B || (n.current = !0);
           }
         });
       }
-    }, H = (u) => {
-      u.code !== void 0 && (T(g(u.code)), ((e == null ? void 0 : e.keydown) === void 0 && (e == null ? void 0 : e.keyup) !== !0 || e != null && e.keydown) && C(u));
-    }, h = (u) => {
-      u.code !== void 0 && (W(g(u.code)), l.current = !1, e != null && e.keyup && C(u, !0));
-    }, K = c.current || (o == null ? void 0 : o.document) || document;
-    return K.addEventListener("keyup", h, o == null ? void 0 : o.eventListenerOptions), K.addEventListener("keydown", H, o == null ? void 0 : o.eventListenerOptions), d && P(i, e == null ? void 0 : e.delimiter).forEach(
-      (u) => d.addHotkey(
-        b(u, e == null ? void 0 : e.splitKey, e == null ? void 0 : e.useKey, e == null ? void 0 : e.description)
+    }, O = (s) => {
+      s.code !== void 0 && (I(K(s.code)), (t?.keydown === void 0 && t?.keyup !== !0 || t?.keydown) && m(s));
+    }, q = (s) => {
+      s.code !== void 0 && (_(K(s.code)), n.current = !1, t?.keyup && m(s, !0));
+    }, E = u.current || c?.document || document;
+    return E.addEventListener("keyup", q, c?.eventListenerOptions), E.addEventListener("keydown", O, c?.eventListenerOptions), l && H(y, t?.delimiter).forEach(
+      (s) => l.addHotkey(
+        P(
+          s,
+          t?.splitKey,
+          t?.sequenceSplitKey,
+          t?.useKey,
+          t?.description
+        )
       )
     ), () => {
-      K.removeEventListener("keyup", h, o == null ? void 0 : o.eventListenerOptions), K.removeEventListener("keydown", H, o == null ? void 0 : o.eventListenerOptions), d && P(i, e == null ? void 0 : e.delimiter).forEach(
-        (u) => d.removeHotkey(
-          b(u, e == null ? void 0 : e.splitKey, e == null ? void 0 : e.useKey, e == null ? void 0 : e.description)
+      E.removeEventListener("keyup", q, c?.eventListenerOptions), E.removeEventListener("keydown", O, c?.eventListenerOptions), l && H(y, t?.delimiter).forEach(
+        (s) => l.removeHotkey(
+          P(
+            s,
+            t?.splitKey,
+            t?.sequenceSplitKey,
+            t?.useKey,
+            t?.description
+          )
         )
-      );
+      ), g = [], k && clearTimeout(k);
     };
-  }, [i, e, s]), c;
-}
-function le(t = !1) {
-  const [r, n] = A(/* @__PURE__ */ new Set()), [a, c] = A(!1), l = w((y) => {
-    y.code !== void 0 && (y.preventDefault(), y.stopPropagation(), n((k) => {
-      const e = new Set(k);
-      return e.add(g(t ? y.key : y.code)), e;
-    }));
-  }, [t]), o = w(() => {
-    typeof document < "u" && (document.removeEventListener("keydown", l), c(!1));
-  }, [l]), i = w(() => {
-    n(/* @__PURE__ */ new Set()), typeof document < "u" && (o(), document.addEventListener("keydown", l), c(!0));
-  }, [l, o]), f = w(() => {
-    n(/* @__PURE__ */ new Set());
+  }, [y, t, a]), u;
+}
+function le(e = !1) {
+  const [r, o] = A(/* @__PURE__ */ new Set()), [i, u] = A(!1), n = w(
+    (f) => {
+      f.code !== void 0 && (f.preventDefault(), f.stopPropagation(), o((p) => {
+        const t = new Set(p);
+        return t.add(K(e ? f.key : f.code)), t;
+      }));
+    },
+    [e]
+  ), c = w(() => {
+    typeof document < "u" && (document.removeEventListener("keydown", n), u(!1));
+  }, [n]), y = w(() => {
+    o(/* @__PURE__ */ new Set()), typeof document < "u" && (c(), document.addEventListener("keydown", n), u(!0));
+  }, [n, c]), d = w(() => {
+    o(/* @__PURE__ */ new Set());
   }, []);
-  return [r, { start: i, stop: o, resetKeys: f, isRecording: a }];
+  return [r, { start: y, stop: c, resetKeys: d, isRecording: i }];
 }
 export {
-  fe as HotkeysProvider,
-  Y as isHotkeyPressed,
-  se as useHotkeys,
-  ne as useHotkeysContext,
+  de as HotkeysProvider,
+  U as isHotkeyPressed,
+  fe as useHotkeys,
+  se as useHotkeysContext,
   le as useRecordHotkeys
 };

package/packages/react-hotkeys-hook/dist/parseHotkeys.d.ts

@@ -2,4 +2,4 @@ import { Hotkey } from './types';
 export declare function mapCode(key: string): string;
 export declare function isHotkeyModifier(key: string): boolean;
 export declare function parseKeysHookInput(keys: string, delimiter?: string): string[];
-export declare function parseHotkey(hotkey: string, splitKey?: string, useKey?: boolean, description?: string): Hotkey;
+export declare function parseHotkey(hotkey: string, splitKey?: string, sequenceSplitKey?: string, useKey?: boolean, description?: string): Hotkey;

package/packages/react-hotkeys-hook/dist/types.d.ts

@@ -1,8 +1,7 @@
 import { DependencyList } from 'react';
-export type FormTags = 'input' | 'textarea' | 'select' | 'INPUT' | 'TEXTAREA' | 'SELECT';
+export type FormTags = 'input' | 'textarea' | 'select' | 'INPUT' | 'TEXTAREA' | 'SELECT' | 'searchbox' | 'slider' | 'spinbutton' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'option' | 'radio' | 'textbox';
 export type Keys = string | readonly string[];
 export type Scopes = string | readonly string[];
-export type RefType<T> = T | null;
 export type EventListenerOptions = {
     capture?: boolean;
     once?: boolean;
@@ -21,6 +20,8 @@ export type Hotkey = KeyboardModifiers & {
     keys?: readonly string[];
     scopes?: Scopes;
     description?: string;
+    isSequence?: boolean;
+    hotkey: string;
 };
 export type HotkeysEvent = Hotkey;
 export type HotkeyCallback = (keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent) => void;
@@ -41,5 +42,7 @@ export type Options = {
     ignoreModifiers?: boolean;
     eventListenerOptions?: EventListenerOptions;
     useKey?: boolean;
+    sequenceTimeoutMs?: number;
+    sequenceSplitKey?: string;
 };
 export type OptionsOrDependencyArray = Options | DependencyList;

package/packages/react-hotkeys-hook/dist/useHotkeys.d.ts

@@ -1,2 +1,2 @@
-import { HotkeyCallback, Keys, OptionsOrDependencyArray, RefType } from './types';
-export default function useHotkeys<T extends HTMLElement>(keys: Keys, callback: HotkeyCallback, options?: OptionsOrDependencyArray, dependencies?: OptionsOrDependencyArray): import('react').RefObject<RefType<T>>;
+import { HotkeyCallback, Keys, OptionsOrDependencyArray } from './types';
+export default function useHotkeys<T extends HTMLElement>(keys: Keys, callback: HotkeyCallback, options?: OptionsOrDependencyArray, dependencies?: OptionsOrDependencyArray): import('react').RefObject<T | null>;