Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IItemOptions

An options object for creating a command item.

Hierarchy

  • IItemOptions

Index

Properties

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.

Generated using TypeDoc