Interface IPaletteItem

The options for creating a command palette item.

interface IPaletteItem {
    args?: ReadonlyJSONObject;
    category: string;
    command: string;
    rank?: number;
}

Hierarchy

  • IItemOptions
    • IPaletteItem

Properties

args? category command rank?

Properties

Optional args

args?: ReadonlyJSONObject

The arguments for the command.

The default value is an empty object.

category

category: string

The category for the item.

command

command: string

The command to execute when the item is triggered.

Optional rank

rank?: number

The rank for the command item.

The rank is used as a tie-breaker when ordering command items for display. Items are sorted in the following order:

  1. Text match (lower is better)
  2. Category (locale order)
  3. Rank (lower is better)
  4. Label (locale order)

The default rank is Infinity.

Settings

Member Visibility

Theme

On This Page

argscategorycommandrank