Class Submenu

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

Hierarchy

MenuItemBase
- Submenu

Index

Accessors

Methods

close new text setText isEnabled setEnabled append prepend insert remove removeAt items get popup setAsWindowsMenuForNSApp setAsHelpMenuForNSApp

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: SubmenuOptions): Promise<Submenu>
Create a new submenu.
Parameters
- opts: SubmenuOptions
Returns Promise<Submenu>
- Defined in menu/submenu.ts:60

text

text(): Promise<string>
Returns the text of this submenu.

Returns Promise<string>
- Defined in menu/submenu.ts:65

setText

setText(text: string): Promise<void>
Sets the text for this submenu.
Parameters
- text: string
Returns Promise<void>
- Defined in menu/submenu.ts:70

isEnabled

isEnabled(): Promise<boolean>
Returns whether this submenu is enabled or not.

Returns Promise<boolean>
- Defined in menu/submenu.ts:79

setEnabled

setEnabled(enabled: boolean): Promise<void>
Sets whether this submenu is enabled or not.
Parameters
- enabled: boolean
Returns Promise<void>
- Defined in menu/submenu.ts:84

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 submenu.

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/submenu.ts:99

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 submenu.

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/submenu.ts:128

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 submenu.

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/submenu.ts:157

remove

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

removeAt

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

items

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

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

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/submenu.ts:222

popup(
at?: dpi.LogicalPosition | dpi.PhysicalPosition,
window?: Window,
): Promise<void>
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
- Optionalat: dpi.LogicalPosition | dpi.PhysicalPosition
- Optionalwindow: Window
Returns Promise<void>
- Defined in menu/submenu.ts:244

setAsWindowsMenuForNSApp

setAsWindowsMenuForNSApp(): Promise<void>
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>
- Defined in menu/submenu.ts:266

setAsHelpMenuForNSApp

setAsHelpMenuForNSApp(): Promise<void>
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>
- Defined in menu/submenu.ts:284

Class Submenu

Hierarchy

Index

Accessors

Methods

Accessors

rid

Returns number

id

Returns string

Methods

close

Returns Promise<void>

Staticnew

Parameters

Returns Promise<Submenu>

text

Returns Promise<string>

setText

Parameters

Returns Promise<void>

isEnabled

Returns Promise<boolean>

setEnabled

Parameters

Returns Promise<void>

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>

setAsWindowsMenuForNSApp

Platform-specific:

Returns Promise<void>

setAsHelpMenuForNSApp

Platform-specific:

Returns Promise<void>

Settings

On This Page

`Static`new

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

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

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