Interface KeyBindingOptions

Options to configure the behavior of keybindings.

interface KeyBindingOptions {
    capture?: boolean;
    event?: "keydown" | "keyup";
    timeout?: number;
}

Properties

capture?: boolean

Key presses will use a capture listener (default: false)

event?: "keydown" | "keyup"

Key presses will listen to this event (default: "keydown").

timeout?: number

Keybinding sequences will wait this long between key presses before cancelling (default: 1000).

Note: Setting this value too low (i.e. 300) will be too fast for many of your users.