@solid-primitives/keyboard 1.0.0 → 1.0.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Solid Primitives Working Group
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2021 Solid Primitives Working Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,171 +1,158 @@
-<p>
-  <img width="100%" src="https://assets.solidjs.com/banner?type=Primitives&background=tiles&project=keyboard" alt="Solid Primitives keyboard">
-</p>
-
-# @solid-primitives/keyboard
-
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg?style=for-the-badge)](https://lerna.js.org/)
-[![size](https://img.shields.io/bundlephobia/minzip/@solid-primitives/keyboard?style=for-the-badge&label=size)](https://bundlephobia.com/package/@solid-primitives/keyboard)
-[![version](https://img.shields.io/npm/v/@solid-primitives/keyboard?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/keyboard)
-[![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-0.json)](https://github.com/solidjs-community/solid-primitives#contribution-process)
-
-A library of reactive promitives helping handling user's keyboard input.
-
-- [`useKeyDownList`](#useKeyDownList) — Provides a signal with the list of currently held keys
-- [`useCurrentlyHeldKey`](#useCurrentlyHeldKey) — Provides a signal with the currently held single key.
-- [`useKeyDownSequence`](#useKeyDownSequence) — Provides a signal with a sequence of currently held keys, as they were pressed down and up.
-- [`createKeyHold`](#createKeyHold) — Provides a signal indicating if provided key is currently being held down.
-- [`createShortcut`](#createShortcut) — Creates a keyboard shotcut observer.
-
-## Installation
-
-```bash
-npm install @solid-primitives/keyboard
-# or
-yarn add @solid-primitives/keyboard
-```
-
-## `useKeyDownList`
-
-Provides a signal with the list of currently held keys, ordered from least recent to most recent.
-
-This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
-
-### How to use it
-
-`useKeyDownList` takes no arguments, and returns a signal with the list of currently held keys, and last keydown event.
-
-```tsx
-import { useKeyDownList } from "@solid-primitives/keyboard";
-
-const [keys, { event }] = useKeyDownList();
-
-createEffect(() => {
-  console.log(keys()); // => string[] — list of currently held keys
-  console.log(event()); // => KeyboardEvent | null — last keydown event
-});
-
-<For each={keys()}>
-  {key => <kbd>{key}</kdb>}
-</For>
-```
-
-## `useCurrentlyHeldKey`
-
-Provides a signal with the currently held single key. Pressing any other key at the same time will reset the signal to `null`.
-
-This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
-
-### How to use it
-
-`useCurrentlyHeldKey` takes no arguments, and returns a signal with the currently held single key.
-
-```tsx
-import { useCurrentlyHeldKey } from "@solid-primitives/keyboard";
-
-const key = useCurrentlyHeldKey();
-
-createEffect(() => {
-  console.log(key()); // => string | null — currently held key
-});
-```
-
-## `useKeyDownSequence`
-
-Provides a signal with a sequence of currently held keys, as they were pressed down and up.
-
-This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
-
-### How to use it
-
-`useKeyDownSequence` takes no arguments, and returns a single signal.
-
-```tsx
-import { useKeyDownSequence } from "@solid-primitives/keyboard";
-
-const sequence = useKeyDownSequence();
-
-createEffect(() => {
-  console.log(sequence()); // => string[][] — sequence of currently held keys
-});
-
-// example sequence of pressing Ctrl + Shift + A
-// [["Control"], ["Control", "Shift"], ["Control", "Shift", "A"]]
-```
-
-## `createKeyHold`
-
-Provides a `boolean` signal indicating if provided {@link key} is currently being held down.
-
-Holding multiple keys at the same time will return `false` — holding only the specified one will return `true`.
-
-### How to use it
-
-`createKeyHold` takes two arguments:
-
-- `key` keyboard key to listen for
-- `options` additional configuration:
-  - `preventDefault` — call `e.preventDefault()` on the keyboard event, when the specified key is pressed. _(Defaults to `true`)_
-
-```tsx
-import { createKeyHold } from "@solid-primitives/keyboard";
-
-const pressing = createKeyHold("Alt", { preventDefault: false });
-
-<p>Is pressing Alt? {pressing() ? "YES" : "NO"}</p>;
-```
-
-## `createShortcut`
-
-Creates a keyboard shotcut observer. The provided callback will be called when the specified keys are pressed.
-
-### How to use it
-
-`createShortcut` takes three arguments:
-
-- `keys` — list of keys to listen for
-- `callback` — callback to call when the specified keys are pressed
-- `options` — additional configuration:
-  - `preventDefault` — call `e.preventDefault()` on the keyboard event, when the specified key is pressed. _(Defaults to `true`)_
-  - `requireReset` — If `true`, the shortcut will only be triggered once until all of the keys stop being pressed. Disabled by default.
-
-```tsx
-import { createShortcut } from "@solid-primitives/keyboard";
-
-createShortcut(
-  ["Control", "Shift", "A"],
-  () => {
-    console.log("Shortcut triggered");
-  },
-  { preventDefault: false, requireReset: true }
-);
-```
-
-### Preventing default
-
-When `preventDefault` is `true`, `e.preventDefault()` will be called not only on the keydown event that have triggered the callback, but it will **optimistically** also prevend the default behavior of every previous keydown that will have the possibility to lead to the shotcut being pressed.
-
-E.g. when listening for `Control + Shift + A`, all three keydown events will be prevented.
-
-## Changelog
-
-<details>
-<summary><b>Expand Changelog</b></summary>
-
-0.0.100
-
-Initial release as a Stage-0 primitive.
-
-1.0.0
-
-[PR#159](https://github.com/solidjs-community/solid-primitives/pull/159)
-
-General package refactor. The single initial `makeKeyHoldListener` primitive has been replaced by:
-
-- `useKeyDownList`,
-- `useCurrentlyHeldKey`,
-- `useKeyDownSequence`,
-- `createKeyHold`,
-- `createShortcut`
-
-</details>
+<p>
+  <img width="100%" src="https://assets.solidjs.com/banner?type=Primitives&background=tiles&project=keyboard" alt="Solid Primitives keyboard">
+</p>
+
+# @solid-primitives/keyboard
+
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg?style=for-the-badge)](https://lerna.js.org/)
+[![size](https://img.shields.io/bundlephobia/minzip/@solid-primitives/keyboard?style=for-the-badge&label=size)](https://bundlephobia.com/package/@solid-primitives/keyboard)
+[![version](https://img.shields.io/npm/v/@solid-primitives/keyboard?style=for-the-badge)](https://www.npmjs.com/package/@solid-primitives/keyboard)
+[![stage](https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolidjs-community%2Fsolid-primitives%2Fmain%2Fassets%2Fbadges%2Fstage-1.json)](https://github.com/solidjs-community/solid-primitives#contribution-process)
+
+A library of reactive promitives helping handling user's keyboard input.
+
+- [`useKeyDownList`](#useKeyDownList) — Provides a signal with the list of currently held keys
+- [`useCurrentlyHeldKey`](#useCurrentlyHeldKey) — Provides a signal with the currently held single key.
+- [`useKeyDownSequence`](#useKeyDownSequence) — Provides a signal with a sequence of currently held keys, as they were pressed down and up.
+- [`createKeyHold`](#createKeyHold) — Provides a signal indicating if provided key is currently being held down.
+- [`createShortcut`](#createShortcut) — Creates a keyboard shotcut observer.
+
+## Installation
+
+```bash
+npm install @solid-primitives/keyboard
+# or
+yarn add @solid-primitives/keyboard
+```
+
+## `useKeyDownList`
+
+Provides a signal with the list of currently held keys, ordered from least recent to most recent.
+
+This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
+
+### How to use it
+
+`useKeyDownList` takes no arguments, and returns a signal with the list of currently held keys, and last keydown event.
+
+```tsx
+import { useKeyDownList } from "@solid-primitives/keyboard";
+
+const [keys, { event }] = useKeyDownList();
+
+createEffect(() => {
+  console.log(keys()); // => string[] — list of currently held keys
+  console.log(event()); // => KeyboardEvent | null — last keydown event
+});
+
+<For each={keys()}>
+  {key => <kbd>{key}</kdb>}
+</For>
+```
+
+## `useCurrentlyHeldKey`
+
+Provides a signal with the currently held single key. Pressing any other key at the same time will reset the signal to `null`.
+
+This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
+
+### How to use it
+
+`useCurrentlyHeldKey` takes no arguments, and returns a signal with the currently held single key.
+
+```tsx
+import { useCurrentlyHeldKey } from "@solid-primitives/keyboard";
+
+const key = useCurrentlyHeldKey();
+
+createEffect(() => {
+  console.log(key()); // => string | null — currently held key
+});
+```
+
+## `useKeyDownSequence`
+
+Provides a signal with a sequence of currently held keys, as they were pressed down and up.
+
+This is a [shared root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot) primitive that will reuse event listeners and signals across dependents.
+
+### How to use it
+
+`useKeyDownSequence` takes no arguments, and returns a single signal.
+
+```tsx
+import { useKeyDownSequence } from "@solid-primitives/keyboard";
+
+const sequence = useKeyDownSequence();
+
+createEffect(() => {
+  console.log(sequence()); // => string[][] — sequence of currently held keys
+});
+
+// example sequence of pressing Ctrl + Shift + A
+// [["Control"], ["Control", "Shift"], ["Control", "Shift", "A"]]
+```
+
+## `createKeyHold`
+
+Provides a `boolean` signal indicating if provided key is currently being held down.
+
+Holding multiple keys at the same time will return `false` — holding only the specified one will return `true`.
+
+### How to use it
+
+`createKeyHold` takes two arguments:
+
+- `key` keyboard key to listen for
+- `options` additional configuration:
+  - `preventDefault` — call `e.preventDefault()` on the keyboard event, when the specified key is pressed. _(Defaults to `true`)_
+
+```tsx
+import { createKeyHold } from "@solid-primitives/keyboard";
+
+const pressing = createKeyHold("Alt", { preventDefault: false });
+
+<p>Is pressing Alt? {pressing() ? "YES" : "NO"}</p>;
+```
+
+## `createShortcut`
+
+Creates a keyboard shotcut observer. The provided callback will be called when the specified keys are pressed.
+
+### How to use it
+
+`createShortcut` takes three arguments:
+
+- `keys` — list of keys to listen for
+- `callback` — callback to call when the specified keys are pressed
+- `options` — additional configuration:
+  - `preventDefault` — call `e.preventDefault()` on the keyboard event, when the specified key is pressed. _(Defaults to `true`)_
+  - `requireReset` — If `true`, the shortcut will only be triggered once until all of the keys stop being pressed. Disabled by default.
+
+```tsx
+import { createShortcut } from "@solid-primitives/keyboard";
+
+createShortcut(
+  ["Control", "Shift", "A"],
+  () => {
+    console.log("Shortcut triggered");
+  },
+  { preventDefault: false, requireReset: true }
+);
+```
+
+### Preventing default
+
+When `preventDefault` is `true`, `e.preventDefault()` will be called not only on the keydown event that have triggered the callback, but it will **optimistically** also prevend the default behavior of every previous keydown that will have the possibility to lead to the shotcut being pressed.
+
+E.g. when listening for `Control + Shift + A`, all three keydown events will be prevented.
+
+## DEMO
+
+Working demo of some of the primitives in keyboard package:
+
+https://codesandbox.io/s/solid-primitives-keyboard-demo-s2l84k?file=/index.tsx
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md)

package/dist/index.js

@@ -1,5 +1,3 @@
-"use strict";
-
 // src/index.ts
 import { makeEventListener } from "@solid-primitives/event-listener";
 import { createSharedRoot } from "@solid-primitives/rootless";

package/dist/server.js

@@ -1,5 +1,3 @@
-"use strict";
-
 // src/server.ts
 import { noop } from "@solid-primitives/utils";
 var useKeyDownList = () => [() => [], { event: () => null }];

package/package.json

@@ -1,79 +1,79 @@
-{
-  "name": "@solid-primitives/keyboard",
-  "version": "1.0.0",
-  "description": "A library of reactive promitives helping handling user's keyboard input.",
-  "author": "Damian Tarnwski <gthetarnav@gmail.com>",
-  "contributors": [],
-  "license": "MIT",
-  "homepage": "https://github.com/solidjs-community/solid-primitives/tree/main/packages/keyboard#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/solidjs-community/solid-primitives.git"
-  },
-  "bugs": {
-    "url": "https://github.com/solidjs-community/solid-primitives/issues"
-  },
-  "primitive": {
-    "name": "keyboard",
-    "stage": 0,
-    "list": [
-      "useKeyDownList",
-      "useCurrentlyHeldKey",
-      "useKeyDownSequence",
-      "createKeyHold",
-      "createShortcut"
-    ],
-    "category": "Inputs"
-  },
-  "private": false,
-  "sideEffects": false,
-  "type": "module",
-  "main": "./dist/server.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    "node": {
-      "import": "./dist/server.js",
-      "require": "./dist/server.cjs"
-    },
-    "import": "./dist/index.js",
-    "require": "./dist/index.cjs"
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "start": "vite serve dev --host",
-    "dev": "npm run start",
-    "build": "tsup",
-    "test": "vitest run test",
-    "test:watch": "vitest watch test"
-  },
-  "keywords": [
-    "solid",
-    "primitives",
-    "keyboard",
-    "keystroke",
-    "hotkey"
-  ],
-  "devDependencies": {
-    "jsdom": "^19.0.0",
-    "prettier": "^2.7.1",
-    "solid-js": "^1.4.4",
-    "tslib": "^2.4.0",
-    "tsup": "^6.1.2",
-    "typescript": "^4.7.4",
-    "unocss": "0.39.0",
-    "vite": "2.9.12",
-    "vite-plugin-solid": "2.2.6",
-    "vitest": "^0.18.0"
-  },
-  "peerDependencies": {
-    "solid-js": "^1.4.0"
-  },
-  "dependencies": {
-    "@solid-primitives/event-listener": "^2.2.0",
-    "@solid-primitives/rootless": "^1.1.0",
-    "@solid-primitives/utils": "^2.1.1"
-  }
-}
+{
+  "name": "@solid-primitives/keyboard",
+  "version": "1.0.1",
+  "description": "A library of reactive promitives helping handling user's keyboard input.",
+  "author": "Damian Tarnwski <gthetarnav@gmail.com>",
+  "contributors": [],
+  "license": "MIT",
+  "homepage": "https://github.com/solidjs-community/solid-primitives/tree/main/packages/keyboard#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solidjs-community/solid-primitives.git"
+  },
+  "bugs": {
+    "url": "https://github.com/solidjs-community/solid-primitives/issues"
+  },
+  "primitive": {
+    "name": "keyboard",
+    "stage": 1,
+    "list": [
+      "useKeyDownList",
+      "useCurrentlyHeldKey",
+      "useKeyDownSequence",
+      "createKeyHold",
+      "createShortcut"
+    ],
+    "category": "Inputs"
+  },
+  "private": false,
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/server.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "node": {
+      "import": "./dist/server.js",
+      "require": "./dist/server.cjs"
+    },
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "solid",
+    "primitives",
+    "keyboard",
+    "keystroke",
+    "hotkey"
+  ],
+  "devDependencies": {
+    "jsdom": "^19.0.0",
+    "prettier": "^2.7.1",
+    "solid-js": "^1.4.8",
+    "tslib": "^2.4.0",
+    "tsup": "^6.1.3",
+    "typescript": "^4.7.4",
+    "unocss": "^0.44.7",
+    "vite": "^3.0.2",
+    "vite-plugin-solid": "^2.3.0",
+    "vitest": "^0.18.1"
+  },
+  "peerDependencies": {
+    "solid-js": "^1.4.0"
+  },
+  "dependencies": {
+    "@solid-primitives/event-listener": "^2.2.1",
+    "@solid-primitives/rootless": "^1.1.2",
+    "@solid-primitives/utils": "^3.0.0"
+  },
+  "scripts": {
+    "start": "vite serve dev --host",
+    "dev": "npm run start",
+    "build": "tsup",
+    "test": "vitest run test",
+    "test:watch": "vitest watch test"
+  }
+}