Documentation / joplin-plugin-api / MenuItem

Interface: MenuItem

Properties

accelerator?

optional accelerator: string

Accelerator associated with the menu item

Defined in

types.ts:315

---

commandArgs?

optional commandArgs: any[]

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

Defined in

types.ts:305

---

commandName?

optional commandName: string

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.

Defined in

types.ts:299

---

label?

optional label: string

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

Defined in

types.ts:325

---

submenu?

optional submenu: MenuItem[]

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

Defined in

types.ts:320

---

type?

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

Set to "separator" to create a divider line

Defined in

types.ts:310