menu

枚举

NativeIcon

用于菜单项的本地图标

平台特定

• Windows / Linux：不支持。

枚举成员

Add

Add: "Add";

添加项模板图像。

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

Advanced

Advanced: "Advanced";

偏好设置窗口的“高级”偏好设置工具栏图标。

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

Bluetooth

Bluetooth: "Bluetooth";

蓝牙模板图像。

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

Bookmarks

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: "ColorPanel";

颜色面板工具栏图标。

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

ColumnView

ColumnView: "ColumnView";

分栏视图模式模板图像。

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

Computer

Computer: "Computer";

计算机图标。

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

EnterFullScreen

EnterFullScreen: "EnterFullScreen";

进入全屏模式模板图像。

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

Everyone

Everyone: "Everyone";

所有用户的权限。

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

ExitFullScreen

ExitFullScreen: "ExitFullScreen";

退出全屏模式模板图像。

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

FlowView

FlowView: "FlowView";

封面流（Cover Flow）视图模式模板图像。

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

Folder

Folder: "Folder";

文件夹图像。

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

FolderBurnable

FolderBurnable: "FolderBurnable";

可刻录文件夹图标。

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

FolderSmart

FolderSmart: "FolderSmart";

智能文件夹图标。

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

FollowLinkFreestanding

FollowLinkFreestanding: "FollowLinkFreestanding";

链接模板图像。

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

FontPanel

FontPanel: "FontPanel";

字体面板工具栏图标。

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

GoLeft

GoLeft: "GoLeft";

后退模板图像。

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

GoRight

GoRight: "GoRight";

前进模板图像。

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

Home

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: "IconView";

图标视图模式模板图像。

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

Info

Info: "Info";

信息工具栏图标。

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

InvalidDataFreestanding

InvalidDataFreestanding: "InvalidDataFreestanding";

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

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

LeftFacingTriangle

LeftFacingTriangle: "LeftFacingTriangle";

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

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

ListView

ListView: "ListView";

列表视图模式模板图像。

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

LockLocked

LockLocked: "LockLocked";

已锁定的挂锁模板图像。

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

LockUnlocked

LockUnlocked: "LockUnlocked";

已解锁的挂锁模板图像。

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

MenuMixedState

MenuMixedState: "MenuMixedState";

用于菜单中的横线。

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

MenuOnState

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: "MultipleDocuments";

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

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

Network

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: "PreferencesGeneral";

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

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

QuickLook

QuickLook: "QuickLook";

快速查看（Quick Look）模板图像。

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

Refresh

Refresh: "Refresh";

刷新模板图像。

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

RefreshFreestanding

RefreshFreestanding: "RefreshFreestanding";

刷新模板图像。

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

Remove

Remove: "Remove";

移除项模板图像。

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

RevealFreestanding

RevealFreestanding: "RevealFreestanding";

显示内容模板图像。

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

RightFacingTriangle

RightFacingTriangle: "RightFacingTriangle";

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

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

Share

Share: "Share";

分享视图模板图像。

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

Slideshow

Slideshow: "Slideshow";

幻灯片模板图像。

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

SmartBadge

SmartBadge: "SmartBadge";

智能项目的徽标。

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

StatusAvailable

StatusAvailable: "StatusAvailable";

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

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

StatusNone

StatusNone: "StatusNone";

小型清除指示器。

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

StatusPartiallyAvailable

StatusPartiallyAvailable: "StatusPartiallyAvailable";

小型黄色指示器，类似于iChat的“闲置”图像。

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

StatusUnavailable

StatusUnavailable: "StatusUnavailable";

小型红色指示器，类似于iChat的“不可用”图像。

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

StopProgress

StopProgress: "StopProgress";

停止进度按钮模板图像。

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

StopProgressFreestanding

StopProgressFreestanding: "StopProgressFreestanding";

停止进度模板图像。

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

TrashEmpty

TrashEmpty: "TrashEmpty";

空垃圾桶图像。

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

TrashFull

TrashFull: "TrashFull";

已满的垃圾桶图像。

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

User

User: "User";

单个用户的权限。

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

UserAccounts

UserAccounts: "UserAccounts";

偏好设置窗口的用户帐户工具栏图标。

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

UserGroup

UserGroup: "UserGroup";

用户组的权限。

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

UserGuest

UserGuest: "UserGuest";

访客的权限。

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

类

CheckMenuItem

Menu 或 Submenu 中的复选菜单项，通常包含一段文本和一个勾选标记或类似的开关，用于对应选中和未选中状态。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

MenuItemBase.close

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

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

Menu 或 Submenu 中的图标菜单项，通常包含一个图标和一段文本。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

MenuItemBase.close

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

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

返回

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。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

append()

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

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

平台特定

• macOS：只有 Submenu 可以添加到 Menu 中。

类型参数

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

参数

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

继承自 (Inherited from)

MenuItemBase.close

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

get()

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

检索与给定标识符匹配的菜单项。

参数

参数	类型
ID	string

返回

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

源码: 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 extends | MenuItemOptions | MenuItem | SubmenuOptions | PredefinedMenuItemOptions | CheckMenuItemOptions | IconMenuItemOptions | PredefinedMenuItem | Submenu | CheckMenuItem | IconMenuItem

