menu

枚举

NativeIcon

用于菜单项的原生图标

平台特定

• 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

iChat 剧场

IChatTheater: "IChatTheater";

iChat 剧场模板图像。

来源: 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

类

CheckMenuItem

CheckMenuItem 是 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#L286

方法

close()

close(): Promise<void>

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

返回值

Promise<void>

继承自

MenuItemBase.close

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

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>

设置此复选菜单项是否被选中。

参数

参数	类型
checked	boolean

返回值

Promise<void>

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

setEnabled()

setEnabled(enabled): Promise<void>

设置此复选菜单项是否启用。

参数

参数	类型
enabled	boolean

返回值

Promise<void>

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

setText()

setText(text): Promise<void>

为此复选菜单项设置文本。

参数

参数	类型
text	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>

创建一个新的复选菜单项。

参数

参数	类型
opts	CheckMenuItemOptions

返回值

Promise<CheckMenuItem>

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

---

IconMenuItem

IconMenuItem 是 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#L286

方法

close()

close(): Promise<void>

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

返回值

Promise<void>

继承自

MenuItemBase.close

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

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>

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

参数

参数	类型
enabled	boolean

返回值

Promise<void>

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

setIcon()

setIcon(icon): Promise<void>

为此图标菜单项设置图标

参数

参数	类型
icon	| 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>

为此图标菜单项设置文本。

参数

参数	类型
text	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>

创建一个新的图标菜单项。

参数

参数	类型
opts	IconMenuItemOptions

返回值

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#L286

方法

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#L298

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[]
position	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>

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

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

参数

参数	类型
at?	LogicalPosition | PhysicalPosition | Position
window?	Window

返回值

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>

从此菜单中删除一个菜单项。

参数

参数	类型
item	| 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>

从此菜单的指定位置移除一个菜单项。

参数

参数	类型
position	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。

参数

参数	类型
window?	Window

返回值

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>

创建一个新菜单。

参数

参数	类型
opts?	MenuOptions

返回值

Promise<Menu>

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

---

MenuItem

菜单项位于 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#L286

方法

close()

close(): Promise<void>

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

返回值

Promise<void>

继承自

MenuItemBase.close

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

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>

设置此菜单项是否已启用。

参数

参数	类型
enabled	boolean

返回值

Promise<void>

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

setText()

setText(text): Promise<void>

为此菜单项设置文本。

参数

参数	类型
text	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>

创建一个新菜单项。

参数

参数	类型
opts	MenuItemOptions

返回值

Promise<MenuItem>

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

---

PredefinedMenuItem

一个预定义的（原生）菜单项，它具有操作系统或 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#L286

方法

close()

close(): Promise<void>

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

返回值

Promise<void>

继承自

MenuItemBase.close

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

setText()

setText(text): Promise<void>

为此预定义菜单项设置文本。

参数

参数	类型
text	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>

创建一个新的预定义菜单项。

参数

参数	类型
opts?	PredefinedMenuItemOptions

返回值

Promise<PredefinedMenuItem>

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

---

Submenu

一种类型，它是 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#L286

方法

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#L298

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[]
position	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>

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

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

参数

参数	类型
at?	LogicalPosition | PhysicalPosition
window?	Window

返回值

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>

从此子菜单中移除一个菜单项。

参数

参数	类型
item	| 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>

从此子菜单的指定位置移除一个菜单项。

参数

参数	类型
position	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>

设置此子菜单是否已启用。

参数

参数	类型
enabled	boolean

返回值

Promise<void>

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

setText()

setText(text): Promise<void>

为此子菜单设置文本。

参数

参数	类型
text	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>

创建一个新的子菜单。

参数

参数	类型
opts	SubmenuOptions

返回值

Promise<Submenu>

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

接口

AboutMetadata

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

属性

属性	类型	描述	定义于
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

---

CheckMenuItemOptions

用于创建新的复选菜单项的选项。

继承

• MenuItemOptions

属性

属性	类型	描述	继承自	定义于
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?	boolean	新复选菜单项是否已选中。	-	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L12
enabled?	boolean	新菜单项是否已启用。	MenuItemOptions.enabled	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	string	指定用于新菜单项的 ID。	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

---

IconMenuItemOptions

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

继承

• MenuItemOptions

属性

属性	类型	描述	继承自	定义于
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?	boolean	新菜单项是否已启用。	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	指定用于新菜单项的 ID。	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

---

MenuItemOptions

用于创建新菜单项的选项。

扩展自

• CheckMenuItemOptions
• IconMenuItemOptions

属性

属性	类型	描述	定义于
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?	boolean	新菜单项是否已启用。	来源: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	string	指定用于新菜单项的 ID。	来源: 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

---

MenuOptions

用于创建新菜单的选项。

属性

属性	类型	描述	定义于
id?	string	指定用于新菜单的 ID。	来源: 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

---

PredefinedMenuItemOptions

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

属性

属性	类型	描述	定义于
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

类型别名

SubmenuOptions

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

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