Type alias CommandContribution

CommandContribution: {
    category?: string;
    commandPalette?: false;
    description?: string;
    icon?: {
        dark?: string;
        light: string;
    };
    id: string;
    title?: string;
}

Type declaration

  • Optional category?: string

    Category can be used by the UI to group or filter the command.

  • Optional commandPalette?: false

    By default, all commands will be available to the command palette. Set this to false to prevent it from appearing in the command palette.

  • Optional description?: string

    Detail description about the command. It will support some formatting such as markdown, but not confirmed yet.

  • Optional icon?: {
        dark?: string;
        light: string;
    }
    • Optional dark?: string

      If not specified, the light icon will be used.

    • light: string
  • id: string

    The command id. e.g. just-web.showCommandPalette

    It should be unique across the application. It should follow the <plugin>.<name> pattern.

    For example: just-web.showCommandPalette The resulting command function will also have this as the name.

  • Optional title?: string

    Name of the command such as Show command palette. If not specified, it is default to Sentence Case of the second part of the id.

Generated using TypeDoc