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

Cover Flow 檢視模式範本影像。

來源：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

類別

核取選單項目

核取選單項目在 Menu 或 Submenu 內，通常包含文字和核取記號或類似的切換開關，對應於已核取和未核取狀態。

繼承自

• MenuItemBase

存取器

id

取得簽名

get id(): string

此項目的 ID。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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>

為此核取選單項目設定加速鍵。

參數

參數	類型
加速鍵	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>

為此核取選單項目設定文字。

參數

參數	類型
文字	字串

回傳

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

---

圖示選單項目

圖示選單項目在 Menu 或 Submenu 內，通常包含圖示和文字。

繼承自

• MenuItemBase

存取器

id

取得簽名

get id(): string

此項目的 ID。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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>

為此圖示選單項目設定加速鍵。

參數

參數	類型
加速鍵	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>

為此圖示選單項目設定文字。

參數

參數	類型
文字	字串

回傳

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。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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

參數

參數	類型
項目	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	字串

回傳

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

參數

參數	類型
項目	T | T[]
位置	數字

回傳

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

參數

參數	類型
項目	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>

從此選單中移除指定位置的選單項目。

參數

參數	類型
位置	數字

回傳

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>

Source: 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?	視窗

回傳

Promise<null | Menu>

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

default()

static default(): Promise<Menu>

建立預設選單。

回傳

Promise<Menu>

Source: 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>

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

---

選單項目

選單項目，位於 Menu 或 Submenu 內，且僅包含文字。

繼承自

• MenuItemBase

存取器

id

取得簽名

get id(): string

此項目的 ID。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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>

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

setAccelerator()

setAccelerator(accelerator): Promise<void>

設定此選單項目的快捷鍵。

參數

參數	類型
加速鍵	null | string

回傳

Promise<void>

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

setEnabled()

setEnabled(enabled): Promise<void>

設定此選單項目是否已啟用。

參數

參數	類型
已啟用	布林值

回傳

Promise<void>

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

setText()

setText(text): Promise<void>

設定此選單項目的文字。

參數

參數	類型
文字	字串

回傳

Promise<void>

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

text()

text(): Promise<string>

返回此選單項目的文字。

回傳

Promise<string>

Source: 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>

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

---

預定義選單項目

預定義（原生）選單項目，其行為由作業系統或 tauri 預先定義。

繼承自

• MenuItemBase

存取器

id

取得簽名

get id(): string

此項目的 ID。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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>

設定此預定義選單項目的文字。

參數

參數	類型
文字	字串

回傳

Promise<void>

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

text()

text(): Promise<string>

返回此預定義選單項目的文字。

回傳

Promise<string>

Source: 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>

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

---

子選單

一種類型，為 Menu 或 Submenu 內的子選單。

繼承自

• MenuItemBase

存取器

id

取得簽名

get id(): string

此項目的 ID。

回傳

字串

繼承自

MenuItemBase.id

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

rid

取得簽名

get rid(): 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

參數

參數	類型
項目	T | T[]

回傳

Promise<void>

Source: 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	字串

回傳

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

Source: 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

參數

參數	類型
項目	T | T[]
位置	數字

回傳

Promise<void>

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

isEnabled()

isEnabled(): Promise<boolean>

返回此子選單是否已啟用。

回傳

Promise<boolean>

Source: 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)[]>

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

popup()

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

在指定的視窗上，將此子選單彈出為上下文選單。

如果提供位置，則位置是相對於視窗左上角的。

參數

參數	類型
在?	LogicalPosition | PhysicalPosition
window?	視窗

回傳

Promise<void>

Source: 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

參數

參數	類型
項目	T | T[]

回傳

Promise<void>

Source: 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>

Source: 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>

從此子選單中的指定位置移除選單項目。

參數

參數	類型
位置	數字

回傳

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

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

setAsHelpMenuForNSApp()

setAsHelpMenuForNSApp(): Promise<void>

在 macOS 上，將此子選單設定為應用程式的「說明」選單。

這會使 macOS 自動在選單中新增搜尋框。

