菜单

枚举

本机图标

用于菜单项的本机图标

平台特定的

• Windows / Linux：不支持。

枚举成员

添加

Add: "Add";

添加项模板图像。

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L19

高级

Advanced: "Advanced";

首选项窗口的高级首选项工具栏图标。

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L21

蓝牙

Bluetooth: "Bluetooth";

蓝牙模板图像。

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L23

书签

Bookmarks: "Bookmarks";

适合模板的书签图像。

来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L25

小心

Caution: "Caution";

警告图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L27

颜色面板

ColorPanel: "ColorPanel";

颜色面板工具栏图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L29

列视图

ColumnView: "ColumnView";

列视图模式模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L31

计算机

Computer: "Computer";

计算机图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L33

进入全屏

EnterFullScreen: "EnterFullScreen";

全屏模式模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L35

所有人

Everyone: "Everyone";

所有用户的权限。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L37

退出全屏

ExitFullScreen: "ExitFullScreen";

退出全屏模式模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu iconMenuItem.ts#L39

流程视图

FlowView: "FlowView";

覆盖流视图模式模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L41

文件夹

Folder: "Folder";

文件夹图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L43

可烧录文件夹

FolderBurnable: "FolderBurnable";

可烧录文件夹图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L45

智能文件夹

FolderSmart: "FolderSmart";

智能文件夹图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L47

独立链接

FollowLinkFreestanding: "FollowLinkFreestanding";

链接模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L49

字体面板

FontPanel: "FontPanel";

字体面板工具栏图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L51

左移

GoLeft: "GoLeft";

后退模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L53

右移

GoRight: "GoRight";

前进模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L55

主页

Home: "Home";

适用于模板的首页图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L57

IChatTheater

IChatTheater: "IChatTheater";

iChat Theater模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L59

图标视图

IconView: "IconView";

图标视图模式模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L61

信息

Info: "Info";

信息工具栏图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L63

无效数据独立

InvalidDataFreestanding: "InvalidDataFreestanding";

用于表示无效数据的模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L65

面向左侧三角形

LeftFacingTriangle: "LeftFacingTriangle";

通用向左的三角形模板图片。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L67

列表视图

ListView: "ListView";

列表视图模式模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L69

锁定已锁定

LockLocked: "LockLocked";

一个锁定的锁模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L71

锁定未锁定

LockUnlocked: "LockUnlocked";

一个未锁定的锁模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L73

菜单混合状态

MenuMixedState: "MenuMixedState";

用于菜单的水平破折号。

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

菜单开启状态

MenuOnState: "MenuOnState";

用于菜单的勾选标记模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L77

MobileMe

MobileMe: "MobileMe";

一个MobileMe图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L79

多个文档

MultipleDocuments: "MultipleDocuments";

用于多个项目的拖动图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L81

网络

Network: "Network";

网络图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L83

路径

Path: "Path";

路径按钮模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L85

首选项通用

PreferencesGeneral: "PreferencesGeneral";

偏好设置窗口的常规偏好设置工具栏图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L87

快速查看

QuickLook: "QuickLook";

快速查看模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L89

刷新

Refresh: "Refresh";

刷新模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L93

刷新独立

RefreshFreestanding: "RefreshFreestanding";

刷新模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L91

删除

Remove: "Remove";

移除项目模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L95

显示独立

RevealFreestanding: "RevealFreestanding";

显示内容模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L97

面向右侧三角形

RightFacingTriangle: "RightFacingTriangle";

一个通用的指向右侧的三角形模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L99

分享

Share: "Share";

分享视图模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L101

幻灯片

Slideshow: "Slideshow";

幻灯片模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L103

智能徽章

SmartBadge: "SmartBadge";

智能项目的徽章。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L105

可用状态

StatusAvailable: "StatusAvailable";

一个小型绿色指示器，类似于iChat的可用图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L107

无状态

StatusNone: "StatusNone";

小清新的指示器。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L109

部分可用状态

StatusPartiallyAvailable: "StatusPartiallyAvailable";

较小的黄色指示器，类似于iChat的空闲图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L111

不可用状态

StatusUnavailable: "StatusUnavailable";

较小的红色指示器，类似于iChat的未可用图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L113

停止进度

StopProgress: "StopProgress";

停止进度按钮模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L117

停止进度独立

StopProgressFreestanding: "StopProgressFreestanding";

停止进度模板图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L115

垃圾桶为空

TrashEmpty: "TrashEmpty";

