Skip to content
On this page

Types

KeyBindingCallbackMap

Represents the key binded by the library.

Properties

NameTypeMandatory
callbacksKeyBindingCallbackstrue
optionsKeyBindingOptionsfalse

KeyBindingCallbacks

Represents the callbacks binded by the library.

Properties

NameTypeMandatory
keyupCallback(e?: KeyboardEvent) => voidfalse
keydownCallback(e?: KeyboardEvent) => voidtrue

KeyComboOption

Represent the combo options. Available formats are:

Meta, Ctrl, Shift, Alt

KeyBindingOptions

Represent the available options for binding.

Properties

NameTypeMandatory
preventRepeatOnKeyDownbooleanfalse
enableWithComboKeyComboOptionfalse