Skip to content

Documentation / joplin-plugin-api / MenuItem

Interface: MenuItem

Defined in: types.ts:294

Properties

accelerator?

optional accelerator: string

Defined in: types.ts:315

Accelerator associated with the menu item


commandArgs?

optional commandArgs: any[]

Defined in: types.ts:305

Arguments that should be passed to the command. They will be as rest parameters.


commandName?

optional commandName: string

Defined in: types.ts:299

Command that should be associated with the menu item. All menu item should have a command associated with them unless they are a sub-menu.


label?

optional label: string

Defined in: types.ts:325

Menu item label. If not specified, the command label will be used instead.


optional submenu: MenuItem[]

Defined in: types.ts:320

Menu items that should appear below this menu item. Allows creating a menu tree.


type?

optional type: "normal" | "separator" | "submenu" | "checkbox" | "radio"

Defined in: types.ts:310

Set to "separator" to create a divider line

Released under the MIT License.