@inklu/keys 2.2.0 → 3.0.0

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { a as importKeymap, c as bindingTokens, d as isSingleKeyBinding, f as seq, i as exportKeymap, l as formatBinding, n as createCommands, o as webStorage, r as createRebinder, s as ariaKeyShortcuts, t as matchCommands, u as spokenBinding } from "./src-TaZw4V61.mjs";
-export { ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, matchCommands, seq, spokenBinding, webStorage };
+import { a as webStorage, c as formatBinding, i as importKeymap, l as isSingleKeyBinding, n as createRebinder, o as ariaKeyShortcuts, r as exportKeymap, s as bindingTokens, t as createCommands, u as seq } from "./src-CGKvYKjd.mjs";
+export { ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, seq, webStorage };

package/dist/react.d.mts

@@ -1,5 +1,5 @@
-import { C as SequenceBinding, D as Chord, E as SerializedOverride, O as Key, S as ScopeOptions, T as SerializedKeymap, _ as Override, a as CommandDefinition, b as RunBlockReason, c as CommandSource, d as Conflict, f as ConflictOptions, g as KeymapStore, h as KeyCapture, i as CommandContext, k as Platform, l as Commands, m as Json, n as BindingInput, o as CommandHandler, p as DisplayOptions, r as Command, s as CommandKeymap, t as Binding, u as CommandsOptions, v as PendingSequence, w as SerializedBinding, x as RunOptions, y as PlatformBindings } from "./types-D-hUKGoN.mjs";
-import { _ as seq, a as RebindOptions, c as createRebinder, d as webStorage, f as ariaKeyShortcuts, g as isSingleKeyBinding, h as spokenBinding, i as RebindMode, l as exportKeymap, m as formatBinding, n as CommandId, o as RebindState, p as bindingTokens, r as createCommands, s as Rebinder, t as matchCommands, u as importKeymap } from "./index-DRXMJmbc.mjs";
+import { C as Chord, S as SerializedKeymap, T as Platform, _ as RunBlockReason, a as CommandDefinition, b as SequenceBinding, c as CommandSource, d as Conflict, f as ConflictOptions, g as PlatformBindings, h as KeymapStore, i as CommandContext, l as Commands, m as KeyCapture, n as BindingInput, o as CommandHandler, p as Json, r as Command, s as CommandKeymap, t as Binding, u as CommandsOptions, v as RunOptions, w as Key, x as SerializedBinding, y as ScopeOptions } from "./types-BxMI3b4a.mjs";
+import { a as Rebinder, c as importKeymap, d as bindingTokens, f as formatBinding, i as RebindState, l as webStorage, m as seq, n as createCommands, o as createRebinder, p as isSingleKeyBinding, r as RebindOptions, s as exportKeymap, t as CommandId, u as ariaKeyShortcuts } from "./index-BnB38jCF.mjs";
 //#region src/react/hooks.d.ts
 /**
  * Mounts a commands registry for the lifecycle of the component.
@@ -22,15 +22,13 @@ export declare function useCommands<Id extends string>(registry: Commands<Id>):
 /** Returns one command's snapshot, re-rendering only when that command changes. */
 export declare function useCommand<Id extends string>(registry: Commands<Id>, id: NoInfer<Id>): Command<Id> | undefined;
 /**
- * Returns display and accessibility shortcuts for a command's primary
- * binding: `tokens` for `<kbd>` elements, `aria` for `aria-keyshortcuts`
- * (chords only), and `spoken` for screen-reader text such as `"G then I"`.
+ * Returns a command's primary binding for people: `display` to read,
+ * `tokens` for `<kbd>` elements, and `aria` for `aria-keyshortcuts` (chords only).
  */
 export declare function useShortcut<Id extends string>(registry: Commands<Id>, id: NoInfer<Id>): {
   display: string;
   tokens: ReadonlyArray<string>;
   aria: string;
-  spoken: string;
 };
 /**
  * Activates a scope for the lifecycle of the component. Scopes rank in the
@@ -65,17 +63,14 @@ interface UseRebindResult<Id extends string = string> extends RebindState<Id> {
   /** Whether the shortcut has been customized by the user. */
   overridden: boolean;
   start: () => void;
-  stop: () => void;
   cancel: () => void;
   commit: () => void;
+  /** Unbinds the command. */
   clear: () => void;