空垃圾桶图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L119

垃圾桶已满

TrashFull: "TrashFull";

满垃圾桶图像。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L121

用户

User: "User";

单个用户的权限。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L123

用户帐户

UserAccounts: "UserAccounts";

偏好窗口的用户账户工具栏图标。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L125

用户组

UserGroup: "UserGroup";

一群用户的权限。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L127

访客用户

UserGuest: "UserGuest";

访客的权限。

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L129

类

复选菜单项

位于Menu或Submenu中的复选菜单项，通常包含文本和一个对应于选中状态和未选中状态的复选标记或类似切换按钮。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

isChecked()

isChecked(): Promise<boolean>

返回此复选菜单项是否被选中。

返回

Promise<boolean>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L71

isEnabled()

isEnabled(): Promise<boolean>

返回此复选菜单项是否启用。

返回

Promise<boolean>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L48

setAccelerator()

setAccelerator(accelerator): Promise<void>

为此复选菜单项设置快捷键。

参数

参数	类型
accelerator	null | string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L62

setChecked()

setChecked(checked): Promise<void>

设置检查菜单项是否被选中。

参数

参数	类型
选中	布尔值

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L76

setEnabled()

setEnabled(enabled): Promise<void>

设置检查菜单项是否启用。

参数

参数	类型
启用	布尔值

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L53

setText()

setText(text): Promise<void>

设置检查菜单项的文本。

参数

参数	类型
文本	string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L39

text()

text(): Promise<string>

返回检查菜单项的文本。

返回

Promise<string>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L34

new()

static new(opts): Promise<CheckMenuItem>

创建一个新的检查菜单项。

参数

参数	类型
选项	复选菜单项选项

返回

Promise<CheckMenuItem>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L27

---

图标菜单项

一个图标菜单项，位于Menu或Submenu内部，通常包含一个图标和文本。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

isEnabled()

isEnabled(): Promise<boolean>

返回图标菜单项是否已启用。

返回

Promise<boolean>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L177

setAccelerator()

setAccelerator(accelerator): Promise<void>

设置图标菜单项的快捷键。

参数

参数	类型
accelerator	null | string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L191

setEnabled()

setEnabled(enabled): Promise<void>

设置图标菜单项是否已启用。

参数

参数	类型
启用	布尔值

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L182

setIcon()

setIcon(icon): Promise<void>

为图标菜单项设置图标。

参数

参数	类型
图标	| null | string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L200

setText()

setText(text): Promise<void>

为图标菜单项设置文本。

参数

参数	类型
文本	string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L168

text()

text(): Promise<string>

返回图标菜单项的文本。

返回

Promise<string>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L163

new()

static new(opts): Promise<IconMenuItem>

创建一个新图标菜单项。

参数

参数	类型
选项	图标菜单项选项

返回

Promise<IconMenuItem>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L158

---

菜单

一个类型，要么是Windows和Linux中窗口上的菜单栏，要么是macOS上菜单栏的全局菜单。

平台特定的

• macOS：如果使用Menu进行全局菜单栏，则只能包含Submenu。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

append()

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

将菜单项添加到菜单的末尾。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]

返回

Promise<void>

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L73

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

get()

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

根据给定的标识符检索菜单项。

参数

参数	类型
id	string

返回

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

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L196

insert()

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

将菜单项添加到该菜单中的指定位置。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]
位置	number

返回

Promise<void>

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L131

items()

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

返回已添加到此菜单的菜单项列表。

返回

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

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L184

popup()

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

在指定的窗口上以上下文菜单的形式弹出新菜单。

如果提供了位置，则该位置相对于窗口的左上角。

参数

参数	类型
在?	LogicalPosition | PhysicalPosition | 位置
窗口?	窗口

返回

Promise<void>

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L218

prepend()

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

将菜单项添加到此菜单的开头。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]

返回

Promise<void>

来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L102

remove()

remove(item): Promise<void>

从该菜单中删除菜单项。

参数

参数	类型
项目	| CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L155

removeAt()

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

从菜单中移除指定位置的菜单项。

参数

参数	类型
位置	number

返回

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

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L166

setAsAppMenu()

setAsAppMenu(): Promise<null | Menu>

设置全局菜单并返回上一个全局菜单。

如果窗口未使用显式菜单创建或已显式设置了菜单，则将此菜单分配给它。

返回

Promise<null | Menu>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L236

setAsWindowMenu()

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

