@tanstack/react-hotkeys/dist/useHotkeyHint.js

React adapter for TanStack Hotkeys

import { useAppHotkeysStoreState } from "./_appHotkeysStore.js";
import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
import { useSelector } from "@tanstack/react-store";

//#region src/useHotkeyHint.ts
/**
* Returns a boolean indicating whether held modifiers reveal this shortcut.
* The hint shows only while the hotkey can fire: some registration of it is
* enabled and in an active scope. An app hotkey matches its registrations by
* id and uses its effective hotkey (false while unbound).
* Uses the nonempty-subset/AltGr rules of `matchesHeldModifiers`; `exact`
* requires every modifier. A sequence reveals its hint from its first step.
* Only visibility changes cause a rerender. This helper does not register a shortcut. A hotkey on an element counts only while focus is inside it.
*/
function useHotkeyHint(hotkey, options = {}) {
	const store = useAppHotkeysStoreState();
	const resolved = isAppHotkey(hotkey) ? resolveAppHotkey(hotkey, store).hotkey : hotkey;
	const manager = getHotkeyManager();
	const active = useSelector(manager.registrations, () => resolved !== null && manager.hasActiveRegistration(hotkey));
	const held = useSelector(getKeyStateTracker().store, (state) => resolved !== null && matchesHeldModifiers(resolved, state.heldKeys, options));
	return active && held;
}

//#endregion
export { useHotkeyHint };