react-better-hotkeys 0.2.0

package/dist/definitions/KeyMap.js

@@ -0,0 +1,583 @@
+const e = {
+  Zero: {
+    on: "code",
+    value: "Digit0"
+  },
+  One: {
+    on: "code",
+    value: "Digit1"
+  },
+  Two: {
+    on: "code",
+    value: "Digit2"
+  },
+  Three: {
+    on: "code",
+    value: "Digit3"
+  },
+  Four: {
+    on: "code",
+    value: "Digit4"
+  },
+  Five: {
+    on: "code",
+    value: "Digit5"
+  },
+  Six: {
+    on: "code",
+    value: "Digit6"
+  },
+  Seven: {
+    on: "code",
+    value: "Digit7"
+  },
+  Eight: {
+    on: "code",
+    value: "Digit8"
+  },
+  Nine: {
+    on: "code",
+    value: "Digit9"
+  },
+  A: {
+    on: "code",
+    value: "KeyA"
+  },
+  B: {
+    on: "code",
+    value: "KeyB"
+  },
+  C: {
+    on: "code",
+    value: "KeyC"
+  },
+  D: {
+    on: "code",
+    value: "KeyD"
+  },
+  E: {
+    on: "code",
+    value: "KeyE"
+  },
+  F: {
+    on: "code",
+    value: "KeyF"
+  },
+  G: {
+    on: "code",
+    value: "KeyG"
+  },
+  H: {
+    on: "code",
+    value: "KeyH"
+  },
+  I: {
+    on: "code",
+    value: "KeyI"
+  },
+  J: {
+    on: "code",
+    value: "KeyJ"
+  },
+  K: {
+    on: "code",
+    value: "KeyK"
+  },
+  L: {
+    on: "code",
+    value: "KeyL"
+  },
+  M: {
+    on: "code",
+    value: "KeyM"
+  },
+  N: {
+    on: "code",
+    value: "KeyN"
+  },
+  O: {
+    on: "code",
+    value: "KeyO"
+  },
+  P: {
+    on: "code",
+    value: "KeyP"
+  },
+  Q: {
+    on: "code",
+    value: "KeyQ"
+  },
+  R: {
+    on: "code",
+    value: "KeyR"
+  },
+  S: {
+    on: "code",
+    value: "KeyS"
+  },
+  T: {
+    on: "code",
+    value: "KeyT"
+  },
+  U: {
+    on: "code",
+    value: "KeyU"
+  },
+  V: {
+    on: "code",
+    value: "KeyV"
+  },
+  W: {
+    on: "code",
+    value: "KeyW"
+  },
+  X: {
+    on: "code",
+    value: "KeyX"
+  },
+  Y: {
+    on: "code",
+    value: "KeyY"
+  },
+  Z: {
+    on: "code",
+    value: "KeyZ"
+  },
+  F1: {
+    on: "code",
+    value: "F1"
+  },
+  F2: {
+    on: "code",
+    value: "F2"
+  },
+  F3: {
+    on: "code",
+    value: "F3"
+  },
+  F4: {
+    on: "code",
+    value: "F4"
+  },
+  F5: {
+    on: "code",
+    value: "F5"
+  },
+  F6: {
+    on: "code",
+    value: "F6"
+  },
+  F7: {
+    on: "code",
+    value: "F7"
+  },
+  F8: {
+    on: "code",
+    value: "F8"
+  },
+  F9: {
+    on: "code",
+    value: "F9"
+  },
+  F10: {
+    on: "code",
+    value: "F10"
+  },
+  F11: {
+    on: "code",
+    value: "F11"
+  },
+  F12: {
+    on: "code",
+    value: "F12"
+  },
+  NumLock: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad0: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad1: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad2: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad3: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad4: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad5: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad6: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad7: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad8: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Numpad9: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadAdd: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadDecimal: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadDivide: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadEnter: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadEqual: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadMultiply: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  NumpadSubtract: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  ArrowDown: {
+    on: "code",
+    value: "ArrowDown"
+  },
+  ArrowLeft: {
+    on: "code",
+    value: "ArrowLeft"
+  },
+  ArrowRight: {
+    on: "code",
+    value: "ArrowRight"
+  },
+  ArrowUp: {
+    on: "code",
+    value: "ArrowUp"
+  },
+  Backquote: {
+    on: "code",
+    value: "Backquote"
+  },
+  Backslash: {
+    on: "code",
+    value: "Backslash"
+  },
+  Backspace: {
+    on: "code",
+    value: "Backspace"
+  },
+  BracketLeft: {
+    on: "code",
+    value: "BracketLeft"
+  },
+  BracketRight: {
+    on: "code",
+    value: "BracketRight"
+  },
+  CapsLock: {
+    on: "code",
+    value: "CapsLock"
+  },
+  Comma: {
+    on: "code",
+    value: "Comma"
+  },
+  Delete: {
+    on: "code",
+    value: "Delete"
+  },
+  End: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Enter: {
+    on: "code",
+    value: "Enter"
+  },
+  Equal: {
+    on: "code",
+    value: "Equal"
+  },
+  Escape: {
+    on: "code",
+    value: "Escape"
+  },
+  Minus: {
+    on: "code",
+    value: "Minus"
+  },
+  Home: {
+    on: "code",
+    value: ""
+    // TODO
+  },
+  PageDown: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  PageUp: {
+    on: "code",
+    value: ""
+    //TODO
+  },
+  Period: {
+    on: "code",
+    value: "Period"
+  },
+  Quote: {
+    on: "code",
+    value: "Quote"
+  },
+  Semicolon: {
+    on: "code",
+    value: "Semicolon"
+  },
+  Slash: {
+    on: "code",
+    value: "Slash"
+  },
+  Space: {
+    on: "code",
+    value: "Space"
+  },
+  Tab: {
+    on: "code",
+    value: "Tab"
+  },
+  KeyZero: {
+    on: "key",
+    value: "0"
+  },
+  KeyOne: {
+    on: "key",
+    value: "1"
+  },
+  KeyTwo: {
+    on: "key",
+    value: "2"
+  },
+  KeyThree: {
+    on: "key",
+    value: "3"
+  },
+  KeyFour: {
+    on: "key",
+    value: "4"
+  },
+  KeyFive: {
+    on: "key",
+    value: "5"
+  },
+  KeySix: {
+    on: "key",
+    value: "6"
+  },
+  KeySeven: {
+    on: "key",
+    value: "7"
+  },
+  KeyEight: {
+    on: "key",
+    value: "8"
+  },
+  KeyNine: {
+    on: "key",
+    value: "9"
+  },
+  KeyA: {
+    on: "key",
+    value: "a"
+  },
+  KeyB: {
+    on: "key",
+    value: "b"
+  },
+  KeyC: {
+    on: "key",
+    value: "c"
+  },
+  KeyD: {
+    on: "key",
+    value: "d"
+  },
+  KeyE: {
+    on: "key",
+    value: "e"
+  },
+  KeyF: {
+    on: "key",
+    value: "f"
+  },
+  KeyG: {
+    on: "key",
+    value: "g"
+  },
+  KeyH: {
+    on: "key",
+    value: "h"
+  },
+  KeyI: {
+    on: "key",
+    value: "i"
+  },
+  KeyJ: {
+    on: "key",
+    value: "j"
+  },
+  KeyK: {
+    on: "key",
+    value: "k"
+  },
+  KeyL: {
+    on: "key",
+    value: "l"
+  },
+  KeyM: {
+    on: "key",
+    value: "m"
+  },
+  KeyN: {
+    on: "key",
+    value: "n"
+  },
+  KeyO: {
+    on: "key",
+    value: "o"
+  },
+  KeyP: {
+    on: "key",
+    value: "p"
+  },
+  KeyQ: {
+    on: "key",
+    value: "q"
+  },
+  KeyR: {
+    on: "key",
+    value: "r"
+  },
+  KeyS: {
+    on: "key",
+    value: "s"
+  },
+  KeyT: {
+    on: "key",
+    value: "t"
+  },
+  KeyU: {
+    on: "key",
+    value: "u"
+  },
+  KeyV: {
+    on: "key",
+    value: "v"
+  },
+  KeyW: {
+    on: "key",
+    value: "w"
+  },
+  KeyX: {
+    on: "key",
+    value: "x"
+  },
+  KeyY: {
+    on: "key",
+    value: "y"
+  },
+  KeyZ: {
+    on: "key",
+    value: "z"
+  },
+  KeyBackquote: {
+    on: "key",
+    value: "`"
+  },
+  KeyBackslash: {
+    on: "key",
+    value: "\\"
+  },
+  KeyBracketLeft: {
+    on: "key",
+    value: "["
+  },
+  KeyBracketRight: {
+    on: "key",
+    value: "]"
+  },
+  KeyComma: {
+    on: "key",
+    value: ","
+  },
+  KeyEqual: {
+    on: "key",
+    value: "="
+  },
+  KeyMinus: {
+    on: "key",
+    value: "-"
+  },
+  KeyPeriod: {
+    on: "key",
+    value: "."
+  },
+  KeyQuote: {
+    on: "key",
+    value: "'"
+  },
+  KeySemicolon: {
+    on: "key",
+    value: ";"
+  },
+  KeySlash: {
+    on: "key",
+    value: "/"
+  }
+};
+export {
+  e as KeyMap
+};