设置窗口菜单并返回上一个窗口菜单。

平台特定的

• macOS: 不支持。macOS上的菜单是全局的，而不是特定于单个窗口的，如果需要设置，请使用 Menu.setAsAppMenu 替代。

参数

参数	类型
窗口?	窗口

返回

Promise<null | Menu>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L250

default()

static default(): Promise<Menu>

创建默认菜单。

返回

Promise<Menu>

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

new()

static new(opts?): Promise<Menu>

创建新的菜单。

参数

参数	类型
选项?	菜单选项

返回

Promise<Menu>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L55

---

菜单项

一个文本菜单项，位于 Menu 或 Submenu 内。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

isEnabled()

isEnabled(): Promise<boolean>

返回此菜单项是否启用。

返回

Promise<boolean>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L49

setAccelerator()

setAccelerator(accelerator): Promise<void>

设置此菜单项的快捷键。

参数

参数	类型
accelerator	null | string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L63

setEnabled()

setEnabled(enabled): Promise<void>

设置此菜单项是否启用。

参数

参数	类型
启用	布尔值

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L54

setText()

setText(text): Promise<void>

设置此菜单项的文本。

参数

参数	类型
文本	string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L40

text()

text(): Promise<string>

返回此菜单项的文本。

返回

Promise<string>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L35

new()

static new(opts): Promise<MenuItem>

创建新的菜单项。

参数

参数	类型
选项	菜单项选项

返回

Promise<MenuItem>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L30

---

预定义菜单项

预定义（原生）菜单项，由操作系统或 tauri 预定义。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

setText()

setText(text): Promise<void>

设置该预定义菜单项的文本。

参数

参数	类型
文本	string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L132

text()

text(): Promise<string>

返回此预设菜单项的文本。

返回

Promise<string>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L127

new()

static new(opts?): Promise<PredefinedMenuItem>

创建一个新的预设菜单项。

参数

参数	类型
选项?	预定义菜单项选项

返回

Promise<PredefinedMenuItem>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L118

---

子菜单

一个类型，它是一个Menu或Submenu内的子菜单。

扩展

• MenuItemBase

访问器

id

获取签名

get id(): string

此物品的ID。

返回

string

继承自

MenuItemBase.id

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/base.ts#L128

rid

获取签名

get rid(): number

返回

number

继承自

MenuItemBase.rid

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L297

方法

append()

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

将菜单项添加到子菜单的末尾。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L99

close()

close(): Promise<void>

销毁并从内存中清除此资源。您不应在此对象上调用任何方法，并应取消对此对象的任何引用。

返回

Promise<void>

继承自

MenuItemBase.close

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L309

get()

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

根据给定的标识符检索菜单项。

参数

参数	类型
id	string

返回

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

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L222

insert()

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

将菜单项添加到子菜单中的指定位置。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]
位置	number

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L157

isEnabled()

isEnabled(): Promise<boolean>

返回此子菜单是否启用。

返回

Promise<boolean>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L79

items()

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

返回已添加到此子菜单的菜单项列表。

返回

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

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

popup()

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

在指定窗口上弹出此子菜单作为上下文菜单。

如果提供了位置，则该位置相对于窗口的左上角。

参数

参数	类型
在?	LogicalPosition | PhysicalPosition
窗口?	窗口

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L244

prepend()

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

将菜单项添加到子菜单的开始位置。

平台特定的

• macOS：只能将Submenu添加到Menu。

类型参数

类型参数
T 继承 | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

参数

参数	类型
items	T | T[]

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L128

remove()

remove(item): Promise<void>

从子菜单中删除菜单项。

参数

参数	类型
项目	| CheckMenuItem | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L181

removeAt()

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

从子菜单的指定位置删除菜单项。

参数

参数	类型
位置	number

返回

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

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L192

setAsHelpMenuForNSApp()

setAsHelpMenuForNSApp(): Promise<void>

将此子菜单设置为macOS上应用程序的帮助菜单。

这将导致macOS自动将搜索框添加到菜单中。

如果未设置任何菜单作为帮助菜单，macOS将自动使用任何标题匹配本地化单词“帮助”的菜单。

平台特定的

• Windows / Linux：不支持。

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L284

setAsWindowsMenuForNSApp()

setAsWindowsMenuForNSApp(): Promise<void>

将此子菜单设置为macOS上应用程序的窗口菜单。

这将导致macOS自动将窗口切换项和其他某些项添加到菜单中。

平台特定的

