Parameter	Type
`checked`	`boolean`

Parameter	Type
`opts`	`CheckMenuItemOptions`

Parameter	Type
`opts`	`IconMenuItemOptions`

Parameter	Type	Description
`at?`	\| `PhysicalPosition` \| `LogicalPosition` \| `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.
`window?`	`Window`	The window to show the menu on. Defaults to the current window.

Returns

Promise<void>

Example

import { Menu } from '@tauri-apps/api/menu';
import { LogicalPosition } from '@tauri-apps/api/dpi';

const menu = await Menu.new({
  items: [{ id: 'copy', text: 'Copy', action: () => console.log('copy') }]
});

document.addEventListener('contextmenu', (event) => {
  event.preventDefault();
  void menu.popup(new LogicalPosition(event.clientX, event.clientY));
});

prepend()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L146

Add a menu item to the beginning of this menu.

Platform-specific:

macOS: Only Submenus can be added to a Menu.

Type Parameters

Type Parameter
`T` extends \| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem` \| `MenuItemOptions` \| `SubmenuOptions` \| `IconMenuItemOptions` \| `PredefinedMenuItemOptions` \| `CheckMenuItemOptions`

Parameters

Parameter	Type
`items`	`T` \| `T`[]

Returns

Promise<void>

remove()

remove(item): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L199

Remove a menu item from this menu.

Parameters