package/dist/definitions/ModifierKeyCodes.d.ts

@@ -0,0 +1,2 @@
+export declare const ALL_MODIFIER_KEY_CODES: readonly ["Meta", "Alt", "Control", "Shift", "Mod"];
+//# sourceMappingURL=ModifierKeyCodes.d.ts.map

package/dist/definitions/ModifierKeyCodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModifierKeyCodes.d.ts","sourceRoot":"","sources":["../../src/lib/definitions/ModifierKeyCodes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,qDAMzB,CAAC"}

package/dist/definitions/ModifierKeyCodes.js

@@ -0,0 +1,10 @@
+const t = [
+  "Meta",
+  "Alt",
+  "Control",
+  "Shift",
+  "Mod"
+];
+export {
+  t as ALL_MODIFIER_KEY_CODES
+};

package/dist/definitions/Sequence.d.ts

@@ -0,0 +1,4 @@
+import { SequenceNode } from '../types/hotkey/sequence/SequenceNode';
+import { PrimaryKey } from '../types/key/PrimaryKey';
+export declare const createHotkeySequenceBuilder: (mods: PrimaryKey[]) => SequenceNode<PrimaryKey>;
+//# sourceMappingURL=Sequence.d.ts.map

package/dist/definitions/Sequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sequence.d.ts","sourceRoot":"","sources":["../../src/lib/definitions/Sequence.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,eAAO,MAAM,2BAA2B,GACtC,MAAM,UAAU,EAAE,KACjB,YAAY,CAAC,UAAU,CAmBK,CAAC"}

