Optional configuration for Hotkey.Register and Hotkey.OnDown.

interface HotkeyOptions {
    block?: boolean;
    wildcard?: boolean;
    deviceId?: string;
}

Properties

block?: boolean

If true (default), the triggering key is suppressed from reaching other applications. For combos with modifier keys, any modifiers that leaked to the foreground application before the combo was fully recognized also receive automatic synthetic key-up events, leaving the application in a clean modifier state. The suppressed key-down's paired key-up is also automatically suppressed. Set to false to observe the hotkey while still letting the OS process it normally. Forced to false when deviceId is set.

wildcard?: boolean

If true, the hotkey triggers even when extra modifiers are held. Defaults to false (exact modifier match).

deviceId?: string

Device path string to limit the hotkey to a specific physical device. Use Keyboard.OnRawEvent to discover device paths. Device-filtered hotkeys are always non-blocking (passthrough).