browser-shortcuts 0.1.0

package/dist/vue.d.cts

@@ -0,0 +1,101 @@
+import { InjectionKey, App } from 'vue';
+
+declare const KEYBINDS: {
+    'CTRL+SHIFT+F': "toggleFullScreen";
+    'CMD+SHIFT+F': "toggleFullScreen";
+    'CTRL+SHIFT+G': "toggleGrid";
+    'CMD+SHIFT+G': "toggleGrid";
+    'CTRL+SHIFT+H': "toggleHelp";
+    'CMD+SHIFT+H': "toggleHelp";
+    ESCAPE: "closeOverlay";
+    'CTRL+Z': "undo";
+    'CMD+Z': "undo";
+    'CTRL+SHIFT+Z': "redo";
+    'CMD+SHIFT+Z': "redo";
+    'CTRL+Y': "redo";
+    DELETE: "delete";
+    BACKSPACE: "delete";
+    'CTRL+A': "selectAll";
+    'CMD+A': "selectAll";
+    'CTRL+C': "copy";
+    'CMD+C': "copy";
+    'CTRL+V': "paste";
+    'CMD+V': "paste";
+    'CTRL+S': "save";
+    'CMD+S': "save";
+    DOUBLE_LEFT_BUTTON: "zoomIn";
+    LEFT_BUTTON: "leftMouseButton";
+    MIDDLE_BUTTON: "middleMouseButton";
+    RIGHT_BUTTON: "rightMouseButton";
+};
+/** A key combination string understood by {@link KEYBINDS}, e.g. `"CTRL+SHIFT+F"`. */
+type Keybind = keyof typeof KEYBINDS;
+
+/** Callback invoked when a bound shortcut fires. */
+type ShortcutListener = (event: Event) => void;
+/**
+ * Framework-agnostic keyboard, mouse and wheel shortcut dispatcher.
+ *
+ * Listens for the most commonly used input events (`keydown`, `keyup`,
+ * `mousedown`, `mouseup`, `dblclick`, `contextmenu` and `wheel`) on a target
+ * (`window` by default), converts each into a {@link Keybind} string, and
+ * dispatches it to any listeners registered with {@link on} as well as the
+ * static bindings declared in `KEYBINDS`.
+ *
+ * Every framework adapter in this package (React, Vue, Svelte, Angular,
+ * Solid, Preact) wraps a single instance of this class in that framework's
+ * own idioms (context/provider, composable, store, service, etc.).
+ */
+declare class ShortcutsManager {
+    private listeners;
+    private target;
+    private cleanup;
+    /** Registers `callback` to run whenever `shortcut` is triggered. */
+    on: (shortcut: Keybind, callback: ShortcutListener) => void;
+    /** Removes a `callback` previously registered with {@link on}. */
+    off: (shortcut: Keybind, callback: ShortcutListener) => void;
+    private emit;
+    private triggerShortcut;
+    /**
+     * Starts listening on `target` (`window` by default). Returns a disposer
+     * that removes the listeners; safe to call multiple times.
+     */
+    attach: (target?: EventTarget) => (() => void);
+    /** Stops listening. Safe to call even if {@link attach} was never called. */
+    detach: () => void;
+}
+
+declare const ShortcutsInjectionKey: InjectionKey<ShortcutsManager>;
+/**
+ * Vue plugin that installs a single {@link ShortcutsManager} for the whole
+ * app and attaches its listeners for the app's lifetime.
+ *
+ * @example
+ * ```ts
+ * import { createApp } from 'vue';
+ * import { ShortcutsPlugin } from 'browser-shortcuts/vue';
+ *
+ * createApp(App).use(ShortcutsPlugin).mount('#app');
+ * ```
+ */
+declare const ShortcutsPlugin: {
+    install(app: App): void;
+};
+/**
+ * Returns the app-wide {@link ShortcutsManager}. If the plugin was not
+ * installed (e.g. in a component test), a local instance is created and
+ * attached/detached with the component's lifecycle.
+ */
+declare function useShortcutsManager(): ShortcutsManager;
+/**
+ * Subscribes `callback` to `shortcut` for as long as the calling component
+ * is mounted.
+ *
+ * @example
+ * ```ts
+ * useShortcut('CTRL+SHIFT+F', () => (fullScreen.value = !fullScreen.value));
+ * ```
+ */
+declare function useShortcut(shortcut: Keybind, callback: ShortcutListener): void;
+
+export { type ShortcutListener, ShortcutsInjectionKey, ShortcutsPlugin, useShortcut, useShortcutsManager };

package/dist/vue.d.ts

