@tanstack/hotkeys-devtools 0.9.0 → 1.0.0

package/README.md

@@ -1,5 +1,19 @@
 <div align="center">
-  <img src="./media/header_hotkeys.png" alt="TanStack Hotkeys" />
+  <picture>
+    <source
+      media="(prefers-color-scheme: dark)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png?theme=dark"
+    />
+    <source
+      media="(prefers-color-scheme: light)"
+      srcset="https://tanstack.com/api/readme/hotkeys.png"
+    />
+    <img
+      src="https://tanstack.com/api/readme/hotkeys.png"
+      alt="TanStack Hotkeys"
+      width="900"
+    />
+  </picture>
 </div>
 
 <br />

package/dist/_registrations.js

@@ -0,0 +1,48 @@
+import { useHotkeysDevtoolsState } from "./HotkeysContextProvider.js";
+import { createMemo } from "solid-js";
+import { findHotkeyConflicts, formatForDisplay, parseHotkey } from "@tanstack/hotkeys";
+
+//#region src/_registrations.ts
+/** Refresh shared conflict reporting when either registry changes. */
+function useRegistrationConflicts(registration) {
+	const state = useHotkeysDevtoolsState();
+	return createMemo(() => {
+		state.registrations();
+		state.sequenceRegistrations();
+		const reg = registration();
+		if (reg.options.enabled === false) return {
+			overlapping: [],
+			separate: []
+		};
+		const binding = "sequence" in reg ? reg.sequence : reg.hotkey;
+		const options = {
+			target: reg.target,
+			platform: reg.options.platform,
+			eventType: reg.options.eventType,
+			excludeIds: [reg.id]
+		};
+		const overlapping = findHotkeyConflicts(binding, options).map((c) => c.registration);
+		const ids = new Set(overlapping.map((r) => r.id));
+		return {
+			overlapping,
+			separate: findHotkeyConflicts(binding, {
+				...options,
+				scope: "all"
+			}).map((c) => c.registration).filter((r) => !ids.has(r.id))
+		};
+	});
+}
+/** Format either kind of registration, respecting its platform and physical labels. */
+function formatRegistration(reg) {
+	return ("sequence" in reg ? reg.sequence : [reg.hotkey]).map((step) => formatForDisplay(step, { platform: reg.options.platform })).join(" → ");
+}
+/** Sequences may mix logical keys and physical codes, so report both when needed. */
+function getBindingKind(reg) {
+	const parsed = "sequence" in reg ? reg.sequence.map((step) => parseHotkey(step, reg.options.platform)) : [reg.parsedHotkey];
+	const codes = parsed.filter((step) => step.code !== void 0).length;
+	return codes === 0 ? "Key" : codes === parsed.length ? "Code" : "Mixed";
+}
+
+//#endregion
+export { formatRegistration, getBindingKind, useRegistrationConflicts };
+//# sourceMappingURL=_registrations.js.map

