injectHotkeyHint

function injectHotkeyHint(hotkey, options?): Signal<boolean>;

function injectHotkeyHint(hotkey, options?): Signal<boolean>;

Defined in: injectHotkeyHint.ts:24

Returns a signal indicating whether held modifiers reveal this shortcut. Pass getters to track changing hotkeys and options. A sequence reveals its hint from its first step, and an app hotkey uses its effective hotkey (false while unbound). This helper does not register a shortcut or check whether its target is focused.

Parameters

hotkey

| RegisterableHotkey | AppHotkey<string, HotkeyChord | HotkeySequence | null> | (() => RegisterableHotkey | AppHotkey<string, HotkeyChord | HotkeySequence | null>)

options?

HeldModifierOptions | (() => HeldModifierOptions)

Returns

Signal<boolean>