@@ -0,0 +1,101 @@
+import { InjectionKey, App } from 'vue';
+
+declare const KEYBINDS: {
+    'CTRL+SHIFT+F': "toggleFullScreen";
+    'CMD+SHIFT+F': "toggleFullScreen";
+    'CTRL+SHIFT+G': "toggleGrid";
+    'CMD+SHIFT+G': "toggleGrid";
+    'CTRL+SHIFT+H': "toggleHelp";
+    'CMD+SHIFT+H': "toggleHelp";
+    ESCAPE: "closeOverlay";
+    'CTRL+Z': "undo";
+    'CMD+Z': "undo";
+    'CTRL+SHIFT+Z': "redo";
+    'CMD+SHIFT+Z': "redo";
+    'CTRL+Y': "redo";
+    DELETE: "delete";
+    BACKSPACE: "delete";
+    'CTRL+A': "selectAll";
+    'CMD+A': "selectAll";
+    'CTRL+C': "copy";
+    'CMD+C': "copy";
+    'CTRL+V': "paste";
+    'CMD+V': "paste";
+    'CTRL+S': "save";
+    'CMD+S': "save";
+    DOUBLE_LEFT_BUTTON: "zoomIn";
+    LEFT_BUTTON: "leftMouseButton";
+    MIDDLE_BUTTON: "middleMouseButton";
+    RIGHT_BUTTON: "rightMouseButton";
+};
+/** A key combination string understood by {@link KEYBINDS}, e.g. `"CTRL+SHIFT+F"`. */
+type Keybind = keyof typeof KEYBINDS;
+
+/** Callback invoked when a bound shortcut fires. */
+type ShortcutListener = (event: Event) => void;
+/**
+ * Framework-agnostic keyboard, mouse and wheel shortcut dispatcher.
+ *
+ * Listens for the most commonly used input events (`keydown`, `keyup`,
+ * `mousedown`, `mouseup`, `dblclick`, `contextmenu` and `wheel`) on a target
+ * (`window` by default), converts each into a {@link Keybind} string, and
+ * dispatches it to any listeners registered with {@link on} as well as the
+ * static bindings declared in `KEYBINDS`.
+ *
+ * Every framework adapter in this package (React, Vue, Svelte, Angular,
+ * Solid, Preact) wraps a single instance of this class in that framework's
+ * own idioms (context/provider, composable, store, service, etc.).
+ */
+declare class ShortcutsManager {
+    private listeners;
+    private target;
+    private cleanup;
+    /** Registers `callback` to run whenever `shortcut` is triggered. */
+    on: (shortcut: Keybind, callback: ShortcutListener) => void;
+    /** Removes a `callback` previously registered with {@link on}. */
+    off: (shortcut: Keybind, callback: ShortcutListener) => void;
+    private emit;
+    private triggerShortcut;
+    /**
+     * Starts listening on `target` (`window` by default). Returns a disposer
+     * that removes the listeners; safe to call multiple times.
+     */
+    attach: (target?: EventTarget) => (() => void);
+    /** Stops listening. Safe to call even if {@link attach} was never called. */
+    detach: () => void;
+}
+
+declare const ShortcutsInjectionKey: InjectionKey<ShortcutsManager>;
+/**
+ * Vue plugin that installs a single {@link ShortcutsManager} for the whole
+ * app and attaches its listeners for the app's lifetime.
+ *
+ * @example
+ * ```ts
+ * import { createApp } from 'vue';
+ * import { ShortcutsPlugin } from 'browser-shortcuts/vue';
+ *
+ * createApp(App).use(ShortcutsPlugin).mount('#app');
+ * ```
+ */
+declare const ShortcutsPlugin: {
+    install(app: App): void;
+};
+/**
+ * Returns the app-wide {@link ShortcutsManager}. If the plugin was not
+ * installed (e.g. in a component test), a local instance is created and
+ * attached/detached with the component's lifecycle.
+ */
+declare function useShortcutsManager(): ShortcutsManager;
+/**
+ * Subscribes `callback` to `shortcut` for as long as the calling component
+ * is mounted.
+ *
+ * @example
+ * ```ts
+ * useShortcut('CTRL+SHIFT+F', () => (fullScreen.value = !fullScreen.value));
+ * ```
+ */
+declare function useShortcut(shortcut: Keybind, callback: ShortcutListener): void;
+
+export { type ShortcutListener, ShortcutsInjectionKey, ShortcutsPlugin, useShortcut, useShortcutsManager };

package/dist/vue.js

