Skip to main content

KeyCombination

KeyCombination = object

Properties

alt

alt: boolean

When true requires the alt/option key to be press.

Default

false

autoMacStyle

autoMacStyle: boolean

Automatically convert the hotkey to the common macOS style, e.g. ctl+shift+g becomes cmd+shift+g to better align with user expectations.


code

code: Keycode

The primary key to trigger on. Use the Keycode enum to ensure compatibility.


ctrl

ctrl: boolean

When true requires the control key to be press.

If autoMacStyle is true then this will switch to the command key.

Default

false

id

id: KeyCombinationId

The id of the key combination.


meta

meta: boolean


shift

shift: boolean

When true requires the shift key to be press.

Default

false