Parameter	Type
`item`	\| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem`

Returns

Promise<void>

removeAt()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L210

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

Parameters

Parameter	Type
`position`	`number`

Returns

setAsAppMenu()

setAsAppMenu(): Promise<Menu | null>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L317

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.

This is the menu bar shown at the top of the screen on macOS. On Windows and Linux, where menus belong to a window, use Menu.setAsWindowMenu to target one window instead.

Returns

Promise<Menu | null>

The menu that was set before this call, or null if there was none.

Example

import { Menu } from '@tauri-apps/api/menu';

const menu = await Menu.default();
const previous = await menu.setAsAppMenu();
await previous?.close();

setAsWindowMenu()

setAsWindowMenu(window?): Promise<Menu | null>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L343

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

Parameter	Type	Description
`window?`	`Window`	The window to set the menu on. Defaults to the current window.

Returns

Promise<Menu | null>

The menu that was set on that window before this call, or null if there was none.

Example

import { Menu } from '@tauri-apps/api/menu';
import { getCurrentWindow } from '@tauri-apps/api/window';

const menu = await Menu.default();
await menu.setAsWindowMenu(getCurrentWindow());

default()

static default(): Promise<Menu>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L104

Create the default application menu, the same one Tauri installs when no menu is configured.

It contains an Edit submenu (undo, redo, cut, copy, paste, select all), a Window submenu (minimize, maximize, close window) and a Help submenu, plus:

macOS: an application submenu named after your app (about, services, hide, hide others, quit) and a View submenu with the fullscreen item.
Windows: a File submenu with close window and quit; the about item lives in Help.
Linux: no File submenu; the about item lives in Help.

Useful as a starting point you then extend with Menu.append, Menu.insert or Menu.prepend.

Returns

Promise<Menu>

Example

import { Menu, Submenu } from '@tauri-apps/api/menu';

const menu = await Menu.default();
await menu.append(await Submenu.new({ text: 'Tools', items: [{ id: 'fmt', text: 'Format' }] }));
await menu.setAsAppMenu();

new()

static new(opts?): Promise<Menu>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L75

Create a new menu.

Parameters

Parameter	Type
`opts?`	`MenuOptions`

Returns

Promise<Menu>

Example

import { Menu, Submenu } from '@tauri-apps/api/menu';

const menu = await Menu.new({
  items: [
    await Submenu.new({
      text: 'File',
      items: [
        { id: 'open', text: 'Open', accelerator: 'CmdOrCtrl+O', action: () => console.log('open') },
        { item: 'Separator' },
        { item: 'Quit' }
      ]
    })
  ]
});

MenuItem

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L70

A menu item inside a Menu or Submenu and contains only text.

Extends

MenuItemBase

Accessors

id

Get Signature

get id(): string;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L149

The id of this item.

Returns

string

Inherited from

MenuItemBase.id

rid

Get Signature

get rid(): number;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L547

Returns

number

Inherited from

MenuItemBase.rid

Methods

[asyncDispose]()

asyncDispose: Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L568

Returns

Promise<void>

Inherited from

MenuItemBase.[asyncDispose]

close()

close(): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L562

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>

Remarks

Uses the core:resources:allow-close permission, which is part of the core:resources:default permission set enabled by default.

Inherited from

MenuItemBase.close

isEnabled()

isEnabled(): Promise<boolean>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L96

Returns whether this menu item is enabled or not.

Returns

Promise<boolean>

setAccelerator()

setAccelerator(accelerator): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L119

Sets the accelerator for this menu item, or removes it when given null.

See MenuItemOptions.accelerator for the accepted format.

Parameters

Parameter	Type
`accelerator`	`string` \| `null`

Returns

Promise<void>

Example

await item.setAccelerator('CmdOrCtrl+Shift+K');

setEnabled()

setEnabled(enabled): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L101

Sets whether this menu item is enabled or not.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

Promise<void>

setText()

setText(text): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L87

Sets the text for this menu item.

Parameters

Parameter	Type
`text`	`string`

Returns

Promise<void>

text()

text(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L82

Returns the text of this menu item.

Returns

Promise<string>

new()

static new(opts): Promise<MenuItem>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L77

Create a new menu item.

Parameters

Parameter	Type
`opts`	`MenuItemOptions`

Returns

Promise<MenuItem>

PredefinedMenuItem

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L167

A predefined (native) menu item which has a predefined behavior by the OS or by tauri.

Extends

MenuItemBase

Accessors

id

Get Signature

get id(): string;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L149

The id of this item.

Returns

string

Inherited from

MenuItemBase.id

rid

Get Signature

get rid(): number;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L547

Returns

number

Inherited from

MenuItemBase.rid

Methods

[asyncDispose]()

asyncDispose: Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L568

Returns

Promise<void>

Inherited from

MenuItemBase.[asyncDispose]

close()

close(): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L562

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>

Remarks

Uses the core:resources:allow-close permission, which is part of the core:resources:default permission set enabled by default.

Inherited from

MenuItemBase.close

setText()

setText(text): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L196

Sets the text for this predefined menu item.

Parameters

Parameter	Type
`text`	`string`

Returns

Promise<void>

text()

text(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L191

Returns the text of this predefined menu item.

Returns

Promise<string>

new()

static new(opts?): Promise<PredefinedMenuItem>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L182

Create a new predefined menu item.

Parameters

Parameter	Type
`opts?`	`PredefinedMenuItemOptions`

Returns

Promise<PredefinedMenuItem>

Example

import { PredefinedMenuItem } from '@tauri-apps/api/menu';
const separator = await PredefinedMenuItem.new({ item: 'Separator' });

Submenu

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L60

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

Extends

MenuItemBase

Accessors

id

Get Signature

get id(): string;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L149

The id of this item.

Returns

string

Inherited from

MenuItemBase.id

rid

Get Signature

get rid(): number;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L547

Returns

number

Inherited from

MenuItemBase.rid

Methods

[asyncDispose]()

asyncDispose: Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L568

Returns

Promise<void>

Inherited from

MenuItemBase.[asyncDispose]

append()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L106

Add a menu item to the end of this submenu.

Platform-specific:

macOS: Only Submenus can be added to a Menu.

Type Parameters

Type Parameter
`T` extends \| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem` \| `MenuItemOptions` \| `SubmenuOptions` \| `IconMenuItemOptions` \| `PredefinedMenuItemOptions` \| `CheckMenuItemOptions`

Parameters

Parameter	Type
`items`	`T` \| `T`[]

Returns

Promise<void>

close()

close(): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L562

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>

Remarks

Uses the core:resources:allow-close permission, which is part of the core:resources:default permission set enabled by default.

Inherited from

MenuItemBase.close

get()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L229

Retrieves the menu item matching the given identifier.

Parameters

Parameter	Type
`id`	`string`

Returns

insert()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L164

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

Platform-specific:

macOS: Only Submenus can be added to a Menu.

Type Parameters

Type Parameter
`T` extends \| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem` \| `MenuItemOptions` \| `SubmenuOptions` \| `IconMenuItemOptions` \| `PredefinedMenuItemOptions` \| `CheckMenuItemOptions`

Parameters

Parameter	Type
`items`	`T` \| `T`[]
`position`	`number`

Returns

Promise<void>

isEnabled()

isEnabled(): Promise<boolean>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L86

Returns whether this submenu is enabled or not.

Returns

Promise<boolean>

items()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L217

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

Returns

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L251

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

Parameter	Type
`at?`	\| `PhysicalPosition` \| `LogicalPosition`
`window?`	`Window`

Returns

Promise<void>

prepend()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L135

Add a menu item to the beginning of this submenu.

Platform-specific:

macOS: Only Submenus can be added to a Menu.

Type Parameters

Type Parameter
`T` extends \| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem` \| `MenuItemOptions` \| `SubmenuOptions` \| `IconMenuItemOptions` \| `PredefinedMenuItemOptions` \| `CheckMenuItemOptions`