@@ -0,0 +1,277 @@
+// src/config/shortcuts.ts
+var KEYBINDS = {
+  "CTRL+SHIFT+F": "toggleFullScreen",
+  "CMD+SHIFT+F": "toggleFullScreen",
+  "CTRL+SHIFT+G": "toggleGrid",
+  "CMD+SHIFT+G": "toggleGrid",
+  "CTRL+SHIFT+H": "toggleHelp",
+  "CMD+SHIFT+H": "toggleHelp",
+  ESCAPE: "closeOverlay",
+  "CTRL+Z": "undo",
+  "CMD+Z": "undo",
+  "CTRL+SHIFT+Z": "redo",
+  "CMD+SHIFT+Z": "redo",
+  "CTRL+Y": "redo",
+  DELETE: "delete",
+  BACKSPACE: "delete",
+  "CTRL+A": "selectAll",
+  "CMD+A": "selectAll",
+  "CTRL+C": "copy",
+  "CMD+C": "copy",
+  "CTRL+V": "paste",
+  "CMD+V": "paste",
+  "CTRL+S": "save",
+  "CMD+S": "save",
+  DOUBLE_LEFT_BUTTON: "zoomIn",
+  LEFT_BUTTON: "leftMouseButton",
+  MIDDLE_BUTTON: "middleMouseButton",
+  RIGHT_BUTTON: "rightMouseButton"
+};
+var SHORTCUTS = {
+  toggleFullScreen: (event) => {
+    console.log("toggleFullScreen", event);
+  },
+  toggleGrid: (event) => {
+    console.log("toggleGrid", event);
+  },
+  toggleHelp: (event) => {
+    console.log("toggleHelp", event);
+  },
+  closeOverlay: (event) => {
+    console.log("closeOverlay", event);
+  },
+  undo: (event) => {
+    console.log("undo", event);
+  },
+  redo: (event) => {
+    console.log("redo", event);
+  },
+  delete: (event) => {
+    console.log("delete", event);
+  },
+  selectAll: (event) => {
+    console.log("selectAll", event);
+  },
+  copy: (event) => {
+    console.log("copy", event);
+  },
+  paste: (event) => {
+    console.log("paste", event);
+  },
+  save: (event) => {
+    console.log("save", event);
+  },
+  zoomIn: (event) => {
+    console.log("zoomIn", event);
+  },
+  leftMouseButton: (event) => {
+    console.log("leftMouseButton", event);
+  },
+  middleMouseButton: (event) => {
+    console.log("middleMouseButton", event);
+  },
+  rightMouseButton: (event) => {
+    console.log("rightMouseButton", event);
+  }
+};
+var shortcuts_default = KEYBINDS;
+
+// src/utils/misc.ts
+var IS_MAC = typeof navigator !== "undefined" && navigator.platform.toUpperCase().indexOf("MAC") >= 0;
+var IS_NOT_TOUCH_DEVICE = (() => {
+  if (typeof window === "undefined" || typeof navigator === "undefined") {
+    return false;
+  }
+  return !("ontouchstart" in window || navigator.maxTouchPoints > 0 || "msMaxTouchPoints" in navigator && navigator.msMaxTouchPoints > 0);
+})();
+var MOUSE_BUTTONS = ["LEFT_BUTTON", "MIDDLE_BUTTON", "RIGHT_BUTTON"];
+function buildShortcutString(key, event) {
+  return [
+    IS_MAC && event.metaKey ? "CMD" : "",
+    event.ctrlKey ? "CTRL" : "",
+    event.altKey ? "ALT" : "",
+    event.shiftKey ? "SHIFT" : "",
+    key.toUpperCase()
+  ].filter(Boolean).join("+");
+}
+
+// src/core/shortcuts-manager.ts
+var ShortcutsManager = class {
+  constructor() {
+    this.listeners = /* @__PURE__ */ new Map();
+    /** Registers `callback` to run whenever `shortcut` is triggered. */
+    this.on = (shortcut, callback) => {
+      var _a;
+      if (!this.listeners.has(shortcut)) {
+        this.listeners.set(shortcut, /* @__PURE__ */ new Set());
+      }
+      (_a = this.listeners.get(shortcut)) == null ? void 0 : _a.add(callback);
+    };
+    /** Removes a `callback` previously registered with {@link on}. */
+    this.off = (shortcut, callback) => {
+      var _a;
+      (_a = this.listeners.get(shortcut)) == null ? void 0 : _a.delete(callback);
+    };
+    this.emit = (shortcut, event) => {
+      var _a;
+      (_a = this.listeners.get(shortcut)) == null ? void 0 : _a.forEach((callback) => callback(event));
+    };
+    this.triggerShortcut = (shortcut, event) => {
+      var _a, _b;
+      this.emit(shortcut, event);
+      const action = shortcuts_default[shortcut];
+      if (action) {
+        event.preventDefault();
+        if (typeof action === "string") {
+          (_b = (_a = SHORTCUTS)[action]) == null ? void 0 : _b.call(_a, event);
+        } else {
+          action(event);
+        }
+      }
+    };
+    /**
+     * Starts listening on `target` (`window` by default). Returns a disposer
+     * that removes the listeners; safe to call multiple times.
+     */
+    this.attach = (target = window) => {
+      this.detach();
+      this.target = target;
+      const handleKeyDown = (event) => {
+        const keyboardEvent = event;
+        this.triggerShortcut(
+          buildShortcutString(keyboardEvent.key, keyboardEvent),
+          event
+        );
+      };
+      const handleKeyUp = (event) => {
+        const keyboardEvent = event;
+        this.triggerShortcut(
+          buildShortcutString(`${keyboardEvent.key}_UP`, keyboardEvent),
+          event
+        );
+      };
+      const handleMouseDown = (event) => {
+        const mouseEvent = event;
+        this.triggerShortcut(
+          buildShortcutString(MOUSE_BUTTONS[mouseEvent.button], mouseEvent),
+          event
+        );
+      };
+      const handleMouseUp = (event) => {
+        const mouseEvent = event;
+        this.triggerShortcut(
+          buildShortcutString(
+            `${MOUSE_BUTTONS[mouseEvent.button]}_UP`,
+            mouseEvent
+          ),
+          event
+        );
+      };
+      const handleDoubleClick = (event) => {
+        const mouseEvent = event;
+        this.triggerShortcut(
+          buildShortcutString(
+            `DOUBLE_${MOUSE_BUTTONS[mouseEvent.button]}`,
+            mouseEvent
+          ),
+          event
+        );
+      };
+      const handleContextMenu = (event) => {
+        this.triggerShortcut(
+          buildShortcutString("RIGHT_BUTTON", event),
+          event
+        );
+      };
+      const handleWheel = (event) => {
+        const wheelEvent = event;
+        const direction = wheelEvent.deltaY < 0 ? "WHEEL_UP" : "WHEEL_DOWN";
+        this.triggerShortcut(buildShortcutString(direction, wheelEvent), event);
+      };
+      target.addEventListener("keydown", handleKeyDown);
+      target.addEventListener("keyup", handleKeyUp);
+      target.addEventListener("mousedown", handleMouseDown);
+      target.addEventListener("mouseup", handleMouseUp);
+      target.addEventListener("dblclick", handleDoubleClick);
+      target.addEventListener("contextmenu", handleContextMenu);
+      target.addEventListener("wheel", handleWheel, { passive: true });
+      this.cleanup = () => {
+        target.removeEventListener("keydown", handleKeyDown);
+        target.removeEventListener("keyup", handleKeyUp);
+        target.removeEventListener("mousedown", handleMouseDown);
+        target.removeEventListener("mouseup", handleMouseUp);
+        target.removeEventListener("dblclick", handleDoubleClick);
+        target.removeEventListener("contextmenu", handleContextMenu);
+        target.removeEventListener("wheel", handleWheel);
+        this.target = void 0;
+        this.cleanup = void 0;
+      };
+      return this.cleanup;
+    };
+    /** Stops listening. Safe to call even if {@link attach} was never called. */
+    this.detach = () => {
+      var _a;
+      (_a = this.cleanup) == null ? void 0 : _a.call(this);
+    };
+  }
+};
+
+// src/vue/index.ts
+import {
+  getCurrentInstance,
+  inject,
+  onBeforeUnmount,
+  onMounted,
+  provide,
+  watch
+} from "vue";
+var ShortcutsInjectionKey = /* @__PURE__ */ Symbol(
+  "browser-shortcuts"
+);
+var ShortcutsPlugin = {
+  install(app) {
+    const manager = new ShortcutsManager();
+    manager.attach();
+    app.provide(ShortcutsInjectionKey, manager);
+  }
+};
+function useShortcutsManager() {
+  const injected = inject(ShortcutsInjectionKey, null);
+  if (injected) {
+    return injected;
+  }
+  const manager = new ShortcutsManager();
+  if (getCurrentInstance()) {
+    onMounted(() => {
+      const dispose = manager.attach();
+      onBeforeUnmount(dispose);
+    });
+    provide(ShortcutsInjectionKey, manager);
+  } else {
+    manager.attach();
+  }
+  return manager;
+}
+function useShortcut(shortcut, callback) {
+  const manager = useShortcutsManager();
+  onMounted(() => {
+    manager.on(shortcut, callback);
+  });
+  onBeforeUnmount(() => {
+    manager.off(shortcut, callback);
+  });
+  watch(
+    () => shortcut,
+    (next, prev) => {
+      manager.off(prev, callback);
+      manager.on(next, callback);
+    }
+  );
+}
+export {
+  ShortcutsInjectionKey,
+  ShortcutsPlugin,
+  useShortcut,
+  useShortcutsManager
+};
+//# sourceMappingURL=vue.js.map