package/dist/definitions/Sequence.js

@@ -0,0 +1,15 @@
+const n = (t) => new Proxy(
+  {},
+  {
+    get(r, e) {
+      if (typeof e == "string")
+        return e === "end" ? {
+          type: "sequence",
+          keys: t
+        } : n([...t, e]);
+    }
+  }
+);
+export {
+  n as createHotkeySequenceBuilder
+};

package/dist/hooks/useHotkey.d.ts

@@ -0,0 +1,18 @@
+import { HotKeyDefChordBase } from '../types/hotkey/HotKeyDefChordBase';
+import { HotKeyDefSequenceBase } from '../types/hotkey/HotKeyDefSequenceBase';
+import { HotKeyChordDef } from '../types/hotkey/HotKeyChordDef';
+import { HotKeySequenceDef } from '../types/hotkey/HotKeySequenceDef';
+import { HotkeyCallback } from '../types/hotkey/HotkeyCallback';
+import { HotkeyOptions } from '../types/hotkey/HotkeyOptions';
+type ChordIn = HotKeyDefChordBase;
+type SequenceIn = HotKeyDefSequenceBase;
+type ChordOut = HotKeyChordDef;
+type SequenceOut = HotKeySequenceDef;
+type HotkeyMapping<T extends readonly (ChordIn | SequenceIn)[]> = {
+    [K in keyof T]: T[K] extends ChordIn ? ChordOut : SequenceOut;
+};
+export declare function useHotkey(hotkey: ChordIn, callback: HotkeyCallback, dependencies?: unknown[], options?: Partial<HotkeyOptions>): ChordOut;
+export declare function useHotkey(hotkey: SequenceIn, callback: HotkeyCallback, dependencies?: unknown[], options?: Partial<HotkeyOptions>): SequenceOut;
+export declare function useHotkey<const T extends readonly (ChordIn | SequenceIn)[]>(hotkey: T, callback: HotkeyCallback, dependencies?: unknown[], options?: Partial<HotkeyOptions>): HotkeyMapping<typeof hotkey>;
+export {};
+//# sourceMappingURL=useHotkey.d.ts.map

