Interface IItemOptions

An options object for creating a menu item.

interface IItemOptions {
    args?: ReadonlyJSONObject;
    command?: string;
    rank?: number;
    submenu?: null | Menu;
    type?: ItemType;
}

Hierarchy

Properties

args? command? rank? submenu? type?

Properties

Optional args

args?: ReadonlyJSONObject

The arguments for the command.

The default value is an empty object.

Optional command

command?: string

The command to execute when the item is triggered.

The default value is an empty string.

Optional rank

rank?: number

Menu item rank

Optional submenu

submenu?: null | Menu

The submenu for a 'submenu' type item.

The default value is null.

Optional type

type?: ItemType

The type of the menu item.

The default value is 'command'.

Settings

Member Visibility

Theme

On This Page

argscommandranksubmenutype