@solid-primitives/keyboard 1.0.9-beta.0 → 1.0.9

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,158 +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-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)
+<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.d.ts

@@ -1,4 +1,4 @@
-import { Accessor } from "solid-js";
+import { Accessor } from 'solid-js';
 
 type ModifierKey = "Alt" | "Control" | "Meta" | "Shift";
 type KbdKey = ModifierKey | (string & {});
@@ -23,12 +23,9 @@ type KbdKey = ModifierKey | (string & {});
  * })
  * ```
  */
-declare const useKeyDownList: () => [
-  keys: Accessor<string[]>,
-  other: {
+declare const useKeyDownList: () => [keys: Accessor<string[]>, other: {
     event: Accessor<KeyboardEvent | null>;
-  },
-];
+}];
 /**
  * Provides a signal with the currently held single key. Pressing any other key at the same time will reset the signal to `null`.
  *
@@ -94,12 +91,9 @@ declare const useKeyDownSequence: () => Accessor<string[][]>;
  * })
  * ```
  */
-declare function createKeyHold(
-  key: KbdKey,
-  options?: {
+declare function createKeyHold(key: KbdKey, options?: {
     preventDefault?: boolean;
-  },
-): Accessor<boolean>;
+}): Accessor<boolean>;
 /**
  * Creates a keyboard shotcut observer. The provided {@link callback} will be called when the specified {@link keys} are pressed.
  *
@@ -118,21 +112,9 @@ declare function createKeyHold(
  * });
  * ```
  */
-declare function createShortcut(
-  keys: KbdKey[],
-  callback: VoidFunction,
-  options?: {
+declare function createShortcut(keys: KbdKey[], callback: VoidFunction, options?: {
     preventDefault?: boolean;
     requireReset?: boolean;
-  },
-): void;
+}): void;
 
-export {
-  KbdKey,
-  ModifierKey,
-  createKeyHold,
-  createShortcut,
-  useCurrentlyHeldKey,
-  useKeyDownList,
-  useKeyDownSequence,
-};
+export { KbdKey, ModifierKey, createKeyHold, createShortcut, useCurrentlyHeldKey, useKeyDownList, useKeyDownSequence };

package/dist/index.js

@@ -1,13 +1,14 @@
-import { makeEventListener } from "@solid-primitives/event-listener";
-import { createSharedRoot } from "@solid-primitives/rootless";
-import { arrayEquals } from "@solid-primitives/utils";
-import { createSignal, batch, untrack, createMemo, createEffect, on } from "solid-js";
+import { makeEventListener } from '@solid-primitives/event-listener';
+import { createSharedRoot } from '@solid-primitives/rootless';
+import { arrayEquals } from '@solid-primitives/utils';
+import { createSignal, batch, untrack, createMemo, createEffect, on } from 'solid-js';
 
 // src/index.ts
 function equalsKeyHoldSequence(sequence, model) {
   for (let i = sequence.length - 1; i >= 0; i--) {
     const _model = model.slice(0, i + 1);
-    if (!arrayEquals(sequence[i], _model)) return false;
+    if (!arrayEquals(sequence[i], _model))
+      return false;
   }
   return true;
 }
