Interface IKeyBinding

An object which represents a key binding.

Notes

A key binding is an immutable object created by a registry.

interface IKeyBinding {
    args: ReadonlyPartialJSONObject;
    command: string;
    keys: readonly string[];
    preventDefault?: boolean;
    selector: string;
}

Properties

args command keys preventDefault? selector

Properties

Readonly args

args: ReadonlyPartialJSONObject

The arguments for the command.

Readonly command

command: string

The command executed when the binding is matched.

Readonly keys

keys: readonly string[]

The key sequence for the binding.

Optional Readonly preventDefault

preventDefault?: boolean

Whether to prevent default action of the keyboard events during sequence matching.

The default value is true.

Readonly selector

selector: string

The CSS selector for the binding.

Settings

Member Visibility

Theme

On This Page

argscommandkeyspreventDefaultselector