react-better-hotkeys 0.2.0 → 0.4.0

package/README.md

@@ -1,4 +1,4 @@
-React Better Hotkeyss
+React Better Hotkeys
 ======================
 
 A tiny, typed helper for registering global hotkeys in React. It supports both **chords** (e.g. `Shift + Alt + A`) and **key sequences** (e.g. `g` then `h`), respects platform-specific modifier keys, and cleans up registrations automatically.

package/dist/HotkeyTextResolver.d.ts

@@ -1,12 +1,27 @@
+import { HotKeyDef } from './types/hotkey/HotKeyDef';
+import { HotKeyType } from './types/hotkey/HotkeyType';
+import { ResolvedKeyStatus } from './types/hotkey/renderer/ResolvedKeyStatus';
 import { PrimaryKeyCode } from './types/key/PrimaryKeyCode';
 export declare class HotkeyTextResolver {
-    symbolMap: Partial<Record<string, string>>;
+    symbolMap: Partial<Record<PrimaryKeyCode, string>>;
+    invalidSymbolMap: Set<PrimaryKeyCode>;
+    chordDelimiter: string;
+    sequnceDelimiter: string;
+    id: number;
     private nextSubscriberId;
     private subscribers;
-    constructor(symbolMap?: Partial<Record<PrimaryKeyCode, string>>);
+    constructor(symbolMap?: Partial<Record<PrimaryKeyCode, string>>, chordDelimiter?: string, sequenceDelimiter?: string);
+    private insertCustomMap;
+    private stringifyState;
+    private buildInitialMap;
+    private parseState;
+    private storeState;
+    private loadState;
     setSymbol(code: string, symbol: string): void;
-    resolve(code: PrimaryKeyCode): string;
+    resolve(code: PrimaryKeyCode): [string, ResolvedKeyStatus] | undefined;
     subscribe(code: PrimaryKeyCode, callback: (newSymbol: string) => void): () => void;
     unsubscribe(code: PrimaryKeyCode, subscriberId: number): void;
+    delimiterForType(type: HotKeyType): string;
+    toString(hotkey: HotKeyDef): string;
 }
 //# sourceMappingURL=HotkeyTextResolver.d.ts.map

