Submenu

Defined in: menu/submenu.ts:53

A type that is a submenu inside a Menu or Submenu.

Extends

• MenuItemBase

Accessors

id

Get Signature

get id(): string

Defined in: menu/base.ts:128

The id of this item.

Returns

string

Inherited from

MenuItemBase.id

---

rid

Get Signature

get rid(): number

Defined in: core.ts:309

Returns

number

Inherited from

MenuItemBase.rid

Methods

append()

append<T>(items): Promise<void>

Defined in: menu/submenu.ts:99

Add a menu item to the end of this submenu.

Platform-specific:

• macOS: Only Submenus can be added to a Menu.

Type Parameters

T

T extends CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

Parameters

items

T | T[]

Returns

Promise<void>

---

close()

close(): Promise<void>

Defined in: core.ts:321

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Inherited from

MenuItemBase.close

---

get()

get(id): Promise<null | CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem>

Defined in: menu/submenu.ts:222

Retrieves the menu item matching the given identifier.

Parameters

id

string

Returns

Promise<null | CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem>

---

insert()

insert<T>(items, position): Promise<void>

Defined in: menu/submenu.ts:157

Add a menu item to the specified position in this submenu.

Platform-specific:

• macOS: Only Submenus can be added to a Menu.

Type Parameters

T

T extends CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

Parameters

items

T | T[]

position

number

Returns

Promise<void>

---

isEnabled()

isEnabled(): Promise<boolean>

Defined in: menu/submenu.ts:79

Returns whether this submenu is enabled or not.

Returns

Promise<boolean>

---

items()

items(): Promise<(CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem)[]>

Defined in: menu/submenu.ts:210

Returns a list of menu items that has been added to this submenu.

Returns

Promise<(CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem)[]>

---

popup()

popup(at?, window?): Promise<void>

Defined in: menu/submenu.ts:244

Popup this submenu as a context menu on the specified window.

If the position, is provided, it is relative to the window’s top-left corner.

Parameters

at?

LogicalPosition | PhysicalPosition

window?

Window

Returns

Promise<void>

---

prepend()

prepend<T>(items): Promise<void>

Defined in: menu/submenu.ts:128

Add a menu item to the beginning of this submenu.

Platform-specific:

• macOS: Only Submenus can be added to a Menu.

Type Parameters

T

T extends CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

Parameters

items

T | T[]

Returns

Promise<void>

---

remove()

remove(item): Promise<void>

Defined in: menu/submenu.ts:181

Remove a menu item from this submenu.

Parameters

item

CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

Returns

Promise<void>

---

removeAt()

removeAt(position): Promise<null | CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem>

Defined in: menu/submenu.ts:192

Remove a menu item from this submenu at the specified position.

Parameters

position

number

Returns

Promise<null | CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem>

---

setAsHelpMenuForNSApp()

setAsHelpMenuForNSApp(): Promise<void>

Defined in: menu/submenu.ts:284

Set this submenu as the Help menu for the application on macOS.

This will cause macOS to automatically add a search box to the menu.

If no menu is set as the Help menu, macOS will automatically use any menu which has a title matching the localized word “Help”.

Platform-specific:

• Windows / Linux: Unsupported.

Returns

Promise<void>

---

setAsWindowsMenuForNSApp()

setAsWindowsMenuForNSApp(): Promise<void>

Defined in: menu/submenu.ts:266

Set this submenu as the Window menu for the application on macOS.

This will cause macOS to automatically add window-switching items and certain other items to the menu.

Platform-specific:

• Windows / Linux: Unsupported.

Returns

Promise<void>

---

setEnabled()

setEnabled(enabled): Promise<void>

Defined in: menu/submenu.ts:84

Sets whether this submenu is enabled or not.

Parameters

enabled

boolean

Returns

Promise<void>

---

setText()

setText(text): Promise<void>

Defined in: menu/submenu.ts:70

Sets the text for this submenu.

Parameters

text

string

Returns

Promise<void>

---

text()

text(): Promise<string>

Defined in: menu/submenu.ts:65

Returns the text of this submenu.

Returns

Promise<string>

---

new()

static new(opts): Promise<Submenu>

Defined in: menu/submenu.ts:60

Create a new submenu.

Parameters

opts

SubmenuOptions

Returns

Promise<Submenu>