@@ -15,22 +16,25 @@ var useKeyDownList = /* @__PURE__ */ createSharedRoot(() => {
   const [pressedKeys, setPressedKeys] = createSignal([]);
   const [event, setEvent] = createSignal(null);
   const reset = () => setPressedKeys([]);
-  makeEventListener(window, "keydown", e => {
-    if (e.repeat || typeof e.key !== "string") return;
+  makeEventListener(window, "keydown", (e) => {
+    if (e.repeat || typeof e.key !== "string")
+      return;
     const key = e.key.toUpperCase();
-    if (pressedKeys().includes(key)) return;
+    if (pressedKeys().includes(key))
+      return;
     batch(() => {
       setEvent(e);
-      setPressedKeys(prev => [...prev, key]);
+      setPressedKeys((prev) => [...prev, key]);
     });
   });
-  makeEventListener(window, "keyup", e => {
-    if (typeof e.key !== "string") return;
+  makeEventListener(window, "keyup", (e) => {
+    if (typeof e.key !== "string")
+      return;
     const key = e.key.toUpperCase();
-    setPressedKeys(prev => prev.filter(_key => _key !== key));
+    setPressedKeys((prev) => prev.filter((_key) => _key !== key));
   });
   makeEventListener(window, "blur", reset);
-  makeEventListener(window, "contextmenu", e => {
+  makeEventListener(window, "contextmenu", (e) => {
     e.defaultPrevented || reset();
   });
   return [pressedKeys, { event }];
@@ -42,14 +46,16 @@ var useCurrentlyHeldKey = /* @__PURE__ */ createSharedRoot(() => {
     const _keys = keys();
     const prev = prevKeys;
     prevKeys = _keys;
-    if (prev.length === 0 && _keys.length === 1) return _keys[0];
+    if (prev.length === 0 && _keys.length === 1)
+      return _keys[0];
     return null;
   });
 });
 var useKeyDownSequence = /* @__PURE__ */ createSharedRoot(() => {
   const [keys] = useKeyDownList();
-  return createMemo(prev => {
-    if (keys().length === 0) return [];
+  return createMemo((prev) => {
+    if (keys().length === 0)
+      return [];
     return [...prev, keys()];
   }, []);
 });
@@ -70,14 +76,16 @@ function createShortcut(keys, callback, options = {}) {
   if (!keys.length) {
     return;
   }
-  keys = keys.map(key => key.toUpperCase());
+  keys = keys.map((key) => key.toUpperCase());
   const { preventDefault = true, requireReset = false } = options;
   const [, { event }] = useKeyDownList();
   const sequence = useKeyDownSequence();
   let reset = false;
-  const handleSequenceWithReset = sequence2 => {
-    if (!sequence2.length) return (reset = false);
-    if (reset) return;
+  const handleSequenceWithReset = (sequence2) => {
+    if (!sequence2.length)
+      return reset = false;
+    if (reset)
+      return;
     if (sequence2.length < keys.length) {
       if (equalsKeyHoldSequence(sequence2, keys.slice(0, sequence2.length))) {
         preventDefault && event().preventDefault();
@@ -92,9 +100,10 @@ function createShortcut(keys, callback, options = {}) {
       }
     }
   };
-  const handleSequenceWithoutReset = sequence2 => {
+  const handleSequenceWithoutReset = (sequence2) => {
     const last = sequence2.at(-1);
-    if (!last) return;
+    if (!last)
+      return;
     if (preventDefault && last.length < keys.length) {
       if (arrayEquals(last, keys.slice(0, keys.length - 1))) {
         event().preventDefault();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solid-primitives/keyboard",
-  "version": "1.0.9-beta.0",
+  "version": "1.0.9",
   "description": "A library of reactive promitives helping handling user's keyboard input.",
   "author": "Damian Tarnwski <gthetarnav@gmail.com>",
   "contributors": [],
@@ -81,9 +81,9 @@
     "require": "./dist/index.cjs"
   },
   "dependencies": {
-    "@solid-primitives/event-listener": "^2.2.8-beta.0",
-    "@solid-primitives/rootless": "^1.2.6-beta.0",
-    "@solid-primitives/utils": "^5.4.0-beta.0"
+    "@solid-primitives/event-listener": "^2.2.8",
+    "@solid-primitives/rootless": "^1.2.6",
+    "@solid-primitives/utils": "^5.4.0"
   },
   "peerDependencies": {
     "solid-js": "^1.6.0"

package/dist/server.cjs

@@ -1,36 +0,0 @@
-'use strict';
-
-require('@solid-primitives/event-listener');
-var rootless = require('@solid-primitives/rootless');
-require('@solid-primitives/utils');
-require('solid-js');
-
-// src/index.ts
-exports.useKeyDownList = /* @__PURE__ */ rootless.createSharedRoot(() => {
-  {
-    return [() => [], { event: () => null }];
-  }
-});
-exports.useCurrentlyHeldKey = /* @__PURE__ */ rootless.createSharedRoot(() => {
-  {
-    return () => null;
-  }
-});
-exports.useKeyDownSequence = /* @__PURE__ */ rootless.createSharedRoot(() => {
-  {
-    return () => [];
-  }
-});
-function createKeyHold(key, options = {}) {
-  {
-    return () => false;
-  }
-}
-function createShortcut(keys, callback, options = {}) {
-  {
-    return;
-  }
-}
-
-exports.createKeyHold = createKeyHold;
-exports.createShortcut = createShortcut;

package/dist/server.js

@@ -1,33 +0,0 @@
-import "@solid-primitives/event-listener";
-import { createSharedRoot } from "@solid-primitives/rootless";
-import "@solid-primitives/utils";
-import "solid-js";
-
-// src/index.ts
-var useKeyDownList = /* @__PURE__ */ createSharedRoot(() => {
-  {
-    return [() => [], { event: () => null }];
-  }
-});
-var useCurrentlyHeldKey = /* @__PURE__ */ createSharedRoot(() => {
-  {
-    return () => null;
-  }
-});
-var useKeyDownSequence = /* @__PURE__ */ createSharedRoot(() => {
-  {
-    return () => [];
-  }
-});
-function createKeyHold(key, options = {}) {
-  {
-    return () => false;
-  }
-}
-function createShortcut(keys, callback, options = {}) {
-  {
-    return;
-  }
-}
-
-export { createKeyHold, createShortcut, useCurrentlyHeldKey, useKeyDownList, useKeyDownSequence };