Interface Command

One palette entry.

interface Command {
    id: string;
    run: (ctx: CommandContext) => void;
    shortcut?: string;
    title: string;
    when?: (ctx: CommandContext) => boolean;
}

Properties

id: string

Stable kebab-case id.

run: (ctx: CommandContext) => void

shortcut?: string

Display + binding, e.g. "P" or "Ctrl+S". Omit for palette-only actions.

title: string

Title shown in the palette.

when?: (ctx: CommandContext) => boolean

When false the action is hidden and its shortcut inert.