Class Menu

A type that is either a menu bar on the window on Windows and Linux or as a global menu in the menubar on macOS.

Platform-specific:

macOS: if using Menu for the global menubar, it can only contain Submenus.

Hierarchy

MenuItemBase
- Menu

Index

Accessors

rid id

Methods

close new default append prepend insert remove removeAt items get popup setAsAppMenu setAsWindowMenu

Accessors

rid

get rid(): number
Returns number
Inherited from MenuItemBase.rid
- Defined in core.ts:309

id

get id(): string
The id of this item.

Returns string
Inherited from MenuItemBase.id
- Defined in menu/base.ts:128

Methods

close

close(): Promise<void>
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
- Defined in core.ts:321

`Static`new

new(opts?: MenuOptions): Promise<Menu>
Create a new menu.
Parameters
- Optionalopts: MenuOptions
Returns Promise<Menu>
- Defined in menu/menu.ts:55

`Static`default

default(): Promise<Menu>
Create a default menu.

Returns Promise<Menu>
- Defined in menu/menu.ts:60

append

append<
    T extends
        | CheckMenuItemOptions
        | MenuItemOptions
        | CheckMenuItem
        | SubmenuOptions
        | PredefinedMenuItemOptions
        | IconMenuItemOptions
        | IconMenuItem
        | PredefinedMenuItem
        | Submenu
        | MenuItem,
>(
    items: T | T[],
): Promise<void>
Add a menu item to the end of this menu.

Platform-specific:
- macOS: Only Submenus can be added to a Menu.
Type Parameters
- T extends
      | CheckMenuItemOptions
      | MenuItemOptions
      | CheckMenuItem
      | SubmenuOptions
      | PredefinedMenuItemOptions
      | IconMenuItemOptions
      | IconMenuItem
      | PredefinedMenuItem
      | Submenu
      | MenuItem
Parameters
- items: T | T[]
Returns Promise<void>
- Defined in menu/menu.ts:73

prepend

prepend<
    T extends
        | CheckMenuItemOptions
        | MenuItemOptions
        | CheckMenuItem
        | SubmenuOptions
        | PredefinedMenuItemOptions
        | IconMenuItemOptions
        | IconMenuItem
        | PredefinedMenuItem
        | Submenu
        | MenuItem,
>(
    items: T | T[],
): Promise<void>
Add a menu item to the beginning of this menu.

Platform-specific:
- macOS: Only Submenus can be added to a Menu.
Type Parameters
- T extends
      | CheckMenuItemOptions
      | MenuItemOptions
      | CheckMenuItem
      | SubmenuOptions
      | PredefinedMenuItemOptions
      | IconMenuItemOptions
      | IconMenuItem
      | PredefinedMenuItem
      | Submenu
      | MenuItem
Parameters
- items: T | T[]
Returns Promise<void>
- Defined in menu/menu.ts:102

insert

insert<
    T extends
        | CheckMenuItemOptions
        | MenuItemOptions
        | CheckMenuItem
        | SubmenuOptions
        | PredefinedMenuItemOptions
        | IconMenuItemOptions
        | IconMenuItem
        | PredefinedMenuItem
        | Submenu
        | MenuItem,
>(
    items: T | T[],
    position: number,
): Promise<void>
Add a menu item to the specified position in this menu.

Platform-specific:
- macOS: Only Submenus can be added to a Menu.
Type Parameters
- T extends
      | CheckMenuItemOptions
      | MenuItemOptions
      | CheckMenuItem
      | SubmenuOptions
      | PredefinedMenuItemOptions
      | IconMenuItemOptions
      | IconMenuItem
      | PredefinedMenuItem
      | Submenu
      | MenuItem
Parameters
- items: T | T[]
- position: number
Returns Promise<void>
- Defined in menu/menu.ts:131

remove

remove(
    item:
        | CheckMenuItem
        | IconMenuItem
        | PredefinedMenuItem
        | Submenu
        | MenuItem,
): Promise<void>
Remove a menu item from this menu.
Parameters
- item: CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem
Returns Promise<void>
- Defined in menu/menu.ts:155

removeAt

removeAt(
    position: number,
): Promise<
    | null
    | CheckMenuItem
    | IconMenuItem
    | PredefinedMenuItem
    | Submenu
    | MenuItem,
>
Remove a menu item from this menu at the specified position.
Parameters
- position: number
Returns Promise<
    | null
    | CheckMenuItem
    | IconMenuItem
    | PredefinedMenuItem
    | Submenu
    | MenuItem,
>
- Defined in menu/menu.ts:166

items

items(): Promise<
(CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem)[],
>
Returns a list of menu items that has been added to this menu.

Returns Promise<
(CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem)[],
>
- Defined in menu/menu.ts:184

get

get(
    id: string,
): Promise<
    | null
    | CheckMenuItem
    | IconMenuItem
    | PredefinedMenuItem
    | Submenu
    | MenuItem,
>
Retrieves the menu item matching the given identifier.
Parameters
- id: string
Returns Promise<
    | null
    | CheckMenuItem
    | IconMenuItem
    | PredefinedMenuItem
    | Submenu
    | MenuItem,
>
- Defined in menu/menu.ts:196

popup(
at?: dpi.LogicalPosition | dpi.PhysicalPosition | Position,
window?: Window,
): Promise<void>
Popup this menu as a context menu on the specified window.
Parameters
- Optionalat: dpi.LogicalPosition | dpi.PhysicalPosition | Position
  If a position is provided, it is relative to the window's top-left corner. If there isn't one provided, the menu will pop up at the current location of the mouse.
- Optionalwindow: Window
Returns Promise<void>
- Defined in menu/menu.ts:219

setAsAppMenu

setAsAppMenu(): Promise<null | Menu>
Sets the app-wide menu and returns the previous one.

If a window was not created with an explicit menu or had one set explicitly, this menu will be assigned to it.

Returns Promise<null | Menu>
- Defined in menu/menu.ts:237

setAsWindowMenu

setAsWindowMenu(window?: Window): Promise<null | Menu>
Sets the window menu and returns the previous one.

Platform-specific:
- macOS: Unsupported. The menu on macOS is app-wide and not specific to one window, if you need to set it, use Menu.setAsAppMenu instead.
Parameters
- Optionalwindow: Window
Returns Promise<null | Menu>
- Defined in menu/menu.ts:251

Class Menu

Platform-specific:

Hierarchy

Index

Accessors

Methods

Accessors

rid

Returns number

id

Returns string

Methods

close

Returns Promise<void>

Staticnew

Parameters

Returns Promise<Menu>

Staticdefault

Returns Promise<Menu>

append

Platform-specific:

Type Parameters

Parameters

Returns Promise<void>

prepend

Platform-specific:

Type Parameters

Parameters

Returns Promise<void>

insert

Platform-specific:

Type Parameters

Parameters

Returns Promise<void>

remove

Parameters

Returns Promise<void>

removeAt

Parameters

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

items

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

get

Parameters

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

popup

Parameters

Returns Promise<void>

setAsAppMenu

Returns Promise<null | Menu>

setAsWindowMenu

Platform-specific:

Parameters

Returns Promise<null | Menu>

Settings

On This Page

`Static`new

`Static`default

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

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

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