Parameters

Parameter	Type
`items`	`T` \| `T`[]

Returns

Promise<void>

remove()

remove(item): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L188

Remove a menu item from this submenu.

Parameters

Parameter	Type
`item`	\| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem`

Returns

Promise<void>

removeAt()

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L199

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

Parameters

Parameter	Type
`position`	`number`

Returns

setAsHelpMenuForNSApp()

setAsHelpMenuForNSApp(): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L291

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>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L273

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>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L91

Sets whether this submenu is enabled or not.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

Promise<void>

setIcon()

setIcon(icon): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L298

Sets an icon for this submenu

Parameters

Parameter	Type
`icon`	`MenuIcon` \| `null`

Returns

Promise<void>

setText()

setText(text): Promise<void>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L77

Sets the text for this submenu.

Parameters

Parameter	Type
`text`	`string`

Returns

Promise<void>

text()

text(): Promise<string>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L72

Returns the text of this submenu.

Returns

Promise<string>

new()

static new(opts): Promise<Submenu>;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L67

Create a new submenu.

Parameters

Parameter	Type
`opts`	`SubmenuOptions`

Returns

Promise<Submenu>

Interfaces

AboutMetadata

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L10

A metadata for the about predefined menu item.

Properties

Property	Type	Description	Defined in
`authors?`	`string`[]	The authors of the application. Platform-specific - macOS: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L30
`comments?`	`string`	Application comments. Platform-specific - macOS: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L38
`copyright?`	`string`	The copyright of the application.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L40
`credits?`	`string`	The credits. Platform-specific - Windows / Linux: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L72
`icon?`	`JsImage`	The application icon. Platform-specific - Windows: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L80
`license?`	`string`	The license of the application. Platform-specific - macOS: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L48
`name?`	`string`	Sets the application name.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L12
`shortVersion?`	`string`	The short version, e.g. “1.0”. Platform-specific - Windows / Linux: Appended to the end of `version` in parentheses.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L22
`version?`	`string`	The application version.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L14
`website?`	`string`	The application website. Platform-specific - macOS: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L56
`websiteLabel?`	`string`	The website label. Platform-specific - macOS: Unsupported.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L64

CheckMenuItemOptions

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L10

Options for creating a new check menu item.

Extends

MenuItemOptions

Properties

Property	Type	Description	Inherited from	Defined in
`accelerator?`	`string`	Specify an accelerator (keyboard shortcut) for the new menu item, for example `'CmdOrCtrl+Shift+K'`. The string is a list of zero or more modifiers followed by exactly one key, joined with `+`. Matching is case insensitive and spaces around each token are ignored, so `'CmdOrCtrl+Shift+K'` and `'cmdorctrl + shift + k'` are equivalent. All modifiers must come before the key. Accepted modifiers: - `Shift` - `Control`, `Ctrl` - `Alt`, `Option` - `Command`, `Cmd`, `Super` - `CmdOrCtrl`, `CmdOrControl`, `CommandOrCtrl`, `CommandOrControl` — `Command` on macOS and `Control` everywhere else, which is what you usually want for application shortcuts. Accepted keys: - Letters `A`-`Z` (also written `KeyA`-`KeyZ`) and digits `0`-`9` (also `Digit0`-`Digit9`). - Punctuation, either as the character or by name: `/`Backquote`, `\`/`Backslash`, `[`/`BracketLeft`, `]`/`BracketRight`, `,`/`Comma`, `=`/`Equal`, `-`/`Minus`, `.`/`Period`, `'`/`Quote`, `;`/`Semicolon`, `/`/`Slash`. - `Backspace`, `CapsLock`, `Enter`, `Space`, `Tab`, `Delete`, `End`, `Home`, `Insert`, `PageDown`, `PageUp`, `PrintScreen`, `ScrollLock`, `NumLock`, `Escape` (also `Esc`). - Arrows: `ArrowUp`, `ArrowDown`, `ArrowLeft`, `ArrowRight` (also `Up`, `Down`, `Left`, `Right`). - Function keys `F1` through `F24`. - Numpad keys: `Numpad0`-`Numpad9` (also `Num0`-`Num9`), `NumpadAdd`, `NumpadSubtract`, `NumpadMultiply`, `NumpadDivide`, `NumpadDecimal`, `NumpadEnter`, `NumpadEqual` (each also accepted with the `Num` prefix, e.g. `NumAdd`). - Media keys: `AudioVolumeUp`, `AudioVolumeDown`, `AudioVolumeMute` (also `VolumeUp`, `VolumeDown`, `VolumeMute`). Example `import { MenuItem } from '@tauri-apps/api/menu'; await MenuItem.new({ text: 'Find', accelerator: 'CmdOrCtrl+F' }); await MenuItem.new({ text: 'Command palette', accelerator: 'CmdOrCtrl+Shift+P' }); await MenuItem.new({ text: 'Refresh', accelerator: 'F5' });` An accelerator that cannot be parsed is ignored and the item is created without a shortcut, so double-check the spelling of the modifiers and key.	`MenuItemOptions`.`accelerator`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L64
`action?`	(`id`) => `void`	Specify a handler to be called when this menu item is activated.	`MenuItemOptions`.`action`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L66
`checked?`	`boolean`	Whether the new check menu item is enabled or not.	-	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L12
`enabled?`	`boolean`	Whether the new menu item is enabled or not.	`MenuItemOptions`.`enabled`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
`id?`	`string`	Specify an id to use for the new menu item.	`MenuItemOptions`.`id`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
`text`	`string`	The text of the new menu item.	`MenuItemOptions`.`text`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

