@solid-primitives/keyboard 1.0.10 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +3 -3
  2. package/dist/index.cjs +30 -15
  3. package/dist/index.d.ts +3 -3
  4. package/dist/index.js +31 -16
  5. package/package.json +9 -40
  6. package/dist/server.cjs +0 -36
  7. package/dist/server.js +0 -33
package/README.md CHANGED
@@ -29,7 +29,7 @@ yarn add @solid-primitives/keyboard
29
29
 
30
30
  Provides a signal with the list of currently held keys, ordered from least recent to most recent.
31
31
 
32
- 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.
32
+ This is a [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) primitive that will reuse event listeners and signals across dependents.
33
33
 
34
34
  ### How to use it
35
35
 
@@ -54,7 +54,7 @@ createEffect(() => {
54
54
 
55
55
  Provides a signal with the currently held single key. Pressing any other key at the same time will reset the signal to `null`.
56
56
 
57
- 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.
57
+ This is a [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) primitive that will reuse event listeners and signals across dependents.
58
58
 
59
59
  ### How to use it
60
60
 
@@ -74,7 +74,7 @@ createEffect(() => {
74
74
 
75
75
  Provides a signal with a sequence of currently held keys, as they were pressed down and up.
76
76
 
77
- 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.
77
+ This is a [singleton root](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot) primitive that will reuse event listeners and signals across dependents.
78
78
 
79
79
  ### How to use it
80
80
 
package/dist/index.cjs CHANGED
@@ -4,6 +4,7 @@ var eventListener = require('@solid-primitives/event-listener');
4
4
  var rootless = require('@solid-primitives/rootless');
5
5
  var utils = require('@solid-primitives/utils');
6
6
  var solidJs = require('solid-js');
7
+ var web = require('solid-js/web');
7
8
 
8
9
  // src/index.ts
9
10
  function equalsKeyHoldSequence(sequence, model) {
@@ -14,7 +15,10 @@ function equalsKeyHoldSequence(sequence, model) {
14
15
  }
15
16
  return true;
16
17
  }
17
- exports.useKeyDownList = /* @__PURE__ */ rootless.createSharedRoot(() => {
18
+ exports.useKeyDownList = /* @__PURE__ */ rootless.createSingletonRoot(() => {
19
+ if (web.isServer) {
20
+ return [() => [], { event: () => null }];
21
+ }
18
22
  const [pressedKeys, setPressedKeys] = solidJs.createSignal([]);
19
23
  const [event, setEvent] = solidJs.createSignal(null);
20
24
  const reset = () => setPressedKeys([]);
@@ -41,19 +45,27 @@ exports.useKeyDownList = /* @__PURE__ */ rootless.createSharedRoot(() => {
41
45
  });
42
46
  return [pressedKeys, { event }];
43
47
  });
44
- exports.useCurrentlyHeldKey = /* @__PURE__ */ rootless.createSharedRoot(() => {
45
- const [keys] = exports.useKeyDownList();
46
- let prevKeys = solidJs.untrack(keys);
47
- return solidJs.createMemo(() => {
48
- const _keys = keys();
49
- const prev = prevKeys;
50
- prevKeys = _keys;
51
- if (prev.length === 0 && _keys.length === 1)
52
- return _keys[0];
53
- return null;
54
- });
55
- });
56
- exports.useKeyDownSequence = /* @__PURE__ */ rootless.createSharedRoot(() => {
48
+ exports.useCurrentlyHeldKey = /* @__PURE__ */ rootless.createSingletonRoot(
49
+ () => {
50
+ if (web.isServer) {
51
+ return () => null;
52
+ }
53
+ const [keys] = exports.useKeyDownList();
54
+ let prevKeys = solidJs.untrack(keys);
55
+ return solidJs.createMemo(() => {
56
+ const _keys = keys();
57
+ const prev = prevKeys;
58
+ prevKeys = _keys;
59
+ if (prev.length === 0 && _keys.length === 1)
60
+ return _keys[0];
61
+ return null;
62
+ });
63
+ }
64
+ );
65
+ exports.useKeyDownSequence = /* @__PURE__ */ rootless.createSingletonRoot(() => {
66
+ if (web.isServer) {
67
+ return () => [];
68
+ }
57
69
  const [keys] = exports.useKeyDownList();
58
70
  return solidJs.createMemo((prev) => {
59
71
  if (keys().length === 0)
@@ -62,6 +74,9 @@ exports.useKeyDownSequence = /* @__PURE__ */ rootless.createSharedRoot(() => {
62
74
  }, []);
63
75
  });
64
76
  function createKeyHold(key, options = {}) {
77
+ if (web.isServer) {
78
+ return () => false;
79
+ }
65
80
  key = key.toUpperCase();
66
81
  const { preventDefault = true } = options;
67
82
  const [, { event }] = exports.useKeyDownList();
@@ -75,7 +90,7 @@ function createKeyHold(key, options = {}) {
75
90
  });
76
91
  }
77
92
  function createShortcut(keys, callback, options = {}) {
78
- if (!keys.length) {
93
+ if (web.isServer || !keys.length) {
79
94
  return;
80
95
  }
81
96
  keys = keys.map((key) => key.toUpperCase());
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ type KbdKey = ModifierKey | (string & {});
5
5
  /**
6
6
  * Provides a signal with the list of currently held keys, ordered from least recent to most recent.
7
7
  *
8
- * This is a [shared root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot). *(signals and event-listeners are reused across dependents)*
8
+ * This is a [singleton root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot). *(signals and event-listeners are reused across dependents)*
9
9
  *
10
10
  * @see https://github.com/solidjs-community/solid-primitives/tree/main/packages/keyboard#useKeyDownList
11
11
  *
@@ -29,7 +29,7 @@ declare const useKeyDownList: () => [keys: Accessor<string[]>, other: {
29
29
  /**
30
30
  * Provides a signal with the currently held single key. Pressing any other key at the same time will reset the signal to `null`.
31
31
  *
32
- * This is a [shared root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot). *(signals and event-listeners are reused across dependents)*
32
+ * This is a [singleton root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot). *(signals and event-listeners are reused across dependents)*
33
33
  *
34
34
  * @see https://github.com/solidjs-community/solid-primitives/tree/main/packages/keyboard#useCurrentlyHeldKey
35
35
  *
@@ -50,7 +50,7 @@ declare const useCurrentlyHeldKey: () => Accessor<string | null>;
50
50
  /**
51
51
  * Provides a signal with a sequence of currently held keys, as they were pressed down and up.
52
52
  *
53
- * This is a [shared root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSharedRoot). *(signals and event-listeners are reused across dependents)*
53
+ * This is a [singleton root primitive](https://github.com/solidjs-community/solid-primitives/tree/main/packages/rootless#createSingletonRoot). *(signals and event-listeners are reused across dependents)*
54
54
  *
55
55
  * @see https://github.com/solidjs-community/solid-primitives/tree/main/packages/keyboard#useKeyDownSequence
56
56
  *
package/dist/index.js CHANGED
@@ -1,7 +1,8 @@
1
1
  import { makeEventListener } from '@solid-primitives/event-listener';
2
- import { createSharedRoot } from '@solid-primitives/rootless';
2
+ import { createSingletonRoot } from '@solid-primitives/rootless';
3
3
  import { arrayEquals } from '@solid-primitives/utils';
4
4
  import { createSignal, batch, untrack, createMemo, createEffect, on } from 'solid-js';
5
+ import { isServer } from 'solid-js/web';
5
6
 
6
7
  // src/index.ts
7
8
  function equalsKeyHoldSequence(sequence, model) {
@@ -12,7 +13,10 @@ function equalsKeyHoldSequence(sequence, model) {
12
13
  }
13
14
  return true;
14
15
  }
15
- var useKeyDownList = /* @__PURE__ */ createSharedRoot(() => {
16
+ var useKeyDownList = /* @__PURE__ */ createSingletonRoot(() => {
17
+ if (isServer) {
18
+ return [() => [], { event: () => null }];
19
+ }
16
20
  const [pressedKeys, setPressedKeys] = createSignal([]);
17
21
  const [event, setEvent] = createSignal(null);
18
22
  const reset = () => setPressedKeys([]);
@@ -39,19 +43,27 @@ var useKeyDownList = /* @__PURE__ */ createSharedRoot(() => {
39
43
  });
40
44
  return [pressedKeys, { event }];
41
45
  });
42
- var useCurrentlyHeldKey = /* @__PURE__ */ createSharedRoot(() => {
43
- const [keys] = useKeyDownList();
44
- let prevKeys = untrack(keys);
45
- return createMemo(() => {
46
- const _keys = keys();
47
- const prev = prevKeys;
48
- prevKeys = _keys;
49
- if (prev.length === 0 && _keys.length === 1)
50
- return _keys[0];
51
- return null;
52
- });
53
- });
54
- var useKeyDownSequence = /* @__PURE__ */ createSharedRoot(() => {
46
+ var useCurrentlyHeldKey = /* @__PURE__ */ createSingletonRoot(
47
+ () => {
48
+ if (isServer) {
49
+ return () => null;
50
+ }
51
+ const [keys] = useKeyDownList();
52
+ let prevKeys = untrack(keys);
53
+ return createMemo(() => {
54
+ const _keys = keys();
55
+ const prev = prevKeys;
56
+ prevKeys = _keys;
57
+ if (prev.length === 0 && _keys.length === 1)
58
+ return _keys[0];
59
+ return null;
60
+ });
61
+ }
62
+ );
63
+ var useKeyDownSequence = /* @__PURE__ */ createSingletonRoot(() => {
64
+ if (isServer) {
65
+ return () => [];
66
+ }
55
67
  const [keys] = useKeyDownList();
56
68
  return createMemo((prev) => {
57
69
  if (keys().length === 0)
@@ -60,6 +72,9 @@ var useKeyDownSequence = /* @__PURE__ */ createSharedRoot(() => {
60
72
  }, []);
61
73
  });
62
74
  function createKeyHold(key, options = {}) {
75
+ if (isServer) {
76
+ return () => false;
77
+ }
63
78
  key = key.toUpperCase();
64
79
  const { preventDefault = true } = options;
65
80
  const [, { event }] = useKeyDownList();
@@ -73,7 +88,7 @@ function createKeyHold(key, options = {}) {
73
88
  });
74
89
  }
75
90
  function createShortcut(keys, callback, options = {}) {
76
- if (!keys.length) {
91
+ if (isServer || !keys.length) {
77
92
  return;
78
93
  }
79
94
  keys = keys.map((key) => key.toUpperCase());
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@solid-primitives/keyboard",
3
- "version": "1.0.10",
3
+ "version": "1.0.12",
4
4
  "description": "A library of reactive promitives helping handling user's keyboard input.",
5
5
  "author": "Damian Tarnwski <gthetarnav@gmail.com>",
6
6
  "contributors": [],
@@ -38,42 +38,11 @@
38
38
  "dist"
39
39
  ],
40
40
  "type": "module",
41
- "main": "./dist/server.cjs",
42
- "module": "./dist/server.js",
41
+ "main": "./dist/index.cjs",
42
+ "module": "./dist/index.js",
43
43
  "types": "./dist/index.d.ts",
44
- "browser": {
45
- "./dist/server.js": "./dist/index.js",
46
- "./dist/server.cjs": "./dist/index.cjs"
47
- },
44
+ "browser": {},
48
45
  "exports": {
49
- "worker": {
50
- "import": {
51
- "types": "./dist/index.d.ts",
52
- "default": "./dist/server.js"
53
- },
54
- "require": "./dist/server.cjs"
55
- },
56
- "browser": {
57
- "import": {
58
- "types": "./dist/index.d.ts",
59
- "default": "./dist/index.js"
60
- },
61
- "require": "./dist/index.cjs"
62
- },
63
- "deno": {
64
- "import": {
65
- "types": "./dist/index.d.ts",
66
- "default": "./dist/server.js"
67
- },
68
- "require": "./dist/server.cjs"
69
- },
70
- "node": {
71
- "import": {
72
- "types": "./dist/index.d.ts",
73
- "default": "./dist/server.js"
74
- },
75
- "require": "./dist/server.cjs"
76
- },
77
46
  "import": {
78
47
  "types": "./dist/index.d.ts",
79
48
  "default": "./dist/index.js"
@@ -81,18 +50,18 @@
81
50
  "require": "./dist/index.cjs"
82
51
  },
83
52
  "dependencies": {
84
- "@solid-primitives/event-listener": "^2.2.8",
85
- "@solid-primitives/rootless": "^1.2.6",
86
- "@solid-primitives/utils": "^5.4.0"
53
+ "@solid-primitives/event-listener": "^2.2.10",
54
+ "@solid-primitives/rootless": "^1.3.2",
55
+ "@solid-primitives/utils": "^6.0.0"
87
56
  },
88
57
  "peerDependencies": {
89
- "solid-js": "^1.6.0"
58
+ "solid-js": "^1.6.12"
90
59
  },
91
60
  "typesVersions": {},
92
61
  "scripts": {
93
62
  "dev": "vite serve dev",
94
63
  "page": "vite build dev",
95
- "build": "jiti ../../scripts/build.ts --ssr",
64
+ "build": "jiti ../../scripts/build.ts",
96
65
  "test": "vitest -c ../../configs/vitest.config.ts",
97
66
  "test:ssr": "pnpm run test --mode ssr"
98
67
  }
package/dist/server.cjs DELETED
@@ -1,36 +0,0 @@
1
- 'use strict';
2
-
3
- require('@solid-primitives/event-listener');
4
- var rootless = require('@solid-primitives/rootless');
5
- require('@solid-primitives/utils');
6
- require('solid-js');
7
-
8
- // src/index.ts
9
- exports.useKeyDownList = /* @__PURE__ */ rootless.createSharedRoot(() => {
10
- {
11
- return [() => [], { event: () => null }];
12
- }
13
- });
14
- exports.useCurrentlyHeldKey = /* @__PURE__ */ rootless.createSharedRoot(() => {
15
- {
16
- return () => null;
17
- }
18
- });
19
- exports.useKeyDownSequence = /* @__PURE__ */ rootless.createSharedRoot(() => {
20
- {
21
- return () => [];
22
- }
23
- });
24
- function createKeyHold(key, options = {}) {
25
- {
26
- return () => false;
27
- }
28
- }
29
- function createShortcut(keys, callback, options = {}) {
30
- {
31
- return;
32
- }
33
- }
34
-
35
- exports.createKeyHold = createKeyHold;
36
- exports.createShortcut = createShortcut;
package/dist/server.js DELETED
@@ -1,33 +0,0 @@
1
- import '@solid-primitives/event-listener';
2
- import { createSharedRoot } from '@solid-primitives/rootless';
3
- import '@solid-primitives/utils';
4
- import 'solid-js';
5
-
6
- // src/index.ts
7
- var useKeyDownList = /* @__PURE__ */ createSharedRoot(() => {
8
- {
9
- return [() => [], { event: () => null }];
10
- }
11
- });
12
- var useCurrentlyHeldKey = /* @__PURE__ */ createSharedRoot(() => {
13
- {
14
- return () => null;
15
- }
16
- });
17
- var useKeyDownSequence = /* @__PURE__ */ createSharedRoot(() => {
18
- {
19
- return () => [];
20
- }
21
- });
22
- function createKeyHold(key, options = {}) {
23
- {
24
- return () => false;
25
- }
26
- }
27
- function createShortcut(keys, callback, options = {}) {
28
- {
29
- return;
30
- }
31
- }
32
-
33
- export { createKeyHold, createShortcut, useCurrentlyHeldKey, useKeyDownList, useKeyDownSequence };