An interface describing a JupyterLab keyboard shortcut.

interface IShortcut {
    args?: PartialJSONObject;
    command: string;
    disabled?: boolean;
    keys: string[];
    selector: string;


  • PartialJSONObject
    • IShortcut


args?: PartialJSONObject

The optional arguments passed into the shortcut's command.

command: string

The command invoked by the shortcut.

disabled?: boolean

Whether a keyboard shortcut is disabled. False by default.

keys: string[]

The key sequence of the shortcut.


If this is a list like ['Ctrl A', 'B'], the user needs to press Ctrl A followed by B to trigger the shortcuts.

selector: string

The CSS selector applicable to the shortcut.