IconMenuItemOptions

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L133

Options for creating a new icon menu item.

Extends

MenuItemOptions

Properties

Property	Type	Description	Inherited from	Defined in
`accelerator?`	`string`	Specify an accelerator (keyboard shortcut) for the new menu item, for example `'CmdOrCtrl+Shift+K'`. The string is a list of zero or more modifiers followed by exactly one key, joined with `+`. Matching is case insensitive and spaces around each token are ignored, so `'CmdOrCtrl+Shift+K'` and `'cmdorctrl + shift + k'` are equivalent. All modifiers must come before the key. Accepted modifiers: - `Shift` - `Control`, `Ctrl` - `Alt`, `Option` - `Command`, `Cmd`, `Super` - `CmdOrCtrl`, `CmdOrControl`, `CommandOrCtrl`, `CommandOrControl` — `Command` on macOS and `Control` everywhere else, which is what you usually want for application shortcuts. Accepted keys: - Letters `A`-`Z` (also written `KeyA`-`KeyZ`) and digits `0`-`9` (also `Digit0`-`Digit9`). - Punctuation, either as the character or by name: `/`Backquote`, `\`/`Backslash`, `[`/`BracketLeft`, `]`/`BracketRight`, `,`/`Comma`, `=`/`Equal`, `-`/`Minus`, `.`/`Period`, `'`/`Quote`, `;`/`Semicolon`, `/`/`Slash`. - `Backspace`, `CapsLock`, `Enter`, `Space`, `Tab`, `Delete`, `End`, `Home`, `Insert`, `PageDown`, `PageUp`, `PrintScreen`, `ScrollLock`, `NumLock`, `Escape` (also `Esc`). - Arrows: `ArrowUp`, `ArrowDown`, `ArrowLeft`, `ArrowRight` (also `Up`, `Down`, `Left`, `Right`). - Function keys `F1` through `F24`. - Numpad keys: `Numpad0`-`Numpad9` (also `Num0`-`Num9`), `NumpadAdd`, `NumpadSubtract`, `NumpadMultiply`, `NumpadDivide`, `NumpadDecimal`, `NumpadEnter`, `NumpadEqual` (each also accepted with the `Num` prefix, e.g. `NumAdd`). - Media keys: `AudioVolumeUp`, `AudioVolumeDown`, `AudioVolumeMute` (also `VolumeUp`, `VolumeDown`, `VolumeMute`). Example `import { MenuItem } from '@tauri-apps/api/menu'; await MenuItem.new({ text: 'Find', accelerator: 'CmdOrCtrl+F' }); await MenuItem.new({ text: 'Command palette', accelerator: 'CmdOrCtrl+Shift+P' }); await MenuItem.new({ text: 'Refresh', accelerator: 'F5' });` An accelerator that cannot be parsed is ignored and the item is created without a shortcut, so double-check the spelling of the modifiers and key.	`MenuItemOptions`.`accelerator`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L64
`action?`	(`id`) => `void`	Specify a handler to be called when this menu item is activated.	`MenuItemOptions`.`action`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L66
`enabled?`	`boolean`	Whether the new menu item is enabled or not.	`MenuItemOptions`.`enabled`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
`icon?`	`MenuIcon`	Icon to be used for the new icon menu item. Note that you may need the `image-ico` or `image-png` Cargo features to use this API. To enable it, change your Cargo.toml file: `[dependencies] tauri = { version = "...", features = ["...", "image-png"] }`	-	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L144
`id?`	`string`	Specify an id to use for the new menu item.	`MenuItemOptions`.`id`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
`text`	`string`	The text of the new menu item.	`MenuItemOptions`.`text`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

