TanStack

isHotkeyHintVisible

ts
function isHotkeyHintVisible(
   hotkey, 
   heldKeys, 
   options?, 
   appHotkeysStore?
): boolean;

Defined in: adapter.ts:613

Whether a hotkey's hint shows: its modifiers are held and a registration that can fire exists. App hotkeys resolve through appHotkeysStore. Adapters read the held keys and registrations reactively, then call this.

Parameters

hotkey

| RegisterableHotkey | AppHotkey<string, HotkeyChord | HotkeySequence | null> | null | undefined

heldKeys

readonly string[]

options?

HeldModifierOptions = {}

appHotkeysStore?

| AppHotkeysStore<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>> | null

Returns

boolean