package/dist/vue.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config/shortcuts.ts","../src/utils/misc.ts","../src/core/shortcuts-manager.ts","../src/vue/index.ts"],"sourcesContent":["/**\n * Maps a keybind string (e.g. `\"CTRL+SHIFT+F\"`) to either the name of a\n * {@link SHORTCUTS} entry or an inline handler.\n *\n * Prefer referencing a named entry in {@link SHORTCUTS} so the same action\n * can be triggered programmatically (e.g. from a command palette) using the\n * same {@link Shortcut} name.\n */\nexport type KeybindAction = Shortcut | ((event: Event) => void);\n\nconst KEYBINDS = {\n  'CTRL+SHIFT+F': 'toggleFullScreen',\n  'CMD+SHIFT+F': 'toggleFullScreen',\n  'CTRL+SHIFT+G': 'toggleGrid',\n  'CMD+SHIFT+G': 'toggleGrid',\n  'CTRL+SHIFT+H': 'toggleHelp',\n  'CMD+SHIFT+H': 'toggleHelp',\n  ESCAPE: 'closeOverlay',\n  'CTRL+Z': 'undo',\n  'CMD+Z': 'undo',\n  'CTRL+SHIFT+Z': 'redo',\n  'CMD+SHIFT+Z': 'redo',\n  'CTRL+Y': 'redo',\n  DELETE: 'delete',\n  BACKSPACE: 'delete',\n  'CTRL+A': 'selectAll',\n  'CMD+A': 'selectAll',\n  'CTRL+C': 'copy',\n  'CMD+C': 'copy',\n  'CTRL+V': 'paste',\n  'CMD+V': 'paste',\n  'CTRL+S': 'save',\n  'CMD+S': 'save',\n  DOUBLE_LEFT_BUTTON: 'zoomIn',\n  LEFT_BUTTON: 'leftMouseButton',\n  MIDDLE_BUTTON: 'middleMouseButton',\n  RIGHT_BUTTON: 'rightMouseButton',\n} satisfies { [key: string]: KeybindAction };\n\n/**\n * Named shortcut handlers, keyed by {@link Shortcut} name. Referenced from\n * {@link KEYBINDS} by name so the same action can be triggered from\n * multiple bindings (or invoked directly, outside of any input event).\n */\nexport const SHORTCUTS = {\n  toggleFullScreen: (event: Event) => {\n    console.log('toggleFullScreen', event);\n  },\n  toggleGrid: (event: Event) => {\n    console.log('toggleGrid', event);\n  },\n  toggleHelp: (event: Event) => {\n    console.log('toggleHelp', event);\n  },\n  closeOverlay: (event: Event) => {\n    console.log('closeOverlay', event);\n  },\n  undo: (event: Event) => {\n    console.log('undo', event);\n  },\n  redo: (event: Event) => {\n    console.log('redo', event);\n  },\n  delete: (event: Event) => {\n    console.log('delete', event);\n  },\n  selectAll: (event: Event) => {\n    console.log('selectAll', event);\n  },\n  copy: (event: Event) => {\n    console.log('copy', event);\n  },\n  paste: (event: Event) => {\n    console.log('paste', event);\n  },\n  save: (event: Event) => {\n    console.log('save', event);\n  },\n  zoomIn: (event: Event) => {\n    console.log('zoomIn', event);\n  },\n  leftMouseButton: (event: Event) => {\n    console.log('leftMouseButton', event);\n  },\n  middleMouseButton: (event: Event) => {\n    console.log('middleMouseButton', event);\n  },\n  rightMouseButton: (event: Event) => {\n    console.log('rightMouseButton', event);\n  },\n};\n\n/** A key combination string understood by {@link KEYBINDS}, e.g. `\"CTRL+SHIFT+F\"`. */\nexport type Keybind = keyof typeof KEYBINDS;\n\n/** The name of a handler registered in {@link SHORTCUTS}. */\nexport type Shortcut = keyof typeof SHORTCUTS;\n\nexport default KEYBINDS;\n","import type { Keybind } from '@/config';\n\n/** Whether the current platform reports itself as macOS (used to prefer `CMD` over `CTRL`). */\nexport const IS_MAC =\n  typeof navigator !== 'undefined' &&\n  navigator.platform.toUpperCase().indexOf('MAC') >= 0;\n\n/** Whether the current device supports mouse/keyboard input rather than touch only. */\nexport const IS_NOT_TOUCH_DEVICE = (() => {\n  if (typeof window === 'undefined' || typeof navigator === 'undefined') {\n    return false;\n  }\n  return !(\n    'ontouchstart' in window ||\n    navigator.maxTouchPoints > 0 ||\n    ('msMaxTouchPoints' in navigator &&\n      (navigator.msMaxTouchPoints as number) > 0)\n  );\n})();\n\n/** Names for `MouseEvent.button` values 0, 1 and 2, in that order. */\nexport const MOUSE_BUTTONS = ['LEFT_BUTTON', 'MIDDLE_BUTTON', 'RIGHT_BUTTON'];\n\n/**\n * Builds a {@link Keybind} string (e.g. `\"CTRL+SHIFT+F\"`) from a base key\n * name and the modifier keys held during the triggering event.\n *\n * @param key - The key or button name, e.g. `\"F\"` or `\"LEFT_BUTTON\"`.\n * @param event - The DOM event the key combination is derived from.\n */\nexport function buildShortcutString(\n  key: string,\n  event: KeyboardEvent | MouseEvent | WheelEvent,\n): Keybind {\n  return [\n    IS_MAC && event.metaKey ? 'CMD' : '',\n    event.ctrlKey ? 'CTRL' : '',\n    event.altKey ? 'ALT' : '',\n    event.shiftKey ? 'SHIFT' : '',\n    key.toUpperCase(),\n  ]\n    .filter(Boolean)\n    .join('+') as Keybind;\n}\n","import KEYBINDS, {\n  SHORTCUTS,\n  type Keybind,\n  type KeybindAction,\n  type Shortcut,\n} from '@/config/shortcuts';\nimport { buildShortcutString, MOUSE_BUTTONS } from '@/utils/misc';\n\n/** Callback invoked when a bound shortcut fires. */\nexport type ShortcutListener = (event: Event) => void;\n\n/**\n * Framework-agnostic keyboard, mouse and wheel shortcut dispatcher.\n *\n * Listens for the most commonly used input events (`keydown`, `keyup`,\n * `mousedown`, `mouseup`, `dblclick`, `contextmenu` and `wheel`) on a target\n * (`window` by default), converts each into a {@link Keybind} string, and\n * dispatches it to any listeners registered with {@link on} as well as the\n * static bindings declared in `KEYBINDS`.\n *\n * Every framework adapter in this package (React, Vue, Svelte, Angular,\n * Solid, Preact) wraps a single instance of this class in that framework's\n * own idioms (context/provider, composable, store, service, etc.).\n */\nexport class ShortcutsManager {\n  private listeners = new Map<Keybind, Set<ShortcutListener>>();\n  private target: EventTarget | undefined;\n  private cleanup: (() => void) | undefined;\n\n  /** Registers `callback` to run whenever `shortcut` is triggered. */\n  on = (shortcut: Keybind, callback: ShortcutListener): void => {\n    if (!this.listeners.has(shortcut)) {\n      this.listeners.set(shortcut, new Set());\n    }\n    this.listeners.get(shortcut)?.add(callback);\n  };\n\n  /** Removes a `callback` previously registered with {@link on}. */\n  off = (shortcut: Keybind, callback: ShortcutListener): void => {\n    this.listeners.get(shortcut)?.delete(callback);\n  };\n\n  private emit = (shortcut: Keybind, event: Event): void => {\n    this.listeners.get(shortcut)?.forEach((callback) => callback(event));\n  };\n\n  private triggerShortcut = (shortcut: Keybind, event: Event): void => {\n    this.emit(shortcut, event);\n\n    const action = KEYBINDS[shortcut] as KeybindAction | undefined;\n    if (action) {\n      event.preventDefault();\n      if (typeof action === 'string') {\n        SHORTCUTS[action as Shortcut]?.(event);\n      } else {\n        action(event);\n      }\n    }\n  };\n\n  /**\n   * Starts listening on `target` (`window` by default). Returns a disposer\n   * that removes the listeners; safe to call multiple times.\n   */\n  attach = (target: EventTarget = window): (() => void) => {\n    this.detach();\n    this.target = target;\n\n    const handleKeyDown = (event: Event) => {\n      const keyboardEvent = event as KeyboardEvent;\n      this.triggerShortcut(\n        buildShortcutString(keyboardEvent.key, keyboardEvent),\n        event,\n      );\n    };\n\n    const handleKeyUp = (event: Event) => {\n      const keyboardEvent = event as KeyboardEvent;\n      this.triggerShortcut(\n        buildShortcutString(`${keyboardEvent.key}_UP`, keyboardEvent),\n        event,\n      );\n    };\n\n    const handleMouseDown = (event: Event) => {\n      const mouseEvent = event as MouseEvent;\n      this.triggerShortcut(\n        buildShortcutString(MOUSE_BUTTONS[mouseEvent.button], mouseEvent),\n        event,\n      );\n    };\n\n    const handleMouseUp = (event: Event) => {\n      const mouseEvent = event as MouseEvent;\n      this.triggerShortcut(\n        buildShortcutString(\n          `${MOUSE_BUTTONS[mouseEvent.button]}_UP`,\n          mouseEvent,\n        ),\n        event,\n      );\n    };\n\n    const handleDoubleClick = (event: Event) => {\n      const mouseEvent = event as MouseEvent;\n      this.triggerShortcut(\n        buildShortcutString(\n          `DOUBLE_${MOUSE_BUTTONS[mouseEvent.button]}`,\n          mouseEvent,\n        ),\n        event,\n      );\n    };\n\n    const handleContextMenu = (event: Event) => {\n      this.triggerShortcut(\n        buildShortcutString('RIGHT_BUTTON', event as MouseEvent),\n        event,\n      );\n    };\n\n    const handleWheel = (event: Event) => {\n      const wheelEvent = event as WheelEvent;\n      const direction = wheelEvent.deltaY < 0 ? 'WHEEL_UP' : 'WHEEL_DOWN';\n      this.triggerShortcut(buildShortcutString(direction, wheelEvent), event);\n    };\n\n    target.addEventListener('keydown', handleKeyDown);\n    target.addEventListener('keyup', handleKeyUp);\n    target.addEventListener('mousedown', handleMouseDown);\n    target.addEventListener('mouseup', handleMouseUp);\n    target.addEventListener('dblclick', handleDoubleClick);\n    target.addEventListener('contextmenu', handleContextMenu);\n    target.addEventListener('wheel', handleWheel, { passive: true });\n\n    this.cleanup = () => {\n      target.removeEventListener('keydown', handleKeyDown);\n      target.removeEventListener('keyup', handleKeyUp);\n      target.removeEventListener('mousedown', handleMouseDown);\n      target.removeEventListener('mouseup', handleMouseUp);\n      target.removeEventListener('dblclick', handleDoubleClick);\n      target.removeEventListener('contextmenu', handleContextMenu);\n      target.removeEventListener('wheel', handleWheel);\n      this.target = undefined;\n      this.cleanup = undefined;\n    };\n\n    return this.cleanup;\n  };\n\n  /** Stops listening. Safe to call even if {@link attach} was never called. */\n  detach = (): void => {\n    this.cleanup?.();\n  };\n}\n","import type { Keybind } from '@/config';\nimport { ShortcutsManager, type ShortcutListener } from '@/core/shortcuts-manager';\nimport {\n  getCurrentInstance,\n  inject,\n  onBeforeUnmount,\n  onMounted,\n  provide,\n  watch,\n  type App,\n  type InjectionKey,\n} from 'vue';\n\nexport type { ShortcutListener } from '@/core/shortcuts-manager';\n\nexport const ShortcutsInjectionKey: InjectionKey<ShortcutsManager> = Symbol(\n  'browser-shortcuts',\n);\n\n/**\n * Vue plugin that installs a single {@link ShortcutsManager} for the whole\n * app and attaches its listeners for the app's lifetime.\n *\n * @example\n * ```ts\n * import { createApp } from 'vue';\n * import { ShortcutsPlugin } from 'browser-shortcuts/vue';\n *\n * createApp(App).use(ShortcutsPlugin).mount('#app');\n * ```\n */\nexport const ShortcutsPlugin = {\n  install(app: App) {\n    const manager = new ShortcutsManager();\n    manager.attach();\n    app.provide(ShortcutsInjectionKey, manager);\n  },\n};\n\n/**\n * Returns the app-wide {@link ShortcutsManager}. If the plugin was not\n * installed (e.g. in a component test), a local instance is created and\n * attached/detached with the component's lifecycle.\n */\nexport function useShortcutsManager(): ShortcutsManager {\n  const injected = inject(ShortcutsInjectionKey, null);\n  if (injected) {\n    return injected;\n  }\n\n  const manager = new ShortcutsManager();\n\n  if (getCurrentInstance()) {\n    onMounted(() => {\n      const dispose = manager.attach();\n      onBeforeUnmount(dispose);\n    });\n    provide(ShortcutsInjectionKey, manager);\n  } else {\n    manager.attach();\n  }\n\n  return manager;\n}\n\n/**\n * Subscribes `callback` to `shortcut` for as long as the calling component\n * is mounted.\n *\n * @example\n * ```ts\n * useShortcut('CTRL+SHIFT+F', () => (fullScreen.value = !fullScreen.value));\n * ```\n */\nexport function useShortcut(\n  shortcut: Keybind,\n  callback: ShortcutListener,\n): void {\n  const manager = useShortcutsManager();\n\n  onMounted(() => {\n    manager.on(shortcut, callback);\n  });\n\n  onBeforeUnmount(() => {\n    manager.off(shortcut, callback);\n  });\n\n  watch(\n    () => shortcut,\n    (next, prev) => {\n      manager.off(prev, callback);\n      manager.on(next, callback);\n    },\n  );\n}\n"],"mappings":";AAUA,IAAM,WAAW;AAAA,EACf,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,QAAQ;AAAA,EACR,UAAU;AAAA,EACV,SAAS;AAAA,EACT,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,UAAU;AAAA,EACV,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,UAAU;AAAA,EACV,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AAAA,EACT,UAAU;AAAA,EACV,SAAS;AAAA,EACT,oBAAoB;AAAA,EACpB,aAAa;AAAA,EACb,eAAe;AAAA,EACf,cAAc;AAChB;AAOO,IAAM,YAAY;AAAA,EACvB,kBAAkB,CAAC,UAAiB;AAClC,YAAQ,IAAI,oBAAoB,KAAK;AAAA,EACvC;AAAA,EACA,YAAY,CAAC,UAAiB;AAC5B,YAAQ,IAAI,cAAc,KAAK;AAAA,EACjC;AAAA,EACA,YAAY,CAAC,UAAiB;AAC5B,YAAQ,IAAI,cAAc,KAAK;AAAA,EACjC;AAAA,EACA,cAAc,CAAC,UAAiB;AAC9B,YAAQ,IAAI,gBAAgB,KAAK;AAAA,EACnC;AAAA,EACA,MAAM,CAAC,UAAiB;AACtB,YAAQ,IAAI,QAAQ,KAAK;AAAA,EAC3B;AAAA,EACA,MAAM,CAAC,UAAiB;AACtB,YAAQ,IAAI,QAAQ,KAAK;AAAA,EAC3B;AAAA,EACA,QAAQ,CAAC,UAAiB;AACxB,YAAQ,IAAI,UAAU,KAAK;AAAA,EAC7B;AAAA,EACA,WAAW,CAAC,UAAiB;AAC3B,YAAQ,IAAI,aAAa,KAAK;AAAA,EAChC;AAAA,EACA,MAAM,CAAC,UAAiB;AACtB,YAAQ,IAAI,QAAQ,KAAK;AAAA,EAC3B;AAAA,EACA,OAAO,CAAC,UAAiB;AACvB,YAAQ,IAAI,SAAS,KAAK;AAAA,EAC5B;AAAA,EACA,MAAM,CAAC,UAAiB;AACtB,YAAQ,IAAI,QAAQ,KAAK;AAAA,EAC3B;AAAA,EACA,QAAQ,CAAC,UAAiB;AACxB,YAAQ,IAAI,UAAU,KAAK;AAAA,EAC7B;AAAA,EACA,iBAAiB,CAAC,UAAiB;AACjC,YAAQ,IAAI,mBAAmB,KAAK;AAAA,EACtC;AAAA,EACA,mBAAmB,CAAC,UAAiB;AACnC,YAAQ,IAAI,qBAAqB,KAAK;AAAA,EACxC;AAAA,EACA,kBAAkB,CAAC,UAAiB;AAClC,YAAQ,IAAI,oBAAoB,KAAK;AAAA,EACvC;AACF;AAQA,IAAO,oBAAQ;;;AC/FR,IAAM,SACX,OAAO,cAAc,eACrB,UAAU,SAAS,YAAY,EAAE,QAAQ,KAAK,KAAK;AAG9C,IAAM,uBAAuB,MAAM;AACxC,MAAI,OAAO,WAAW,eAAe,OAAO,cAAc,aAAa;AACrE,WAAO;AAAA,EACT;AACA,SAAO,EACL,kBAAkB,UAClB,UAAU,iBAAiB,KAC1B,sBAAsB,aACpB,UAAU,mBAA8B;AAE/C,GAAG;AAGI,IAAM,gBAAgB,CAAC,eAAe,iBAAiB,cAAc;AASrE,SAAS,oBACd,KACA,OACS;AACT,SAAO;AAAA,IACL,UAAU,MAAM,UAAU,QAAQ;AAAA,IAClC,MAAM,UAAU,SAAS;AAAA,IACzB,MAAM,SAAS,QAAQ;AAAA,IACvB,MAAM,WAAW,UAAU;AAAA,IAC3B,IAAI,YAAY;AAAA,EAClB,EACG,OAAO,OAAO,EACd,KAAK,GAAG;AACb;;;ACnBO,IAAM,mBAAN,MAAuB;AAAA,EAAvB;AACL,SAAQ,YAAY,oBAAI,IAAoC;AAK5D;AAAA,cAAK,CAAC,UAAmB,aAAqC;AA9BhE;AA+BI,UAAI,CAAC,KAAK,UAAU,IAAI,QAAQ,GAAG;AACjC,aAAK,UAAU,IAAI,UAAU,oBAAI,IAAI,CAAC;AAAA,MACxC;AACA,iBAAK,UAAU,IAAI,QAAQ,MAA3B,mBAA8B,IAAI;AAAA,IACpC;AAGA;AAAA,eAAM,CAAC,UAAmB,aAAqC;AAtCjE;AAuCI,iBAAK,UAAU,IAAI,QAAQ,MAA3B,mBAA8B,OAAO;AAAA,IACvC;AAEA,SAAQ,OAAO,CAAC,UAAmB,UAAuB;AA1C5D;AA2CI,iBAAK,UAAU,IAAI,QAAQ,MAA3B,mBAA8B,QAAQ,CAAC,aAAa,SAAS,KAAK;AAAA,IACpE;AAEA,SAAQ,kBAAkB,CAAC,UAAmB,UAAuB;AA9CvE;AA+CI,WAAK,KAAK,UAAU,KAAK;AAEzB,YAAM,SAAS,kBAAS,QAAQ;AAChC,UAAI,QAAQ;AACV,cAAM,eAAe;AACrB,YAAI,OAAO,WAAW,UAAU;AAC9B,iCAAU,YAAV,4BAAgC;AAAA,QAClC,OAAO;AACL,iBAAO,KAAK;AAAA,QACd;AAAA,MACF;AAAA,IACF;AAMA;AAAA;AAAA;AAAA;AAAA,kBAAS,CAAC,SAAsB,WAAyB;AACvD,WAAK,OAAO;AACZ,WAAK,SAAS;AAEd,YAAM,gBAAgB,CAAC,UAAiB;AACtC,cAAM,gBAAgB;AACtB,aAAK;AAAA,UACH,oBAAoB,cAAc,KAAK,aAAa;AAAA,UACpD;AAAA,QACF;AAAA,MACF;AAEA,YAAM,cAAc,CAAC,UAAiB;AACpC,cAAM,gBAAgB;AACtB,aAAK;AAAA,UACH,oBAAoB,GAAG,cAAc,GAAG,OAAO,aAAa;AAAA,UAC5D;AAAA,QACF;AAAA,MACF;AAEA,YAAM,kBAAkB,CAAC,UAAiB;AACxC,cAAM,aAAa;AACnB,aAAK;AAAA,UACH,oBAAoB,cAAc,WAAW,MAAM,GAAG,UAAU;AAAA,UAChE;AAAA,QACF;AAAA,MACF;AAEA,YAAM,gBAAgB,CAAC,UAAiB;AACtC,cAAM,aAAa;AACnB,aAAK;AAAA,UACH;AAAA,YACE,GAAG,cAAc,WAAW,MAAM,CAAC;AAAA,YACnC;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,YAAM,oBAAoB,CAAC,UAAiB;AAC1C,cAAM,aAAa;AACnB,aAAK;AAAA,UACH;AAAA,YACE,UAAU,cAAc,WAAW,MAAM,CAAC;AAAA,YAC1C;AAAA,UACF;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,YAAM,oBAAoB,CAAC,UAAiB;AAC1C,aAAK;AAAA,UACH,oBAAoB,gBAAgB,KAAmB;AAAA,UACvD;AAAA,QACF;AAAA,MACF;AAEA,YAAM,cAAc,CAAC,UAAiB;AACpC,cAAM,aAAa;AACnB,cAAM,YAAY,WAAW,SAAS,IAAI,aAAa;AACvD,aAAK,gBAAgB,oBAAoB,WAAW,UAAU,GAAG,KAAK;AAAA,MACxE;AAEA,aAAO,iBAAiB,WAAW,aAAa;AAChD,aAAO,iBAAiB,SAAS,WAAW;AAC5C,aAAO,iBAAiB,aAAa,eAAe;AACpD,aAAO,iBAAiB,WAAW,aAAa;AAChD,aAAO,iBAAiB,YAAY,iBAAiB;AACrD,aAAO,iBAAiB,eAAe,iBAAiB;AACxD,aAAO,iBAAiB,SAAS,aAAa,EAAE,SAAS,KAAK,CAAC;AAE/D,WAAK,UAAU,MAAM;AACnB,eAAO,oBAAoB,WAAW,aAAa;AACnD,eAAO,oBAAoB,SAAS,WAAW;AAC/C,eAAO,oBAAoB,aAAa,eAAe;AACvD,eAAO,oBAAoB,WAAW,aAAa;AACnD,eAAO,oBAAoB,YAAY,iBAAiB;AACxD,eAAO,oBAAoB,eAAe,iBAAiB;AAC3D,eAAO,oBAAoB,SAAS,WAAW;AAC/C,aAAK,SAAS;AACd,aAAK,UAAU;AAAA,MACjB;AAEA,aAAO,KAAK;AAAA,IACd;AAGA;AAAA,kBAAS,MAAY;AAvJvB;AAwJI,iBAAK,YAAL;AAAA,IACF;AAAA;AACF;;;ACxJA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAIA,IAAM,wBAAwD;AAAA,EACnE;AACF;AAcO,IAAM,kBAAkB;AAAA,EAC7B,QAAQ,KAAU;AAChB,UAAM,UAAU,IAAI,iBAAiB;AACrC,YAAQ,OAAO;AACf,QAAI,QAAQ,uBAAuB,OAAO;AAAA,EAC5C;AACF;AAOO,SAAS,sBAAwC;AACtD,QAAM,WAAW,OAAO,uBAAuB,IAAI;AACnD,MAAI,UAAU;AACZ,WAAO;AAAA,EACT;AAEA,QAAM,UAAU,IAAI,iBAAiB;AAErC,MAAI,mBAAmB,GAAG;AACxB,cAAU,MAAM;AACd,YAAM,UAAU,QAAQ,OAAO;AAC/B,sBAAgB,OAAO;AAAA,IACzB,CAAC;AACD,YAAQ,uBAAuB,OAAO;AAAA,EACxC,OAAO;AACL,YAAQ,OAAO;AAAA,EACjB;AAEA,SAAO;AACT;AAWO,SAAS,YACd,UACA,UACM;AACN,QAAM,UAAU,oBAAoB;AAEpC,YAAU,MAAM;AACd,YAAQ,GAAG,UAAU,QAAQ;AAAA,EAC/B,CAAC;AAED,kBAAgB,MAAM;AACpB,YAAQ,IAAI,UAAU,QAAQ;AAAA,EAChC,CAAC;AAED;AAAA,IACE,MAAM;AAAA,IACN,CAAC,MAAM,SAAS;AACd,cAAQ,IAAI,MAAM,QAAQ;AAC1B,cAAQ,GAAG,MAAM,QAAQ;AAAA,IAC3B;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "browser-shortcuts",
+  "version": "0.1.0",
+  "description": "Declarative keyboard, mouse and wheel shortcuts for React, Preact, Vue, Svelte, Solid and Angular.",
+  "license": "MIT",
+  "author": "Antonio Okoro",
+  "keywords": [
+    "shortcuts",
+    "keybindings",
+    "hotkeys",
+    "keyboard",
+    "react",
+    "preact",
+    "vue",
+    "svelte",
+    "solid",
+    "angular"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./preact": {
+      "types": "./dist/preact.d.ts",
+      "import": "./dist/preact.js",
+      "require": "./dist/preact.cjs"
+    },
+    "./vue": {
+      "types": "./dist/vue.d.ts",
+      "import": "./dist/vue.js",
+      "require": "./dist/vue.cjs"
+    },
+    "./svelte": {
+      "types": "./dist/svelte.d.ts",
+      "import": "./dist/svelte.js",
+      "require": "./dist/svelte.cjs"
+    },
+    "./solid": {
+      "types": "./dist/solid.d.ts",
+      "import": "./dist/solid.js",
+      "require": "./dist/solid.cjs"
+    },
+    "./angular": {
+      "types": "./dist/angular.d.ts",
+      "import": "./dist/angular.js",
+      "require": "./dist/angular.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint src",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "preact": "^10.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "solid-js": "^1.8.0",
+    "svelte": "^4.0.0 || ^5.0.0",
+    "vue": "^3.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@angular/core": { "optional": true },
+    "preact": { "optional": true },
+    "react": { "optional": true },
+    "react-dom": { "optional": true },
+    "solid-js": { "optional": true },
+    "svelte": { "optional": true },
+    "vue": { "optional": true }
+  },
+  "devDependencies": {
+    "@angular/core": "^19.0.0",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "preact": "^10.24.3",
+    "react": "19.2.8",
+    "react-dom": "19.2.8",
+    "solid-js": "^1.9.3",
+    "svelte": "^5.0.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5",
+    "vue": "^3.5.0"
+  }
+}