• Windows / Linux：不支持。

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L266

setEnabled()

setEnabled(enabled): Promise<void>

设置此子菜单是否启用。

参数

参数	类型
启用	布尔值

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L84

setText()

setText(text): Promise<void>

设置此子菜单的文本。

参数

参数	类型
文本	string

返回

Promise<void>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L70

text()

text(): Promise<string>

返回此子菜单的文本。

返回

Promise<string>

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L65

new()

static new(opts): Promise<Submenu>

创建一个新的子菜单。

参数

参数	类型
选项	子菜单选项

返回

Promise<Submenu>

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

接口

关于元数据

关于预定义菜单项的元数据。

属性

属性	类型	描述	定义于
authors?	string[]	应用程序的作者。#### 与平台相关 - macOS: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L30
comments?	string	应用程序评论。#### 与平台相关 - macOS: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L38
copyright?	string	应用程序的版权。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L40
credits?	string	致谢。#### 与平台相关 - Windows / Linux: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L72
icon?	| string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image	应用程序图标。#### 与平台相关 - Windows: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L80
license?	string	应用程序的许可。#### 与平台相关 - macOS: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L48
name?	string	设置应用程序名称。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L12
shortVersion?	string	短版本，例如“1.0”。#### 与平台相关 - Windows / Linux: 括号内附加到 version 的末尾。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L22
version?	string	应用程序版本。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L14
website?	string	应用程序网站。#### 与平台相关 - macOS: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L56
websiteLabel?	string	网站标签。#### 与平台相关 - macOS: 不支持。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L64

---

复选菜单项选项

创建新复选框菜单项的选项。

扩展

• 菜单项选项

属性

属性	类型	描述	继承自	定义于
accelerator?	string	为新菜单项指定加速器。	MenuItemOptions.accelerator	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定当该菜单项被激活时调用的处理程序。	MenuItemOptions.action	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
checked?	布尔值	新复选菜单项是否启用。	-	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L12
enabled?	布尔值	新菜单项是否启用。	MenuItemOptions.enabled	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	string	为新菜单项指定一个标识符。	MenuItemOptions.id	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	string	新菜单项的文本。	MenuItemOptions.text	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

图标菜单项选项

创建新图标菜单项的选项。

扩展

• 菜单项选项

属性

属性	类型	描述	继承自	定义于
accelerator?	string	为新菜单项指定加速器。	MenuItemOptions.accelerator	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定当该菜单项被激活时调用的处理程序。	MenuItemOptions.action	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
enabled?	布尔值	新菜单项是否启用。	MenuItemOptions.enabled	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
icon?	| string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image	用于新图标菜单项的图标。注意，您可能需要 image-ico 或 image-png Cargo 特性来使用此 API。要启用它，请修改您的 Cargo.toml 文件：[dependencies] tauri = { version = "...", features = ["...", "image-png"] }	-	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L144
id?	string	为新菜单项指定一个标识符。	MenuItemOptions.id	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	string	新菜单项的文本。	MenuItemOptions.text	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

菜单项选项

创建新菜单项的选项。

扩展

• 复选菜单项选项
• 图标菜单项选项

属性

属性	类型	描述	定义于
accelerator?	string	为新菜单项指定加速器。	来源：来源：https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定当该菜单项被激活时调用的处理程序。	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
enabled?	布尔值	新菜单项是否启用。	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	string	为新菜单项指定一个标识符。	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	string	新菜单项的文本。	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

菜单选项

创建新菜单的选项。

属性

属性	类型	描述	定义于
id?	string	为新菜单指定一个标识符。	来源： https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L25
items?	（ | CheckMenuItemOptions | MenuItemOptions | CheckMenuItem | SubmenuOptions | PredefinedMenuItemOptions | IconMenuItemOptions | IconMenuItem | PredefinedMenuItem | Submenu | MenuItem)[]	新菜单中要添加的项列表。	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menu.ts#L27

---

预定义菜单项选项

创建新预定义菜单项的选项。

属性

属性	类型	描述	定义于
item	| object | "Separator" | "Copy" | "Cut" | "Paste" | "SelectAll" | "Undo" | "Redo" | "Minimize" | "Maximize" | "Fullscreen" | "Hide" | "HideOthers" | "ShowAll" | "CloseWindow" | "Quit" | "Services"	预定义项的类型	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L88
text?	string	新预定义菜单项的文本。	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L86

类型别名

子菜单选项

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

来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L49