+  /** Restores the default shortcut. */
   reset: () => void;
 }
 /** Hook for recording and configuring a command's keybindings. */
 export declare function useRebind<Id extends string>(registry: Commands<Id>, id: NoInfer<Id>, options?: RebindOptions<Id>): UseRebindResult<Id>;
-/** Returns the keys held down right now, by the name `KeyboardEvent.key` gives each. */
-export declare function useHeldKeys(): ReadonlyArray<string>;
-/** Returns the half-typed sequences, for a hint such as "G …". */
-export declare function usePendingSequences<Id extends string>(registry: Commands<Id>): ReadonlyArray<PendingSequence<Id>>;
 //#endregion
-export { type Binding, type BindingInput, type Chord, type Command, type CommandContext, type CommandDefinition, type CommandHandler, type CommandId, type CommandKeymap, type CommandSource, type Commands, type CommandsOptions, type Conflict, type ConflictOptions, type DisplayOptions, type Json, type Key, type KeyCapture, type KeymapStore, type Override, type PendingSequence, type Platform, type PlatformBindings, type RebindMode, type RebindOptions, type RebindState, type Rebinder, type RunBlockReason, type RunOptions, type ScopeOptions, type SequenceBinding, type SerializedBinding, type SerializedKeymap, type SerializedOverride, type UseRebindResult, ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, matchCommands, seq, spokenBinding, webStorage };
+export { type Binding, type BindingInput, type Chord, type Command, type CommandContext, type CommandDefinition, type CommandHandler, type CommandId, type CommandKeymap, type CommandSource, type Commands, type CommandsOptions, type Conflict, type ConflictOptions, type Json, type Key, type KeyCapture, type KeymapStore, type Platform, type PlatformBindings, type RebindOptions, type RebindState, type Rebinder, type RunBlockReason, type RunOptions, type ScopeOptions, type SequenceBinding, type SerializedBinding, type SerializedKeymap, type UseRebindResult, ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, seq, webStorage };

package/dist/react.mjs

@@ -1,66 +1,8 @@
 "use client";
-import { a as importKeymap, c as bindingTokens, d as isSingleKeyBinding, f as seq, i as exportKeymap, l as formatBinding, m as keyName, n as createCommands, o as webStorage, p as isModifierKey, r as createRebinder, s as ariaKeyShortcuts, t as matchCommands, u as spokenBinding } from "./src-TaZw4V61.mjs";
+import { a as webStorage, c as formatBinding, i as importKeymap, l as isSingleKeyBinding, n as createRebinder, o as ariaKeyShortcuts, r as exportKeymap, s as bindingTokens, t as createCommands, u as seq } from "./src-CGKvYKjd.mjs";
 import { useCallback, useEffect, useMemo, useRef, useSyncExternalStore } from "react";
-//#region src/held.ts
-/** Which keys are down right now. Listens only while something is subscribed. */
-const NONE = [];
-/** Held keys by physical key, so two keys producing one character stay apart. */
-const down = /* @__PURE__ */ new Map();
-const listeners = /* @__PURE__ */ new Set();
-let held = NONE;
-const identify = (event) => event.code || `key:${keyName(event.key)}`;
-function publish() {
-	held = down.size === 0 ? NONE : [...new Set(down.values())];
-	for (const listener of listeners) listener();
-}
-function onKeyDown(event) {
-	if (!event.key || down.has(identify(event))) return;
-	down.set(identify(event), keyName(event.key));
-	publish();
-}
-function onKeyUp(event) {
-	down.delete(identify(event));
-	if (event.key === "Meta") {
-		for (const [identity, key] of down) if (!isModifierKey(key)) down.delete(identity);
-	}
-	publish();
-}
-/** Leaving the window or hiding the page swallows the keyups, so nothing is held any more. */
-function onLeave() {
-	if (down.size === 0) return;
-	down.clear();
-	publish();
-}
-/** The keys held right now, by name. Empty unless something is subscribed. */
-function heldKeys() {
-	return held;
-}
-/** Watches held keys until the returned function is called. */
-function subscribeHeldKeys(listener) {
-	listeners.add(listener);
-	if (listeners.size === 1) {
-		document.addEventListener("keydown", onKeyDown, true);
-		document.addEventListener("keyup", onKeyUp, true);
-		document.addEventListener("visibilitychange", onLeave);
-		window.addEventListener("blur", onLeave);
-	}
-	return () => {
-		listeners.delete(listener);
-		if (listeners.size > 0) return;
-		document.removeEventListener("keydown", onKeyDown, true);
-		document.removeEventListener("keyup", onKeyUp, true);
-		document.removeEventListener("visibilitychange", onLeave);
-		window.removeEventListener("blur", onLeave);
-		down.clear();
-		held = NONE;
-	};
-}
-//#endregion
 //#region src/react/hooks.ts
 const EMPTY_TOKENS = [];
