@tanstack/preact-hotkeys 0.17.0 → 0.18.0
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.
- package/dist/HotkeysProvider.js +3 -3
- package/dist/_appHotkeysStore.js +3 -2
- package/dist/_useSelector.js +54 -0
- package/dist/useHeldKeyCodes.js +1 -1
- package/dist/useHeldKeys.d.ts +1 -2
- package/dist/useHeldKeys.js +2 -3
- package/dist/useHotkeyHint.js +1 -1
- package/dist/useHotkeyRecorder.js +1 -1
- package/dist/useHotkeyRegistrations.js +1 -1
- package/dist/useHotkeyScopesState.js +1 -1
- package/dist/useKeyHold.d.ts +1 -2
- package/dist/useKeyHold.js +2 -3
- package/package.json +3 -4
package/dist/HotkeysProvider.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { publishAppHotkeysStore } from "@tanstack/hotkeys";
|
|
2
2
|
import { createContext } from "preact";
|
|
3
3
|
import { useContext, useEffect, useMemo, useState } from "preact/hooks";
|
|
4
|
-
import { activateHotkeysProviderScope, getHotkeysProviderScopeKey, mergeHotkeysProviderDefaults } from "@tanstack/hotkeys/adapter";
|
|
4
|
+
import { activateHotkeysProviderScope, createAppHotkeysStore, getHotkeysProviderScopeKey, mergeHotkeysProviderDefaults } from "@tanstack/hotkeys/adapter";
|
|
5
5
|
import { jsx } from "preact/jsx-runtime";
|
|
6
6
|
|
|
7
7
|
//#region src/HotkeysProvider.tsx
|
|
@@ -45,7 +45,7 @@ const NO_PARENT = {
|
|
|
45
45
|
*/
|
|
46
46
|
function HotkeysProvider({ children, appHotkeys, customHotkeys, onCustomHotkeysChange, defaultOptions = DEFAULT_OPTIONS, scope, exclusive = false, enabled = true }) {
|
|
47
47
|
const parent = useContext(HotkeysContext) ?? NO_PARENT;
|
|
48
|
-
const [store] = useState(() => appHotkeys ?
|
|
48
|
+
const [store] = useState(() => appHotkeys ? createAppHotkeysStore(appHotkeys, {
|
|
49
49
|
customHotkeys,
|
|
50
50
|
onCustomHotkeysChange
|
|
51
51
|
}) : null);
|
package/dist/_appHotkeysStore.js
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { useHotkeysContext } from "./HotkeysProvider.js";
|
|
2
|
-
import {
|
|
2
|
+
import { useSelector } from "./_useSelector.js";
|
|
3
|
+
import { createStore } from "@tanstack/hotkeys/adapter";
|
|
3
4
|
|
|
4
5
|
//#region src/_appHotkeysStore.ts
|
|
5
|
-
const NO_APP_HOTKEYS =
|
|
6
|
+
const NO_APP_HOTKEYS = createStore(null);
|
|
6
7
|
/**
|
|
7
8
|
* The provider's app hotkeys store, re-rendering when app hotkeys or custom
|
|
8
9
|
* hotkeys change. Null outside a provider with `appHotkeys`.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { useEffect, useLayoutEffect, useMemo, useRef, useState } from "preact/hooks";
|
|
2
|
+
|
|
3
|
+
//#region src/_useSelector.ts
|
|
4
|
+
/**
|
|
5
|
+
* Subscribes to a store and returns the selected value, re-rendering when it
|
|
6
|
+
* changes (by `Object.is`). The selector runs again only when the store's
|
|
7
|
+
* state or the selector itself changes. Preact 10 has no
|
|
8
|
+
* `useSyncExternalStore` outside `preact/compat`, so this follows its approach.
|
|
9
|
+
*/
|
|
10
|
+
function useSelector(store, selector) {
|
|
11
|
+
const select = useMemo(() => {
|
|
12
|
+
let memo;
|
|
13
|
+
return (state) => {
|
|
14
|
+
if (!memo || !Object.is(memo.state, state)) memo = {
|
|
15
|
+
state,
|
|
16
|
+
selected: selector(state)
|
|
17
|
+
};
|
|
18
|
+
return memo.selected;
|
|
19
|
+
};
|
|
20
|
+
}, [selector]);
|
|
21
|
+
const selected = useRef(void 0);
|
|
22
|
+
const getSelection = () => {
|
|
23
|
+
const next = select(store.get());
|
|
24
|
+
if (!Object.is(selected.current, next)) selected.current = next;
|
|
25
|
+
return selected.current;
|
|
26
|
+
};
|
|
27
|
+
const value = getSelection();
|
|
28
|
+
const [{ instance }, forceUpdate] = useState({ instance: {
|
|
29
|
+
value,
|
|
30
|
+
getSelection
|
|
31
|
+
} });
|
|
32
|
+
const changed = () => {
|
|
33
|
+
try {
|
|
34
|
+
return !Object.is(instance.value, instance.getSelection());
|
|
35
|
+
} catch {
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
};
|
|
39
|
+
useLayoutEffect(() => {
|
|
40
|
+
instance.value = value;
|
|
41
|
+
instance.getSelection = getSelection;
|
|
42
|
+
if (changed()) forceUpdate({ instance });
|
|
43
|
+
});
|
|
44
|
+
useEffect(() => {
|
|
45
|
+
if (changed()) forceUpdate({ instance });
|
|
46
|
+
return store.subscribe(() => {
|
|
47
|
+
if (changed()) forceUpdate({ instance });
|
|
48
|
+
}).unsubscribe;
|
|
49
|
+
}, [instance, store]);
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
//#endregion
|
|
54
|
+
export { useSelector };
|
package/dist/useHeldKeyCodes.js
CHANGED
package/dist/useHeldKeys.d.ts
CHANGED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Preact hook that returns an array of currently held keyboard keys.
|
|
4
4
|
*
|
|
5
|
-
* This hook
|
|
6
|
-
* to the global KeyStateTracker and updates whenever keys are pressed
|
|
5
|
+
* This hook subscribes to the global KeyStateTracker and updates whenever keys are pressed
|
|
7
6
|
* or released.
|
|
8
7
|
*
|
|
9
8
|
* @returns Array of currently held key names
|
package/dist/useHeldKeys.js
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
+
import { useSelector } from "./_useSelector.js";
|
|
1
2
|
import { getKeyStateTracker } from "@tanstack/hotkeys";
|
|
2
|
-
import { useSelector } from "@tanstack/preact-store";
|
|
3
3
|
|
|
4
4
|
//#region src/useHeldKeys.ts
|
|
5
5
|
/**
|
|
6
6
|
* Preact hook that returns an array of currently held keyboard keys.
|
|
7
7
|
*
|
|
8
|
-
* This hook
|
|
9
|
-
* to the global KeyStateTracker and updates whenever keys are pressed
|
|
8
|
+
* This hook subscribes to the global KeyStateTracker and updates whenever keys are pressed
|
|
10
9
|
* or released.
|
|
11
10
|
*
|
|
12
11
|
* @returns Array of currently held key names
|
package/dist/useHotkeyHint.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import { useSelector } from "./_useSelector.js";
|
|
1
2
|
import { useAppHotkeysStoreState } from "./_appHotkeysStore.js";
|
|
2
3
|
import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
|
|
3
|
-
import { useSelector } from "@tanstack/preact-store";
|
|
4
4
|
|
|
5
5
|
//#region src/useHotkeyHint.ts
|
|
6
6
|
/**
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { useDefaultHotkeysOptions } from "./HotkeysProvider.js";
|
|
2
|
+
import { useSelector } from "./_useSelector.js";
|
|
2
3
|
import { HotkeyRecorder } from "@tanstack/hotkeys";
|
|
3
4
|
import { useEffect, useRef } from "preact/hooks";
|
|
4
|
-
import { useSelector } from "@tanstack/preact-store";
|
|
5
5
|
|
|
6
6
|
//#region src/useHotkeyRecorder.ts
|
|
7
7
|
function useHotkeyRecorder(options) {
|
package/dist/useKeyHold.d.ts
CHANGED
|
@@ -3,8 +3,7 @@ import { IndividualKey } from "@tanstack/hotkeys";
|
|
|
3
3
|
/**
|
|
4
4
|
* Preact hook that returns whether a specific key is currently being held.
|
|
5
5
|
*
|
|
6
|
-
* This hook uses
|
|
7
|
-
* to the global KeyStateTracker and uses a selector to determine if
|
|
6
|
+
* This hook subscribes to the global KeyStateTracker and uses a selector to determine if
|
|
8
7
|
* the specified key is held.
|
|
9
8
|
*
|
|
10
9
|
* @param key - The key to check (e.g., 'Shift', 'Control', 'A')
|
package/dist/useKeyHold.js
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
+
import { useSelector } from "./_useSelector.js";
|
|
1
2
|
import { getKeyStateTracker } from "@tanstack/hotkeys";
|
|
2
|
-
import { useSelector } from "@tanstack/preact-store";
|
|
3
3
|
|
|
4
4
|
//#region src/useKeyHold.ts
|
|
5
5
|
/**
|
|
6
6
|
* Preact hook that returns whether a specific key is currently being held.
|
|
7
7
|
*
|
|
8
|
-
* This hook uses
|
|
9
|
-
* to the global KeyStateTracker and uses a selector to determine if
|
|
8
|
+
* This hook subscribes to the global KeyStateTracker and uses a selector to determine if
|
|
10
9
|
* the specified key is held.
|
|
11
10
|
*
|
|
12
11
|
* @param key - The key to check (e.g., 'Shift', 'Control', 'A')
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/preact-hotkeys",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.18.0",
|
|
4
4
|
"description": "Preact adapter for TanStack Hotkeys",
|
|
5
5
|
"author": "Tanner Linsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -35,8 +35,7 @@
|
|
|
35
35
|
"skills"
|
|
36
36
|
],
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@tanstack/hotkeys": "0.
|
|
39
|
-
"@tanstack/preact-store": "^0.13.5"
|
|
38
|
+
"@tanstack/hotkeys": "0.20.0"
|
|
40
39
|
},
|
|
41
40
|
"devDependencies": {
|
|
42
41
|
"@preact/preset-vite": "^2.10.6",
|
|
@@ -44,7 +43,7 @@
|
|
|
44
43
|
"preact": "^11.0.1"
|
|
45
44
|
},
|
|
46
45
|
"peerDependencies": {
|
|
47
|
-
"preact": ">=10.
|
|
46
|
+
"preact": ">=10.5.2"
|
|
48
47
|
},
|
|
49
48
|
"scripts": {
|
|
50
49
|
"clean": "premove ./build ./dist",
|