nycklar 1.0.0

package/README.md

@@ -0,0 +1,40 @@
+# 🔑 `nycklar`
+
+> A tiny proptype for keybindings, inspired by the [`tinykeys`](https://jamiebuilds.github.io/tinykeys/) lib
+
+This is a tiny version of what `tinykeys` can do, and is more of a personal project than something you should use.
+
+## Usage
+
+```js
+import { nycklar } from "nycklar";
+
+nycklar(window, {
+  "Shift+D": () => {
+    console.log("pressed shift and d");
+  },
+  abc: () => {
+    console.log("pressed the abc keys in order");
+  },
+});
+```
+
+### React Hooks Example
+
+If you're using nycklar within a component, you should also make use of the returned `cleanup()` function.
+
+```js
+import { useEffect } from "react";
+import { nycklar } from "nycklar";
+
+const myKeybindingsHook = () => {
+  useEffect(() => {
+    let cleanup = nycklar(window, {
+      // ...
+    });
+    return () => {
+      cleanup();
+    };
+  });
+};
+```

package/dist/index.d.mts

@@ -0,0 +1,33 @@
+//#region src/index.d.ts
+type TEventsMap = Readonly<Record<string, (event: KeyboardEvent) => void>>;
+declare const eventType: readonly ["keydown", "keyup"];
+type TEventType = (typeof eventType)[number];
+interface TOptions {
+  timeout?: number;
+  event?: TEventType;
+}
+/**
+ * A basic prototype of the tinykeys lib
+ * Takes a target and a map of key events to listen to an a function to call when matched
+ * Returns an unsubscribe method.
+ * @see https://github.com/jamiebuilds/tinykeys
+ * @example
+ * ```js
+ * import { nycklar } from "../src/nycklar"
+ *
+ * nycklar(window, {
+ * 	"d": () => {
+ * 		console.log("pressed d");
+ * 	},
+ * 	"abc": () => {
+ * 		console.log("pressed abc");
+ * 	},
+ * 	"Shift+D": () => {
+ * 		console.log("pressed shift d");
+ * 	},
+ * })
+ * ```
+ */
+declare const nycklar: (target: Window | HTMLElement, keyEvents: TEventsMap, options?: TOptions) => () => void;
+//#endregion
+export { nycklar };

package/dist/index.mjs

@@ -0,0 +1 @@
+const e=(e,t,n)=>{e in t&&t[e](n)},t=(t,n,r={})=>{let i=[],{timeout:a=1e3,event:o=`keydown`}=r,s=null,c=t=>{if(!(t instanceof KeyboardEvent)||t.target instanceof HTMLInputElement||t.target instanceof HTMLTextAreaElement||t.target instanceof HTMLElement&&(t.target.isContentEditable||t.target.contentEditable===`true`))return;let r=t.altKey||t.ctrlKey||t.shiftKey;i.push(t.key);let o=i.join(r?`+`:``);s!==null&&clearTimeout(s),s=setTimeout(()=>{e(o,n,t),i=[]},a)};return t.addEventListener(o,c),()=>{t.removeEventListener(o,c)}};export{t as nycklar};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "nycklar",
+  "version": "1.0.0",
+  "author": "Daniel Reed",
+  "keywords": [],
+  "description": "",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    }
+  },
+  "types": "./dist/index.d.mts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "biome check src",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "playground": "cd playground && pnpm dev"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.15",
+    "jsdom": "^28.0.0",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}