MenuItemOptions

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L9

Options for creating a new menu item.

Extended by

Properties

Property	Type	Description	Defined in
`accelerator?`	`string`	Specify an accelerator (keyboard shortcut) for the new menu item, for example `'CmdOrCtrl+Shift+K'`. The string is a list of zero or more modifiers followed by exactly one key, joined with `+`. Matching is case insensitive and spaces around each token are ignored, so `'CmdOrCtrl+Shift+K'` and `'cmdorctrl + shift + k'` are equivalent. All modifiers must come before the key. Accepted modifiers: - `Shift` - `Control`, `Ctrl` - `Alt`, `Option` - `Command`, `Cmd`, `Super` - `CmdOrCtrl`, `CmdOrControl`, `CommandOrCtrl`, `CommandOrControl` — `Command` on macOS and `Control` everywhere else, which is what you usually want for application shortcuts. Accepted keys: - Letters `A`-`Z` (also written `KeyA`-`KeyZ`) and digits `0`-`9` (also `Digit0`-`Digit9`). - Punctuation, either as the character or by name: `/`Backquote`, `\`/`Backslash`, `[`/`BracketLeft`, `]`/`BracketRight`, `,`/`Comma`, `=`/`Equal`, `-`/`Minus`, `.`/`Period`, `'`/`Quote`, `;`/`Semicolon`, `/`/`Slash`. - `Backspace`, `CapsLock`, `Enter`, `Space`, `Tab`, `Delete`, `End`, `Home`, `Insert`, `PageDown`, `PageUp`, `PrintScreen`, `ScrollLock`, `NumLock`, `Escape` (also `Esc`). - Arrows: `ArrowUp`, `ArrowDown`, `ArrowLeft`, `ArrowRight` (also `Up`, `Down`, `Left`, `Right`). - Function keys `F1` through `F24`. - Numpad keys: `Numpad0`-`Numpad9` (also `Num0`-`Num9`), `NumpadAdd`, `NumpadSubtract`, `NumpadMultiply`, `NumpadDivide`, `NumpadDecimal`, `NumpadEnter`, `NumpadEqual` (each also accepted with the `Num` prefix, e.g. `NumAdd`). - Media keys: `AudioVolumeUp`, `AudioVolumeDown`, `AudioVolumeMute` (also `VolumeUp`, `VolumeDown`, `VolumeMute`). Example `import { MenuItem } from '@tauri-apps/api/menu'; await MenuItem.new({ text: 'Find', accelerator: 'CmdOrCtrl+F' }); await MenuItem.new({ text: 'Command palette', accelerator: 'CmdOrCtrl+Shift+P' }); await MenuItem.new({ text: 'Refresh', accelerator: 'F5' });` An accelerator that cannot be parsed is ignored and the item is created without a shortcut, so double-check the spelling of the modifiers and key.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L64
`action?`	(`id`) => `void`	Specify a handler to be called when this menu item is activated.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L66
`enabled?`	`boolean`	Whether the new menu item is enabled or not.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
`id?`	`string`	Specify an id to use for the new menu item.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
`text`	`string`	The text of the new menu item.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

MenuOptions

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L23

Options for creating a new menu.

Properties

Property	Type	Description	Defined in
`id?`	`string`	Specify an id to use for the new menu.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L25
`items?`	( \| `Submenu` \| `MenuItem` \| `PredefinedMenuItem` \| `CheckMenuItem` \| `IconMenuItem` \| `MenuItemOptions` \| `SubmenuOptions` \| `IconMenuItemOptions` \| `PredefinedMenuItemOptions` \| `CheckMenuItemOptions`)[]	List of items to add to the new menu.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L27

PredefinedMenuItemOptions

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L84