如果未將任何選單設定為「說明」選單，macOS 將自動使用任何標題與本地化詞語「Help」相符的選單。

平台特定

• Windows / Linux：不支援。

回傳

Promise<void>

Source: 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>

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

setEnabled()

setEnabled(enabled): Promise<void>

設定此子選單是否已啟用。

參數

參數	類型
已啟用	布林值

回傳

Promise<void>

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

setText()

setText(text): Promise<void>

設定此子選單的文字。

參數

參數	類型
文字	字串

回傳

Promise<void>

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

text()

text(): Promise<string>

返回此子選單的文字。

回傳

Promise<string>

Source: 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>

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

介面

AboutMetadata

關於預定義選單項目的元數據。

屬性

屬性	類型	描述	定義於
authors?	字串[]	應用程式的作者。 #### 平台特定 - **macOS:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L30
comments?	字串	應用程式註解。#### 平台特定 - **macOS:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L38
copyright?	字串	應用程式的版權。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L40
credits?	字串	貢獻者。#### 平台特定 - **Windows / Linux:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L72
icon?	| string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image	應用程式圖示。#### 平台特定 - **Windows:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L80
license?	字串	應用程式的許可證。#### 平台特定 - **macOS:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L48
name?	字串	設定應用程式名稱。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L12
shortVersion?	字串	短版本，例如 “1.0”。#### 平台特定 - **Windows / Linux:** 附加在 version 後面的括號中。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L22
version?	字串	應用程式版本。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L14
website?	字串	應用程式網站。#### 平台特定 - **macOS:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L56
websiteLabel?	字串	網站標籤。#### 平台特定 - **macOS:** 不支援。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L64

---

CheckMenuItemOptions

用於建立新的核取選單項目的選項。

繼承自

• MenuItemOptions

屬性

屬性	類型	描述	繼承自	定義於
accelerator?	字串	為新的選單項目指定快捷鍵。	MenuItemOptions.accelerator	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定在此選單項目被啟用時要呼叫的處理器。	MenuItemOptions.action	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
checked?	布林值	新的核取選單項目是否已啟用。	-	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/checkMenuItem.ts#L12
enabled?	布林值	新的選單項目是否已啟用。	MenuItemOptions.enabled	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	字串	為新的選單項目指定要使用的 ID。	MenuItemOptions.id	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	字串	新的選單項目的文字。	MenuItemOptions.text	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

IconMenuItemOptions

用於建立新的圖示選單項目的選項。

繼承自

• MenuItemOptions

屬性

屬性	類型	描述	繼承自	定義於
accelerator?	字串	為新的選單項目指定快捷鍵。	MenuItemOptions.accelerator	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定在此選單項目被啟用時要呼叫的處理器。	MenuItemOptions.action	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
enabled?	布林值	新的選單項目是否已啟用。	MenuItemOptions.enabled	Source: 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"] }	-	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/iconMenuItem.ts#L144
id?	字串	為新的選單項目指定要使用的 ID。	MenuItemOptions.id	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	字串	新的選單項目的文字。	MenuItemOptions.text	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

MenuItemOptions

用於建立新的選單項目的選項。

擴展自

• CheckMenuItemOptions
• IconMenuItemOptions

屬性

屬性	類型	描述	定義於
accelerator?	字串	為新的選單項目指定快捷鍵。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L17
action?	(id: string) => void	指定在此選單項目被啟用時要呼叫的處理器。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L19
enabled?	布林值	新的選單項目是否已啟用。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L15
id?	字串	為新的選單項目指定要使用的 ID。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L11
text	字串	新的選單項目的文字。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/menuItem.ts#L13

---

MenuOptions

用於建立新的選單的選項。

屬性

屬性	類型	描述	定義於
id?	字串	為新的選單指定要使用的 ID。	Source: 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)[]	要新增至新選單的項目列表。	Source: 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"	預定義項目類型	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L88
text?	字串	新的預定義選單項目的文字。	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/menu/predefinedMenuItem.ts#L86

類型別名

SubmenuOptions

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

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