package/dist/_registrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_registrations.js","names":[],"sources":["../src/_registrations.ts"],"sourcesContent":["import { createMemo } from 'solid-js'\nimport {\n  findHotkeyConflicts,\n  formatForDisplay,\n  parseHotkey,\n} from '@tanstack/hotkeys'\nimport { useHotkeysDevtoolsState } from './HotkeysContextProvider'\nimport type { HotkeyConflict } from '@tanstack/hotkeys'\n\n/** Refresh shared conflict reporting when either registry changes. */\nexport function useRegistrationConflicts(\n  registration: () => HotkeyConflict['registration'],\n) {\n  const state = useHotkeysDevtoolsState()\n  return createMemo(() => {\n    state.registrations()\n    state.sequenceRegistrations()\n    const reg = registration()\n    if (reg.options.enabled === false) return { overlapping: [], separate: [] }\n    const binding = 'sequence' in reg ? reg.sequence : reg.hotkey\n    const options = {\n      target: reg.target,\n      platform: reg.options.platform,\n      eventType: reg.options.eventType,\n      excludeIds: [reg.id],\n    }\n    const overlapping = findHotkeyConflicts(binding, options).map(\n      (c) => c.registration,\n    )\n    const ids = new Set(overlapping.map((r) => r.id))\n    const separate = findHotkeyConflicts(binding, { ...options, scope: 'all' })\n      .map((c) => c.registration)\n      .filter((r) => !ids.has(r.id))\n    // Without source events, key/code overlap depends on the layout and cannot be inferred.\n    return { overlapping, separate }\n  })\n}\n\n/** Format either kind of registration, respecting its platform and physical labels. */\nexport function formatRegistration(\n  reg: HotkeyConflict['registration'],\n): string {\n  const steps = 'sequence' in reg ? reg.sequence : [reg.hotkey]\n  return steps\n    .map((step) => formatForDisplay(step, { platform: reg.options.platform }))\n    .join(' → ')\n}\n\n/** Sequences may mix logical keys and physical codes, so report both when needed. */\nexport function getBindingKind(\n  reg: HotkeyConflict['registration'],\n): 'Key' | 'Code' | 'Mixed' {\n  const parsed =\n    'sequence' in reg\n      ? reg.sequence.map((step) => parseHotkey(step, reg.options.platform))\n      : [reg.parsedHotkey]\n  const codes = parsed.filter((step) => step.code !== undefined).length\n  return codes === 0 ? 'Key' : codes === parsed.length ? 'Code' : 'Mixed'\n}\n"],"mappings":";;;;;;AAUA,SAAgB,yBACd,cACA;CACA,MAAM,QAAQ,yBAAyB;AACvC,QAAO,iBAAiB;AACtB,QAAM,eAAe;AACrB,QAAM,uBAAuB;EAC7B,MAAM,MAAM,cAAc;AAC1B,MAAI,IAAI,QAAQ,YAAY,MAAO,QAAO;GAAE,aAAa,EAAE;GAAE,UAAU,EAAE;GAAE;EAC3E,MAAM,UAAU,cAAc,MAAM,IAAI,WAAW,IAAI;EACvD,MAAM,UAAU;GACd,QAAQ,IAAI;GACZ,UAAU,IAAI,QAAQ;GACtB,WAAW,IAAI,QAAQ;GACvB,YAAY,CAAC,IAAI,GAAG;GACrB;EACD,MAAM,cAAc,oBAAoB,SAAS,QAAQ,CAAC,KACvD,MAAM,EAAE,aACV;EACD,MAAM,MAAM,IAAI,IAAI,YAAY,KAAK,MAAM,EAAE,GAAG,CAAC;AAKjD,SAAO;GAAE;GAAa,UAJL,oBAAoB,SAAS;IAAE,GAAG;IAAS,OAAO;IAAO,CAAC,CACxE,KAAK,MAAM,EAAE,aAAa,CAC1B,QAAQ,MAAM,CAAC,IAAI,IAAI,EAAE,GAAG,CAAC;GAEA;GAChC;;;AAIJ,SAAgB,mBACd,KACQ;AAER,SADc,cAAc,MAAM,IAAI,WAAW,CAAC,IAAI,OAAO,EAE1D,KAAK,SAAS,iBAAiB,MAAM,EAAE,UAAU,IAAI,QAAQ,UAAU,CAAC,CAAC,CACzE,KAAK,MAAM;;;AAIhB,SAAgB,eACd,KAC0B;CAC1B,MAAM,SACJ,cAAc,MACV,IAAI,SAAS,KAAK,SAAS,YAAY,MAAM,IAAI,QAAQ,SAAS,CAAC,GACnE,CAAC,IAAI,aAAa;CACxB,MAAM,QAAQ,OAAO,QAAQ,SAAS,KAAK,SAAS,OAAU,CAAC;AAC/D,QAAO,UAAU,IAAI,QAAQ,UAAU,OAAO,SAAS,SAAS"}