package/dist/HotkeyTextResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeyTextResolver.d.ts","sourceRoot":"","sources":["../src/lib/HotkeyTextResolver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAOjE,qBAAa,kBAAkB;IAC7B,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAM;IAEhD,OAAO,CAAC,gBAAgB,CAAK;IAE7B,OAAO,CAAC,WAAW,CAEZ;gBAEK,SAAS,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAiBxD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IActC,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM;IAKrC,SAAS,CACd,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GACpC,MAAM,IAAI;IAmBN,WAAW,CAAC,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;CAUrE"}
+{"version":3,"file":"HotkeyTextResolver.d.ts","sourceRoot":"","sources":["../src/lib/HotkeyTextResolver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAcjE,qBAAa,kBAAkB;IAC7B,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAM;IACxD,gBAAgB,EAAE,GAAG,CAAC,cAAc,CAAC,CAAa;IAElD,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,EAAE,EAAE,MAAM,CAAiB;IAE3B,OAAO,CAAC,gBAAgB,CAAK;IAE7B,OAAO,CAAC,WAAW,CAEZ;gBAGL,SAAS,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,EACnD,cAAc,CAAC,EAAE,MAAM,EACvB,iBAAiB,CAAC,EAAE,MAAM;IAW5B,OAAO,CAAC,eAAe;IAiBvB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,SAAS;IAUV,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAiCtC,OAAO,CACZ,IAAI,EAAE,cAAc,GACnB,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS;IAOnC,SAAS,CACd,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GACpC,MAAM,IAAI;IAcN,WAAW,CAAC,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAW7D,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAK1C,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;CAI3C"}

package/dist/HotkeyTextResolver.js

@@ -1,45 +1,95 @@
-import { KeyMap as b } from "./definitions/KeyMap.js";
-class o {
+import { KeyMap as a } from "./definitions/KeyMap.js";
+const o = "rbh-symbols-cache";
+class c {
   symbolMap = {};
+  invalidSymbolMap = /* @__PURE__ */ new Set();
+  chordDelimiter;
+  sequnceDelimiter;
+  id = Math.random();
   nextSubscriberId = 0;
   subscribers = {};
-  constructor(s) {
-    const e = Object.entries(b).reduce(
-      (t, r) => {
-        if (r[1].on === "key") {
-          const i = r[0].slice(3);
-          t[i] = r[1].value.match(/[a-z]/) ? r[1].value.toUpperCase() : r[1].value;
+  constructor(t, e, s) {
+    this.chordDelimiter = e ?? "+", this.sequnceDelimiter = s ?? ">", this.loadState() || (this.symbolMap = { ...this.buildInitialMap() }), t && this.insertCustomMap(t);
+  }
+  insertCustomMap(t) {
+    let e = [];
+    for (const [s, i] of Object.entries(t))
+      this.symbolMap[s] !== i && (this.symbolMap[s] = i.length === 1 ? i.toLocaleUpperCase() : i, e.push(s));
+    e.length > 0 && this.storeState(e);
+  }
+  stringifyState() {
+    return JSON.stringify({
+      symbolMap: this.symbolMap,
+      invalidSymbolMap: Array.from(this.invalidSymbolMap)
+    });
+  }
+  buildInitialMap() {
+    return {
+      ...Object.entries(a).reduce((t, e) => (e[1].on === "code" && (t[e[0]] = e[1].value.length === 1 ? e[1].value.toUpperCase() : e[1].value), t), {}),
+      ...Object.entries(a).reduce((t, e) => {
+        if (e[1].on === "key") {
+          const s = e[0].slice(3);
+          t[s] = e[1].value.length === 1 ? e[1].value.toUpperCase() : e[1].value;
         }
         return t;
-      },
-      {}
+      }, {})
+    };
+  }
+  parseState(t) {
+    this.symbolMap = t.symbolMap, this.invalidSymbolMap = new Set(t.invalidSymbolMap);
+  }
+  storeState(t) {
+    for (const e of t) this.invalidSymbolMap.delete(e);
+    localStorage.setItem(o, this.stringifyState());
+  }
+  loadState() {
+    const t = localStorage.getItem(o);
+    if (t) {
+      const e = JSON.parse(t);
+      return this.parseState(e), !0;
+    }
+    return !1;
+  }
+  setSymbol(t, e) {
+    const s = Object.entries(a).find(
+      (r) => r[1].on === "code" && r[1].value === t
+    );
+    if (s == null)
+      return;
+    const i = s[0];
+    if (this.symbolMap[i] === e) return;
+    this.symbolMap[i] = e.length === 1 ? e.toLocaleUpperCase() : e;
+    const n = Object.entries(this.symbolMap).find(
+      ([r, b]) => r !== i && b === this.symbolMap[i]
     );
-    console.log(e), this.symbolMap = { ...e, ...s };
-  }
-  setSymbol(s, e) {
-    if (this.symbolMap[s] === e) return;
-    this.symbolMap[s] = e;
-    const r = this.subscribers[s];
-    if (r)
-      for (const i of r.values())
-        i.callback(e);
-  }
-  resolve(s) {
-    return console.log("resolve", s, this.symbolMap[s] ?? b[s].value), this.symbolMap[s] ?? b[s].value;
-  }
-  subscribe(s, e) {
-    const t = this.nextSubscriberId++;
-    this.subscribers[s] || (this.subscribers[s] = /* @__PURE__ */ new Map()), this.subscribers[s].set(t, { id: t, callback: e });
-    const r = this.symbolMap[s];
-    return r !== void 0 && e(r), () => {
-      this.unsubscribe(s, t);
+    n && this.invalidSymbolMap.add(n[0]), this.storeState([i]);
+    const l = this.subscribers[i];
+    if (l)
+      for (const r of l.values())
+        r.callback(e);
+  }
+  resolve(t) {
+    const e = this.symbolMap[t];
+    return e != null ? [e, this.invalidSymbolMap.has(t) ? "invalid" : "valid"] : void 0;
+  }
+  subscribe(t, e) {
+    const s = this.nextSubscriberId++;
+    return this.subscribers[t] || (this.subscribers[t] = /* @__PURE__ */ new Map()), this.subscribers[t].set(s, { id: s, callback: e }), () => {
+      this.unsubscribe(t, s);
     };
   }
-  unsubscribe(s, e) {
-    const t = this.subscribers[s];
-    t && (t.delete(e), t.size === 0 && Reflect.deleteProperty(this.subscribe, s));
+  unsubscribe(t, e) {
+    const s = this.subscribers[t];
+    s && (s.delete(e), s.size === 0 && Reflect.deleteProperty(this.subscribe, t));
+  }
+  delimiterForType(t) {
+    return t === "chord" ? this.chordDelimiter : this.sequnceDelimiter;
+  }
+  toString(t) {
+    const e = t.toParts();
+    return e[0].map((s) => s[0]).join(e[1]);
   }
 }
 export {
-  o as HotkeyTextResolver
+  c as HotkeyTextResolver
 };

package/dist/context/HotkeyProvider.d.ts

@@ -1,4 +1,4 @@
 import { PropsWithChildren } from 'react';
 import { HotkeyProviderProps } from '../types/hotkey/provider/HotkeyProviderProps';
-export declare function HotkeyProvider({ children, sequenceTimeout, chordTimeout, }: PropsWithChildren<HotkeyProviderProps>): import("react/jsx-runtime").JSX.Element;
+export declare function HotkeyProvider({ children, sequenceTimeout, chordTimeout, sequenceDelimiter, chordDelimiter, customSymbolMap, }: PropsWithChildren<HotkeyProviderProps>): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=HotkeyProvider.d.ts.map

package/dist/context/HotkeyProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeyProvider.d.ts","sourceRoot":"","sources":["../../src/lib/context/HotkeyProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAI/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAGxF,wBAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,eAAe,EACf,YAAY,GACb,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,2CA6BxC"}
+{"version":3,"file":"HotkeyProvider.d.ts","sourceRoot":"","sources":["../../src/lib/context/HotkeyProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAK/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAGxF,wBAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,2CAoCxC"}

package/dist/context/HotkeyProvider.js

@@ -1,31 +1,35 @@
-import { jsx as u } from "react/jsx-runtime";
-import { useContext as v, useState as s, useEffect as a } from "react";
-import { HotkeyContext as d } from "./HotkeyContext.js";
-import { HotkeyRegistry as l } from "../HotkeyRegistry.js";
-import { HotkeyTextResolver as f } from "../HotkeyTextResolver.js";
-function K({
-  children: y,
+import { jsx as p } from "react/jsx-runtime";
+import { useContext as a, useState as c, useEffect as f } from "react";
+import { HotkeyContext as n } from "./HotkeyContext.js";
+import { HotkeyRegistry as k } from "../HotkeyRegistry.js";
+import { HotkeyTextResolver as l } from "../HotkeyTextResolver.js";
+function H({
+  children: s,
   sequenceTimeout: i,
-  chordTimeout: m
+  chordTimeout: y,
+  sequenceDelimiter: d,
+  chordDelimiter: m,
+  customSymbolMap: u
 }) {
-  const p = v(d), [o] = s(
-    p?.textResolver ?? new f()
-  ), [e] = s(
-    new l(i, m, o)
-  );
-  return a(() => {
-    const n = (t) => e.handleKeydown(t), r = (t) => e.handleKeyup(t);
-    return addEventListener("keydown", n), addEventListener("keyup", r), () => {
-      removeEventListener("keydown", n), removeEventListener("keyup", r);
+  const v = a(n), [t] = c(() => {
+    const e = v?.textResolver ?? new l(
+      u,
+      m,
+      d
+    );
+    return { registry: new k(
+      i,
+      y,
+      e
+    ), textResolver: e };
+  });
+  return f(() => {
+    const e = (o) => t.registry.handleKeydown(o), r = (o) => t.registry.handleKeyup(o);
+    return addEventListener("keydown", e), addEventListener("keyup", r), () => {
+      removeEventListener("keydown", e), removeEventListener("keyup", r);
     };
-  }, [e, e.handleKeydown, e.handleKeyup]), /* @__PURE__ */ u(
-    d.Provider,
-    {
-      value: { registry: e, textResolver: o },
-      children: y
-    }
-  );
+  }, [t.registry]), /* @__PURE__ */ p(n.Provider, { value: t, children: s });
 }
 export {
-  K as HotkeyProvider
+  H as HotkeyProvider
 };

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

@@ -1 +1 @@
-{"version":3,"file":"Chord.d.ts","sourceRoot":"","sources":["../../src/lib/definitions/Chord.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAGpE,eAAO,MAAM,wBAAwB,GACnC,MAAM,eAAe,EAAE,KACtB,SAAS,CAAC,eAAe,EAAE,cAAc,GAAG,eAAe,CAkCK,CAAC"}
+{"version":3,"file":"Chord.d.ts","sourceRoot":"","sources":["../../src/lib/definitions/Chord.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAIpE,eAAO,MAAM,wBAAwB,GACnC,MAAM,eAAe,EAAE,KACtB,SAAS,CAAC,eAAe,EAAE,cAAc,GAAG,eAAe,CAoCK,CAAC"}

package/dist/definitions/Chord.js

@@ -1,32 +1,33 @@
-import { detectOS as i } from "../util/detectOS.js";
-import { ALL_MODIFIER_KEY_CODES as n } from "./ModifierKeyCodes.js";
-import { KeyMap as a } from "./KeyMap.js";
-const l = (r) => new Proxy(
+import { detectOS as n } from "../util/detectOS.js";
+import { ALL_MODIFIER_KEY_CODES as a } from "./ModifierKeyCodes.js";
+import { KeyMap as l } from "./KeyMap.js";
+const s = (r) => new Proxy(
   {},
   {
-    get(s, e) {
+    get(c, e) {
       if (typeof e == "string") {
-        if (n.indexOf(e) === -1) {
-          const o = a[e], t = {
-            Meta: !1,
+        if (a.indexOf(e) === -1) {
+          const o = e, f = l[o], t = {
+            Shift: !1,
             Alt: !1,
             Control: !1,
-            Shift: !1
+            Meta: !1
           };
-          return r.forEach((f) => {
-            f === "Mod" ? t[i() === "macOS" ? "Meta" : "Control"] = !0 : t[f] = !0;
+          return r.forEach((i) => {
+            i === "Mod" ? t[n() === "macOS" ? "Meta" : "Control"] = !0 : t[i] = !0;
           }), {
             type: "chord",
             modifier: t,
-            resolve: o.on,
-            primaryValue: o.value
+            keyId: o,
+            resolve: f.on,
+            primaryValue: f.value
           };
         }
-        return l([...r, e]);
+        return s([...r, e]);
       }
     }
   }
 );
 export {
-  l as createHotkeyChordBuilder
+  s as createHotkeyChordBuilder
 };

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

@@ -1 +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"}
+{"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;AAenE,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

@@ -1,66 +1,79 @@
-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);
+import { useLayoutEffect as C, useEffect as H, useContext as g, useId as R, useMemo as m, useCallback as c } from "react";
+import { HotkeyContext as S } from "../context/HotkeyContext.js";
+import { KeyMap as x } from "../definitions/KeyMap.js";
+import { isPrimaryKeyCode as E } from "../util/isPrimaryKeyCode.js";
+const w = typeof window < "u" ? C : H;
+function A(o) {
+  return Array.isArray(o);
 }
-function $(r, i, d, f) {
-  const t = l(H), n = v(), u = y(
+function q(o, y, p, v) {
+  const r = g(S), n = R(), a = m(
     () => ({
       preventDefault: !0,
       enableOnContentEditable: !1,
       disabled: !1,
-      ...f
+      ...v
     }),
-    [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) {
+    [v]
+  ), d = c(
+    (e) => E(e) ? r?.textResolver.resolve(e) ?? [
+      x[`Key${e}`].value,
+      "unknown"
+    ] : [x[e].value, "unknown"],
+    [r?.textResolver]
+  ), l = c(
+    (e, t) => {
+      const i = {
+        ...e,
+        options: a,
+        id: t == null ? n : `${n}-${t}`,
+        callback: y,
+        toParts: () => [
+          e.keys.map((u) => d(u)),
+          r?.textResolver.delimiterForType(e.type) ?? ""
+        ],
+        toString: () => r?.textResolver.toString(i) ?? ""
+      };
+      return i;
+    },
+    [a, y, r?.textResolver, n, d]
+  ), f = c(
+    (e, t) => {
+      const i = {
+        ...e,
+        options: a,
+        id: t == null ? n : `${n}-${t}`,
+        callback: y,
+        toParts: () => [
+          [
+            ...Object.entries(e.modifier).filter((u) => u[1]).map((u) => [u[0], "valid"]),
+            d(e.keyId)
+          ],
+          r?.textResolver.delimiterForType(e.type) ?? ""
+        ],
+        toString: () => r?.textResolver.toString(i) ?? ""
+      };
+      return i;
+    },
+    [a, y, r?.textResolver, n, d]
+  ), s = m(() => A(o) ? o.map((e, t) => e.type === "chord" ? f(e, t) : l(e, t)) : o.type === "chord" ? f(o) : l(o), [f, l, o]);
+  return w(() => {
+    if (r == 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);
+    const e = Array.isArray(s) ? s : [s];
+    return e.forEach((t) => {
+      t.type === "chord" ? r.registry.addChordHotkey(t) : r.registry.addSequenceHotkey(t);
     }), () => {
-      o.forEach((e) => {
-        e.type === "chord" ? t.registry.removeChordHotkey(e.id) : t.registry.removeSequenceHotkey(e.id);
+      e.forEach((t) => {
+        t.type === "chord" ? r.registry.removeChordHotkey(t.id) : r.registry.removeSequenceHotkey(t.id);
       });
     };
-  }, [s, ...d || []]), s;
+  }, [s, ...p || []]), s;
 }
 export {
-  $ as useHotkey
+  q as useHotkey
 };

package/dist/hooks/useRenderedHotkey.d.ts

@@ -0,0 +1,7 @@
+import { HotKeyDef } from '../types/hotkey/HotKeyDef';
+import { HotkeyTextParts } from '../types/hotkey/HotkeyTextParts';
+export declare function useRenderedHotkey(hotkey: HotKeyDef): {
+    asString: string;
+    asParts: HotkeyTextParts;
+};
+//# sourceMappingURL=useRenderedHotkey.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRenderedHotkey.d.ts","sourceRoot":"","sources":["../../src/lib/hooks/useRenderedHotkey.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAG3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAEvE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS;cAIrC,MAAM;aACP,eAAe;EAiC3B"}

package/dist/hooks/useRenderedHotkey.js

@@ -0,0 +1,31 @@
+import { useContext as a, useState as u, useEffect as c } from "react";
+import { HotkeyContext as d } from "../context/HotkeyContext.js";
+import { toPrimaryKeyCode as o } from "../util/toPrimaryKeyCode.js";
+function P(r) {
+  const t = a(d), [i, n] = u({
+    asString: r.toString(),
+    asParts: r.toParts()
+  });
+  return c(() => {
+    if (t == null) return;
+    let e;
+    return r.type === "chord" ? e = [
+      t.textResolver.subscribe(o(r.keyId), () => {
+        n({
+          asParts: r.toParts(),
+          asString: r.toString()
+        });
+      })
+    ] : e = r.keys.map(
+      (s) => t.textResolver.subscribe(o(s), () => {
+        n({
+          asParts: r.toParts(),
+          asString: r.toString()
+        });
+      })
+    ), () => e.forEach((s) => s());
+  }, [t, r]), i;
+}
+export {
+  P as useRenderedHotkey
+};

package/dist/index.d.ts

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

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EACL,MAAM,EACN,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,QAAQ,GACT,CAAC"}

package/dist/index.js

@@ -1,12 +1,14 @@
-import { HotkeyContext as t } from "./context/HotkeyContext.js";
+import { HotkeyContext as r } from "./context/HotkeyContext.js";
 import { HotkeyProvider as x } from "./context/HotkeyProvider.js";
 import { Hotkey as m } from "./definitions/Hotkey.js";
 import { useHotkey as k } from "./hooks/useHotkey.js";
-import { detectOS as H } from "./util/detectOS.js";
+import { useRenderedHotkey as H } from "./hooks/useRenderedHotkey.js";
+import { detectOS as n } from "./util/detectOS.js";
 export {
   m as Hotkey,
-  t as HotkeyContext,
+  r as HotkeyContext,
   x as HotkeyProvider,
-  H as detectOS,
-  k as useHotkey
+  n as detectOS,
+  k as useHotkey,
+  H as useRenderedHotkey
 };

package/dist/types/hotkey/HotKeyDefChordBase.d.ts

@@ -1,8 +1,10 @@
 import { KeyValueType } from '../key/KeyValueType';
 import { ModifierKeyCode } from '../key/ModifierKeyCode';
+import { PrimaryKey } from '../key/PrimaryKey';
 export type HotKeyDefChordBase = {
     type: "chord";
     resolve: KeyValueType;
+    keyId: PrimaryKey;
     primaryValue: string;
     modifier: Record<Exclude<ModifierKeyCode, "Mod">, boolean>;
 };

package/dist/types/hotkey/HotKeyDefChordBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HotKeyDefChordBase.d.ts","sourceRoot":"","sources":["../../../src/lib/types/hotkey/HotKeyDefChordBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,YAAY,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;CAC5D,CAAC"}
+{"version":3,"file":"HotKeyDefChordBase.d.ts","sourceRoot":"","sources":["../../../src/lib/types/hotkey/HotKeyDefChordBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,YAAY,CAAC;IACtB,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;CAC5D,CAAC"}

package/dist/types/hotkey/HotkeyTextParts.d.ts

@@ -1,2 +1,3 @@
-export type HotkeyTextParts = [string[], string];
+import { ResolvedKeyStatus } from './renderer/ResolvedKeyStatus';
+export type HotkeyTextParts = [[string, ResolvedKeyStatus][], string];
 //# sourceMappingURL=HotkeyTextParts.d.ts.map

package/dist/types/hotkey/HotkeyTextParts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeyTextParts.d.ts","sourceRoot":"","sources":["../../../src/lib/types/hotkey/HotkeyTextParts.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC"}
+{"version":3,"file":"HotkeyTextParts.d.ts","sourceRoot":"","sources":["../../../src/lib/types/hotkey/HotkeyTextParts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC"}

package/dist/types/hotkey/provider/HotkeyProviderProps.d.ts

@@ -1,3 +1,4 @@
+import { PrimaryKeyCode } from '../../key/PrimaryKeyCode';
 /**
  * All options regarding an entire hotkey scope
  */
@@ -12,5 +13,20 @@ export type HotkeyProviderProps = {
      * @default 100
      */
     chordTimeout?: number;
+    /**
+     * Defines what string will be used in stringified sequence hotkeys
+     * @default ">"
+     */
+    sequenceDelimiter?: string;
+    /**
+     * Defines what string will be used in stringified chord hotkeys
+     * @default "+"
+     */
+    chordDelimiter?: string;
+    /**
+     * Defines custom key code mappings for text representation of hotkey for alternative keyboard layouts. (e.g. German: KeyY -> Z)
+     * @default undefined
+     */
+    customSymbolMap?: Partial<Record<PrimaryKeyCode, string>>;
 };
 //# sourceMappingURL=HotkeyProviderProps.d.ts.map

package/dist/types/hotkey/provider/HotkeyProviderProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HotkeyProviderProps.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/hotkey/provider/HotkeyProviderProps.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}
+{"version":3,"file":"HotkeyProviderProps.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/hotkey/provider/HotkeyProviderProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;CAC3D,CAAC"}

package/dist/types/hotkey/renderer/ResolvedKeyStatus.d.ts

@@ -0,0 +1,2 @@
+export type ResolvedKeyStatus = "invalid" | "valid" | "unknown";
+//# sourceMappingURL=ResolvedKeyStatus.d.ts.map

package/dist/types/hotkey/renderer/ResolvedKeyStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolvedKeyStatus.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/hotkey/renderer/ResolvedKeyStatus.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC"}

package/dist/util/toPrimaryKeyCode.d.ts

@@ -0,0 +1,4 @@
+import { PrimaryKey } from '../types/key/PrimaryKey';
+import { PrimaryKeyCode } from '../types/key/PrimaryKeyCode';
+export declare function toPrimaryKeyCode(keyId: PrimaryKey): PrimaryKeyCode;
+//# sourceMappingURL=toPrimaryKeyCode.d.ts.map

package/dist/util/toPrimaryKeyCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toPrimaryKeyCode.d.ts","sourceRoot":"","sources":["../../src/lib/util/toPrimaryKeyCode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAGlE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,cAAc,CAElE"}

package/dist/util/toPrimaryKeyCode.js

@@ -0,0 +1,7 @@
+import { isPrimaryKeyCode as o } from "./isPrimaryKeyCode.js";
+function e(r) {
+  return o(r) ? r : r.slice(3);
+}
+export {
+  e as toPrimaryKeyCode
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-better-hotkeys",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "author": "Christopher Haindl",
   "repository": {