Interface KeyBinding

interface KeyBinding {
    action: KeyAction;
    combo: string;
    command: null | string;
    defaultCombo: string;
    group: string;
    hidden: boolean;
    id: number;
    inText: boolean;
    label: string;
    layered: boolean;
    rebindable: boolean;
    scope: KeyScope;
    when?: () => boolean;
}

Properties

action combo command defaultCombo group hidden id inText label layered rebindable scope when?

Properties

Readonlyaction

action: KeyAction

Readonlycombo

combo: string

Canonical chord in force (see parseKeyCombo): the default, or the user's. '' while unbound.

Readonlycommand

command: null | string

Its stable name, or null for a binding registered without one.

ReadonlydefaultCombo

defaultCombo: string

The chord it was registered with, which reset returns it to.

Readonlygroup

group: string

Readonlyhidden

hidden: boolean

Readonlyid

id: number

Registration number, in the order bindings were made.

ReadonlyinText

inText: boolean

Readonlylabel

label: string

Readonlylayered

layered: boolean

Shares its chord deliberately; see KeyBindingOptions.layered.

Readonlyrebindable

rebindable: boolean

Whether rebind may move it.

Readonlyscope

scope: KeyScope

Optional Readonlywhen

when?: () => boolean

Settings

Member Visibility

On This Page

Properties