参数

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

返回

Promise<void>

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

items()

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

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

返回

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

源码: 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?	窗口	-

返回

Promise<void>

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

prepend()

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

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

平台特定

• macOS：只有 Submenu 可以添加到 Menu 中。

类型参数

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

参数

参数	类型
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	| MenuItem | PredefinedMenuItem | Submenu | CheckMenuItem | IconMenuItem

返回

Promise<void>

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

removeAt()

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

在指定位置从菜单中移除一个菜单项。

参数

参数	类型
位置	数字

返回

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

源码: 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#L237

setAsWindowMenu()

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

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

平台特定

• macOS: 不支持。macOS 上的菜单是应用级的，并不特定于某个窗口。如果需要设置，请改用 Menu.setAsAppMenu。

参数

参数	类型
window?	窗口

返回

Promise<null | Menu>

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

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 内部的菜单项，仅包含文本。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

MenuItemBase.close

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

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）。

参数

参数	类型
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 提供预定义的行为。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

MenuItemBase.close

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

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 内部子菜单的类型。

继承 (Extends)

• MenuItemBase

访问器

ID

get id(): string

此项目的 ID。

返回

string

继承自 (Inherited from)

MenuItemBase.id

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

rid

get rid(): number

返回

数字

继承自 (Inherited from)

MenuItemBase.rid

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

方法

append()

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

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

平台特定

• macOS：只有 Submenu 可以添加到 Menu 中。

类型参数

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

参数

参数	类型
items	T | T[]

返回

Promise<void>

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

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

返回

Promise<void>

继承自 (Inherited from)

MenuItemBase.close

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

get()

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

检索与给定标识符匹配的菜单项。

参数

参数	类型
ID	string

返回

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

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

insert()

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

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

平台特定

• macOS：只有 Submenu 可以添加到 Menu 中。

类型参数

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

参数

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

返回

Promise<void>

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

isEnabled()

isEnabled(): Promise<boolean>

返回此子菜单是否已启用。

返回

Promise<boolean>

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

items()

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

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

返回

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

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

popup()

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

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

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

参数

参数	类型
at?	LogicalPosition | PhysicalPosition
window?	窗口

返回

Promise<void>

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

prepend()

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

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

平台特定

• macOS：只有 Submenu 可以添加到 Menu 中。

类型参数

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

参数

参数	类型
items	T | T[]

返回

Promise<void>

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

remove()

remove(item): Promise<void>

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

参数

参数	类型
item	| MenuItem | PredefinedMenuItem | Submenu | CheckMenuItem | IconMenuItem

返回

Promise<void>

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

removeAt()

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

在指定位置从子菜单中移除一个菜单项。

参数

参数	类型
位置	数字

返回

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

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

setAsHelpMenuForNSApp()

setAsHelpMenuForNSApp(): Promise<void>

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

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

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

平台特定

• Windows / Linux：不支持。

返回

Promise<void>

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

setAsWindowsMenuForNSApp()

setAsWindowsMenuForNSApp(): Promise<void>

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

这将导致 macOS 自动在菜单中添加窗口切换项以及某些其他项目。

平台特定

• Windows / Linux：不支持。

返回

Promise<void>

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

setEnabled()

setEnabled(enabled): Promise<void>

设置此子菜单是否启用。

参数

参数	类型
enabled	布尔值 (boolean)

返回

Promise<void>

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

setIcon()

setIcon(icon): Promise<void>

为该子菜单设置图标。

参数

参数	类型
icon	null | MenuIcon

返回

Promise<void>

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

setText()

setText(text): Promise<void>

设置此子菜单的文本。

参数

参数	类型
text	string

返回

Promise<void>

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

text()

text(): Promise<string>

返回此子菜单的文本。

返回

Promise<string>

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

new()

static new(opts): Promise<Submenu>

创建新子菜单。

参数

参数	类型
opts	SubmenuOptions

返回

Promise<Submenu>

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

接口

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 | Uint8Array | number[] | ArrayBuffer | 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

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

继承 (Extends)

• MenuItemOptions

属性

属性	类型	描述	继承自 (Inherited from)	定义于
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

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

继承 (Extends)

• MenuItemOptions

属性

属性	类型	描述	继承自 (Inherited from)	定义于
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?	MenuIcon	用于新图标菜单项的图标。注意：使用此 API 可能需要 Cargo 功能 image-ico 或 image-png。要启用它，请修改 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?	( | MenuItemOptions | MenuItem | SubmenuOptions | PredefinedMenuItemOptions | CheckMenuItemOptions | IconMenuItemOptions | PredefinedMenuItem | Submenu | CheckMenuItem | IconMenuItem)[]	要添加到新菜单中的项目列表。	源码: 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

类型别名 (Type Aliases)

SubmenuOptions

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

类型声明

名称	类型	描述	定义于
icon	MenuIcon	用于子菜单的图标。注意：使用此 API 可能需要 Cargo 功能 image-ico 或 image-png。	源码: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/submenu.ts#L56

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