-const EMPTY_PENDING = [];
-const getEmptyTokens = () => EMPTY_TOKENS;
-const getEmptyPending = () => EMPTY_PENDING;
 /**
 * Mounts a commands registry for the lifecycle of the component.
 *
@@ -94,17 +36,15 @@ function useCommand(registry, id) {
 	return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);
 }
 /**
-* Returns display and accessibility shortcuts for a command's primary
-* binding: `tokens` for `<kbd>` elements, `aria` for `aria-keyshortcuts`
-* (chords only), and `spoken` for screen-reader text such as `"G then I"`.
+* Returns a command's primary binding for people: `display` to read,
+* `tokens` for `<kbd>` elements, and `aria` for `aria-keyshortcuts` (chords only).
 */
 function useShortcut(registry, id) {
 	const command = useCommand(registry, id);
 	return useMemo(() => ({
 		display: command?.display[0] ?? "",
 		tokens: command?.tokens[0] ?? EMPTY_TOKENS,
-		aria: command?.aria ?? "",
-		spoken: command?.spoken ?? ""
+		aria: command?.aria ?? ""
 	}), [command]);
 }
 /**
@@ -157,31 +97,21 @@ function useCommandHandler(registry, id, run, enabled = true) {
 function useRebind(registry, id, options = {}) {
 	const latest = useRef(options);
 	latest.current = options;
-	const mode = options.mode ?? "chord";
+	const sequence = options.sequence === true;
 	const rebinder = useMemo(() => createRebinder(registry, id, {
-		mode,
+		sequence,
 		get apply() {
 			return latest.current.apply;
 		},
-		get add() {
-			return latest.current.add;
-		},
 		get rejectConflicts() {
 			return latest.current.rejectConflicts;
 		},
-		get ignoreInputs() {
-			return latest.current.ignoreInputs;
-		},
-		get idleTimeout() {
-			return latest.current.idleTimeout;
-		},
 		onRecord: (binding, conflicts) => latest.current.onRecord?.(binding, conflicts),
-		onCancel: () => latest.current.onCancel?.(),
-		onClear: () => latest.current.onClear?.()
+		onCancel: () => latest.current.onCancel?.()
 	}), [
 		registry,
 		id,
-		mode
+		sequence
 	]);
 	useEffect(() => rebinder.destroy, [rebinder]);
 	const getState = useCallback(() => rebinder.state, [rebinder]);
@@ -193,7 +123,6 @@ function useRebind(registry, id, options = {}) {
 		tokens: command?.tokens[0] ?? EMPTY_TOKENS,
 		overridden: command?.overridden ?? false,
 		start: rebinder.start,
-		stop: rebinder.stop,
 		cancel: rebinder.cancel,
 		commit: rebinder.commit,
 		clear: () => registry.keymap.set(id, null),
@@ -206,15 +135,5 @@ function useRebind(registry, id, options = {}) {
 		id
 	]);
 }
-/** Returns the keys held down right now, by the name `KeyboardEvent.key` gives each. */
-function useHeldKeys() {
-	return useSyncExternalStore(subscribeHeldKeys, heldKeys, getEmptyTokens);
-}
-/** Returns the half-typed sequences, for a hint such as "G …". */
-function usePendingSequences(registry) {
-	const subscribe = useCallback((onChange) => registry.subscribePending(onChange), [registry]);
-	const getSnapshot = useCallback(() => registry.pending(), [registry]);
-	return useSyncExternalStore(subscribe, getSnapshot, getEmptyPending);
-}
 //#endregion
-export { ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, matchCommands, seq, spokenBinding, useCommand, useCommandHandler, useCommands, useHeldKeys, useMountCommands, usePendingSequences, useRebind, useScope, useShortcut, webStorage };
+export { ariaKeyShortcuts, bindingTokens, createCommands, createRebinder, exportKeymap, formatBinding, importKeymap, isSingleKeyBinding, seq, useCommand, useCommandHandler, useCommands, useMountCommands, useRebind, useScope, useShortcut, webStorage };