Options for creating a new predefined menu item.

Properties

Property	Type	Description	Defined in
`item`	\| `"Separator"` \| `"Copy"` \| `"Cut"` \| `"Paste"` \| `"SelectAll"` \| `"Undo"` \| `"Redo"` \| `"Minimize"` \| `"Maximize"` \| `"Fullscreen"` \| `"Hide"` \| `"HideOthers"` \| `"ShowAll"` \| `"CloseWindow"` \| `"Quit"` \| `"Services"` \| `"BringAllToFront"` \| { `About`: \| `AboutMetadata` \| `null`; }	The predefined item type. Each variant maps to a native menu item whose behavior is implemented by the operating system, so there is no `action` to handle. Variants that are unsupported on a platform still create an item, but it does nothing there. - `Separator`: a horizontal separator line. All platforms. - `Copy`, `Cut`, `Paste`, `SelectAll`: the standard clipboard and selection commands, applied to the focused text input. All platforms. - `Undo`, `Redo`: undo/redo in the focused text input. macOS only (Windows / Linux: unsupported). - `Minimize`: minimizes the focused window. Linux: unsupported. - `Maximize`: maximizes the focused window. Linux: unsupported. - `Fullscreen`: toggles fullscreen for the focused window. macOS only (Windows / Linux: unsupported). - `Hide`: hides the application. Linux: unsupported. - `HideOthers`: hides every other application. Linux: unsupported. - `ShowAll`: shows all hidden applications. macOS only (Windows / Linux: unsupported). - `CloseWindow`: closes the focused window. Linux: unsupported. - `Quit`: quits the application. Linux: unsupported. - `Services`: the macOS Services submenu. macOS only (Windows / Linux: unsupported). - `BringAllToFront`: brings all of the app’s windows to the front. macOS only (Windows / Linux: unsupported). - `{ About: AboutMetadata	null }`: opens an about dialog. All platforms; pass` null`to use the values from your`tauri.conf.json`, or see [`AboutMetadata`](/reference/javascript/api/namespacemenu/#aboutmetadata) for the per-field platform support. Example` import { Menu, PredefinedMenuItem, Submenu } from ‘@tauri-apps/api/menu’; const edit = await Submenu.new({ text: ‘Edit’, items: [ { item: ‘Undo’ }, { item: ‘Redo’ }, { item: ‘Separator’ }, { item: ‘Cut’ }, { item: ‘Copy’ }, { item: ‘Paste’ }, { item: ‘SelectAll’ } ] }); const quit = await PredefinedMenuItem.new({ item: ‘Quit’, text: ‘Quit my app’ }); const menu = await Menu.new({ items: [edit, quit] });`
`text?`	`string`	The text of the new predefined menu item. Defaults to the platform’s own label for the chosen item, so only set it to override or localize that label.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L91

Type Aliases

SubmenuOptions

type SubmenuOptions = Omit<MenuItemOptions, "accelerator" | "action"> & MenuOptions & object;

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L50

Type Declaration

Name	Type	Description	Defined in
`icon?`	`MenuIcon`	Icon to be used for the submenu. Note: you may need the `image-ico` or `image-png` Cargo features to use this API.	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L56

Support on Open Collective Sponsor on GitHub

menu

Remarks

Enumerations

NativeIcon

Enumeration Members

Add

Advanced

Bluetooth

Bookmarks

Caution

ColorPanel

ColumnView

Computer

EnterFullScreen

Everyone

ExitFullScreen

FlowView

Folder

FolderBurnable

FolderSmart

FollowLinkFreestanding

FontPanel

GoLeft

GoRight

Home

IChatTheater

IconView

Info

InvalidDataFreestanding

LeftFacingTriangle

ListView

LockLocked

LockUnlocked

MenuMixedState

MenuOnState

MobileMe

MultipleDocuments

Network

Path

PreferencesGeneral

QuickLook

Refresh

RefreshFreestanding

Remove

RevealFreestanding

RightFacingTriangle

Share

Slideshow

SmartBadge

StatusAvailable

StatusNone

StatusPartiallyAvailable

StatusUnavailable

StopProgress

StopProgressFreestanding

TrashEmpty

TrashFull

User

UserAccounts

UserGroup

UserGuest

Classes

CheckMenuItem

Extends

Accessors

id

Get Signature

Returns

Inherited from

rid

Get Signature

Returns

Inherited from

Methods

[asyncDispose]()

Returns

Inherited from

close()

Returns

Remarks