Interface IParsedKeyBinding

A keyboard shortcut (modeled after CodeMirror 6 KeyBindings).

interface IParsedKeyBinding {
    focusAfter?: (() => HTMLElement);
    key: string;
    keys: string[];
    mac?: string;
    preventDefault?: boolean;
    run?: (() => void);
    shift?: (() => void);
}

Hierarchy (view full)

Properties

focusAfter? key keys mac? preventDefault? run? shift?

Properties

Optional focusAfter

focusAfter?: (() => HTMLElement)

Specify an element to focus after running the action (defaults to the closest editor).

Type declaration

    • (): HTMLElement

    • Returns HTMLElement

key

key: string

The key(s) to press.

keys

keys: string[]

Optional mac

mac?: string

The key(s) to press on a Mac.

Optional preventDefault

preventDefault?: boolean

Whether the key(s) default action should be prevented or not.

Optional run

run?: (() => void)

The command to run.

Type declaration

    • (): void

    • Returns void

Optional shift

shift?: (() => void)

The command to run when the shift key is held down.

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

On This Page

focusAfterkeykeysmacpreventDefaultrunshift