package/dist/hooks/useHotkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkey.d.ts","sourceRoot":"","sources":["../../src/lib/hooks/useHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAMnE,KAAK,OAAO,GAAG,kBAAkB,CAAC;AAClC,KAAK,UAAU,GAAG,qBAAqB,CAAC;AACxC,KAAK,QAAQ,GAAG,cAAc,CAAC;AAC/B,KAAK,WAAW,GAAG,iBAAiB,CAAC;AAKrC,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,OAAO,GAAG,UAAU,CAAC,EAAE,IAAI;KAC/D,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,GAAG,QAAQ,GAAG,WAAW;CAC9D,CAAC;AAOF,wBAAgB,SAAS,CACvB,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,cAAc,EACxB,YAAY,CAAC,EAAE,OAAO,EAAE,EACxB,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAC/B,QAAQ,CAAC;AACZ,wBAAgB,SAAS,CACvB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,cAAc,EACxB,YAAY,CAAC,EAAE,OAAO,EAAE,EACxB,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAC/B,WAAW,CAAC;AACf,wBAAgB,SAAS,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,OAAO,GAAG,UAAU,CAAC,EAAE,EACzE,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,cAAc,EACxB,YAAY,CAAC,EAAE,OAAO,EAAE,EACxB,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAC/B,aAAa,CAAC,OAAO,MAAM,CAAC,CAAC"}

package/dist/hooks/useHotkey.js

@@ -0,0 +1,66 @@
+import { useLayoutEffect as m, useEffect as c, useContext as l, useId as v, useMemo as y } from "react";
+import { HotkeyContext as H } from "../context/HotkeyContext.js";
+import { KeyMap as p } from "../definitions/KeyMap.js";
+import { isPrimaryKeyCode as C } from "../util/isPrimaryKeyCode.js";
+const x = typeof window < "u" ? m : c;
+function g(r) {
+  return Array.isArray(r);
+}
+function $(r, i, d, f) {
+  const t = l(H), n = v(), u = y(
+    () => ({
+      preventDefault: !0,
+      enableOnContentEditable: !1,
+      disabled: !1,
+      ...f
+    }),
+    [f]
+  ), s = y(() => g(r) ? r.map(
+    (o, e) => o.type === "chord" ? {
+      ...o,
+      options: u,
+      id: `${n}-${e}`,
+      callback: i,
+      toParts: () => [[], ""],
+      toString: () => ""
+    } : {
+      ...o,
+      options: u,
+      id: `${n}-${e}`,
+      callback: i,
+      toParts: () => [
+        o.keys.map(
+          (a) => C(a) ? t?.textResolver.resolve(a) ?? p[a].value : p[a].value
+        ),
+        ""
+      ],
+      toString: () => ""
+    }
+  ) : {
+    ...r,
+    options: u,
+    id: n,
+    callback: i,
+    toParts: () => [[], ""],
+    toString: () => ""
+  }, [u, i, r, t?.textResolver, n]);
+  return x(() => {
+    if (t == null) {
+      console.warn(
+        "No HotkeyContext provided. Use <HotkeyProvider> to provide a HotkeyContext"
+      );
+      return;
+    }
+    const o = Array.isArray(s) ? s : [s];
+    return o.forEach((e) => {
+      e.type === "chord" ? t.registry.addChordHotkey(e) : t.registry.addSequenceHotkey(e);
+    }), () => {
+      o.forEach((e) => {
+        e.type === "chord" ? t.registry.removeChordHotkey(e.id) : t.registry.removeSequenceHotkey(e.id);
+      });
+    };
+  }, [s, ...d || []]), s;
+}
+export {
+  $ as useHotkey
+};

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { HotkeyContext } from './context/HotkeyContext';
+import { HotkeyProvider } from './context/HotkeyProvider';
+import { Hotkey } from './definitions/Hotkey';
+import { useHotkey } from './hooks/useHotkey';
+import { detectOS } from './util/detectOS';
+export { Hotkey, useHotkey, HotkeyContext, HotkeyProvider, detectOS };
+//# sourceMappingURL=index.d.ts.map