@zturnlibs/ztron-api

---

menu#

Classes#

CheckMenuItem#

Defined in: menu.ts:357

Check/toggle item (upstream CheckMenuItem).

Extends#

• MenuItem

Extended by#

• RadioMenuItem

Constructors#

Constructor#

protected new CheckMenuItem(menuId, id): CheckMenuItem

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

CheckMenuItem

Inherited from#

MenuItem.constructor

Properties#

id#

readonly id: string

Defined in: menu.ts:293

Inherited from#

MenuItem.id

menuId#

readonly menuId: string

Defined in: menu.ts:292

Inherited from#

MenuItem.menuId

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

MenuItem.infoEx

isChecked()#

isChecked(): Promise<boolean>

Defined in: menu.ts:366

Returns#

Promise<boolean>

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

Inherited from#

MenuItem.isEnabled

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

Inherited from#

MenuItem.remove

setAccelerator()#

setAccelerator(accelerator): Promise<void>

Defined in: menu.ts:347

Parameters#

accelerator#

string

Returns#

Promise<void>

Inherited from#

MenuItem.setAccelerator

setChecked()#

setChecked(checked): Promise<void>

Defined in: menu.ts:369

Parameters#

checked#

boolean

Returns#

Promise<void>

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

Inherited from#

MenuItem.setEnabled

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

Inherited from#

MenuItem.setText

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

Inherited from#

MenuItem.text

create()#

static create(menu, options): Promise<CheckMenuItem>

Defined in: menu.ts:358

Parameters#

menu#

Menu

options#

accelerator?#

string

checked?#

boolean

id?#

string

text#

string

Returns#

Promise<CheckMenuItem>

Overrides#

MenuItem.create

---

IconMenuItem#

Defined in: menu.ts:391

Stock native-icon item (upstream IconMenuItem).

Extends#

• MenuItemBase

Constructors#

Constructor#

protected new IconMenuItem(menuId, id): IconMenuItem

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

IconMenuItem

Inherited from#

MenuItemBase.constructor

Properties#

id#

readonly id: string

Defined in: menu.ts:293

Inherited from#

MenuItemBase.id

menuId#

readonly menuId: string

Defined in: menu.ts:292

Inherited from#

MenuItemBase.menuId

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

MenuItemBase.infoEx

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

Inherited from#

MenuItemBase.isEnabled

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

Inherited from#

MenuItemBase.remove

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

Inherited from#

MenuItemBase.setEnabled

setIcon()#

setIcon(icon): Promise<void>

Defined in: menu.ts:400

Parameters#

icon#

string

Returns#

Promise<void>

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

Inherited from#

MenuItemBase.setText

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

Inherited from#

MenuItemBase.text

create()#

static create(menu, options): Promise<IconMenuItem>

Defined in: menu.ts:392

Parameters#

menu#

Menu

options#

icon#

string

id?#

string

text#

string

Returns#

Promise<IconMenuItem>

---

Menu#

Defined in: menu.ts:132

Extended by#

• Submenu

Constructors#

Constructor#

new Menu(id, items?): Menu

Defined in: menu.ts:136

Parameters#

id#

string

items?#

MenuItemOptions[] = []

Returns#

Menu

Properties#

id#

readonly id: string

Defined in: menu.ts:133

items#

readonly items: MenuItemOptions[]

Defined in: menu.ts:134

Methods#

append()#

append(item, at?): Promise<void>

Defined in: menu.ts:198

Appends an item at runtime (or inserts at at).

Parameters#

item#

MenuItemOptions

at?#

number

Returns#

Promise<void>

create()#

create(): Promise<void>

Defined in: menu.ts:141

Returns#

Promise<void>

destroy()#

destroy(): Promise<void>

Defined in: menu.ts:257

Returns#

Promise<void>

getItemInfo()#

getItemInfo(itemId): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:208

Reads an item's live state (null when the id is unknown).

Parameters#

itemId#

string

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

popup()#

popup(x?, y?): Promise<void>

Defined in: menu.ts:193

Pops this menu as a context menu at window coordinates — call from a contextmenu DOM event (e.preventDefault() then popup(e.x, e.y)). Omitting the position uses the current cursor location.

Parameters#

x?#

number

y?#

number

Returns#

Promise<void>

remove()#

remove(itemId): Promise<void>

Defined in: menu.ts:203

Removes a runtime item by id.

Parameters#

itemId#

string

Returns#

Promise<void>

removeAt()#

removeAt(index): Promise<void>

Defined in: menu.ts:215

Removes a runtime item by structural index (upstream removeAt).

Parameters#

index#

number

Returns#

Promise<void>

setAsAppMenu()#

setAsAppMenu(): Promise<void>

Defined in: menu.ts:147

Returns#

Promise<void>

setAsHelpMenuForNSApp()#

setAsHelpMenuForNSApp(): Promise<void>

Defined in: menu.ts:253

Marks this submenu as the Help menu of the application.

Returns#

Promise<void>

setAsWindowMenu()#

setAsWindowMenu(label): Promise<void>

Defined in: menu.ts:238

Mounts this menu as one window's own menu bar.

Parameters#

label#

string

Returns#

Promise<void>

setAsWindowsMenuForNSApp()#

setAsWindowsMenuForNSApp(): Promise<void>

Defined in: menu.ts:246

Routes the Window-role submenu to NSApp (Windows menu behaviors).

Returns#

Promise<void>

setItemAccelerator()#

setItemAccelerator(itemId, accelerator): Promise<void>

Defined in: menu.ts:177

Sets the shortcut shown on an item ("CmdOrCtrl+K").

Parameters#

itemId#

string

accelerator#

string

Returns#

Promise<void>

setItemChecked()#

setItemChecked(itemId, checked): Promise<void>

Defined in: menu.ts:168

Sets the state mark of a check/radio item.

Parameters#

itemId#

string

checked#

boolean

Returns#

Promise<void>

setItemEnabled()#

setItemEnabled(itemId, enabled): Promise<void>

Defined in: menu.ts:151

Parameters#

itemId#

string

enabled#

boolean

Returns#

Promise<void>

setItemIcon()#

setItemIcon(itemId, icon): Promise<void>

Defined in: menu.ts:229

Sets a stock native icon on an existing item (IconMenuItem.setIcon).

Parameters#

itemId#

string

icon#

string

Returns#

Promise<void>

setItemTitle()#

setItemTitle(itemId, title): Promise<void>

Defined in: menu.ts:159

Parameters#

itemId#

string

title#

string

Returns#

Promise<void>

snapshot()#

snapshot(): Promise<MenuItemLive[]>

Defined in: menu.ts:224

Structured live snapshot of every direct child (upstream items(); renamed here because this class already carries the config-tree items field from v1).

Returns#

Promise<MenuItemLive[]>

default()#

static default(id?): Promise<Menu>

Defined in: menu.ts:265

Builds and registers the standard platform application menu under an auto-generated root id (upstream Menu.default()).

Parameters#

id?#

string = "$default"

Returns#

Promise<Menu>

new()#

static new(options): Promise<Menu>

Defined in: menu.ts:272

Upstream-style construction: creates AND registers in one call.

Parameters#

options#

id?#

string

items#

Omit<MenuItemOptions, "id"> & object[]

Returns#

Promise<Menu>

---

MenuItem#

Defined in: menu.ts:338

Plain clickable item (upstream MenuItem).

Extends#

• MenuItemBase

Extended by#

• CheckMenuItem

Constructors#

Constructor#

protected new MenuItem(menuId, id): MenuItem

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

MenuItem

Inherited from#

MenuItemBase.constructor

Properties#

id#

readonly id: string

Defined in: menu.ts:293

Inherited from#

MenuItemBase.id

menuId#

readonly menuId: string

Defined in: menu.ts:292

Inherited from#

MenuItemBase.menuId

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

MenuItemBase.infoEx

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

Inherited from#

MenuItemBase.isEnabled

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

Inherited from#

MenuItemBase.remove

setAccelerator()#

setAccelerator(accelerator): Promise<void>

Defined in: menu.ts:347

Parameters#

accelerator#

string

Returns#

Promise<void>

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

Inherited from#

MenuItemBase.setEnabled

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

Inherited from#

MenuItemBase.setText

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

Inherited from#

MenuItemBase.text

create()#

static create(menu, options): Promise<MenuItem>

Defined in: menu.ts:339

Parameters#

menu#

Menu

options#

accelerator?#

string

enabled?#

boolean

id?#

string

text#

string

Returns#

Promise<MenuItem>

---

MenuItemBase#

Defined in: menu.ts:291

Upstream-style item handles (A2 tail): each wraps a (menuId, itemId) pair and exposes the per-item method surface of @tauri-apps/api/menu on top of the existing command protocol.

Extended by#

• MenuItem
• IconMenuItem
• PredefinedMenuItem

Constructors#

Constructor#

protected new MenuItemBase(menuId, id): MenuItemBase

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

MenuItemBase

Properties#

id#

readonly id: string

Defined in: menu.ts:293

menuId#

readonly menuId: string

Defined in: menu.ts:292

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

---

PredefinedMenuItem#

Defined in: menu.ts:410

Predefined system behavior (upstream PredefinedMenuItem).

Extends#

• MenuItemBase

Constructors#

Constructor#

protected new PredefinedMenuItem(menuId, id): PredefinedMenuItem

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

PredefinedMenuItem

Inherited from#

MenuItemBase.constructor

Properties#

id#

readonly id: string

Defined in: menu.ts:293

Inherited from#

MenuItemBase.id

menuId#

readonly menuId: string

Defined in: menu.ts:292

Inherited from#

MenuItemBase.menuId

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

MenuItemBase.infoEx

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

Inherited from#

MenuItemBase.isEnabled

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

Inherited from#

MenuItemBase.remove

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

Inherited from#

MenuItemBase.setEnabled

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

Inherited from#

MenuItemBase.setText

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

Inherited from#

MenuItemBase.text

about()#

static about(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:448

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

copy()#

static copy(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:427

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

create()#

static create(menu, kind, options?): Promise<PredefinedMenuItem>

Defined in: menu.ts:411

Parameters#

menu#

Menu

kind#

string

options?#

id?#

string

text?#

string

Returns#

Promise<PredefinedMenuItem>

cut()#

static cut(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:430

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

fullscreen()#

static fullscreen(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:454

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

minimize()#

static minimize(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:451

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

paste()#

static paste(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:433

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

quit()#

static quit(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:445

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

redo()#

static redo(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:442

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

selectAll()#

static selectAll(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:436

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

separator()#

static separator(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:424

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

undo()#

static undo(menu): Promise<PredefinedMenuItem>

Defined in: menu.ts:439

Parameters#

menu#

Menu

Returns#

Promise<PredefinedMenuItem>

---

RadioMenuItem#

Defined in: menu.ts:379

Radio group item (upstream RadioMenuItem; host state mark).

Extends#

• CheckMenuItem

Constructors#

Constructor#

protected new RadioMenuItem(menuId, id): RadioMenuItem

Defined in: menu.ts:295

Parameters#

menuId#

string

id#

string

Returns#

RadioMenuItem

Inherited from#

CheckMenuItem.constructor

Properties#

id#

readonly id: string

Defined in: menu.ts:293

Inherited from#

CheckMenuItem.id

menuId#

readonly menuId: string

Defined in: menu.ts:292

Inherited from#

CheckMenuItem.menuId

Methods#

infoEx()#

protected infoEx(): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:332

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

CheckMenuItem.infoEx

isChecked()#

isChecked(): Promise<boolean>

Defined in: menu.ts:366

Returns#

Promise<boolean>

Inherited from#

CheckMenuItem.isChecked

isEnabled()#

isEnabled(): Promise<boolean>

Defined in: menu.ts:310

Returns#

Promise<boolean>

Inherited from#

CheckMenuItem.isEnabled

remove()#

remove(): Promise<void>

Defined in: menu.ts:320

Returns#

Promise<void>

Inherited from#

CheckMenuItem.remove

setAccelerator()#

setAccelerator(accelerator): Promise<void>

Defined in: menu.ts:347

Parameters#

accelerator#

string

Returns#

Promise<void>

Inherited from#

CheckMenuItem.setAccelerator

setChecked()#

setChecked(checked): Promise<void>

Defined in: menu.ts:369

Parameters#

checked#

boolean

Returns#

Promise<void>

Inherited from#

CheckMenuItem.setChecked

setEnabled()#

setEnabled(enabled): Promise<void>

Defined in: menu.ts:313

Parameters#

enabled#

boolean

Returns#

Promise<void>

Inherited from#

CheckMenuItem.setEnabled

setText()#

setText(text): Promise<void>

Defined in: menu.ts:303

Parameters#

text#

string

Returns#

Promise<void>

Inherited from#

CheckMenuItem.setText

text()#

text(): Promise<string>

Defined in: menu.ts:300

Returns#

Promise<string>

Inherited from#

CheckMenuItem.text

create()#

static create(menu, options): Promise<RadioMenuItem>

Defined in: menu.ts:380

Parameters#

menu#

Menu

options#

checked?#

boolean

id?#

string

text#

string

Returns#

Promise<RadioMenuItem>

Overrides#

CheckMenuItem.create

---

Submenu#

Defined in: menu.ts:465

Runtime submenu (upstream Submenu): registers a child menu and mounts it as a submenu item of parent.

Extends#

• Menu

Properties#

id#

readonly id: string

Defined in: menu.ts:133

Inherited from#

Menu.id

items#

readonly items: MenuItemOptions[]

Defined in: menu.ts:134

Inherited from#

Menu.items

Methods#

append()#

append(item, at?): Promise<void>

Defined in: menu.ts:198

Appends an item at runtime (or inserts at at).

Parameters#

item#

MenuItemOptions

at?#

number

Returns#

Promise<void>

Inherited from#

Menu.append

create()#

create(): Promise<void>

Defined in: menu.ts:141

Returns#

Promise<void>

Inherited from#

Menu.create

destroy()#

destroy(): Promise<void>

Defined in: menu.ts:257

Returns#

Promise<void>

Inherited from#

Menu.destroy

getItemInfo()#

getItemInfo(itemId): Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Defined in: menu.ts:208

Reads an item's live state (null when the id is unknown).

Parameters#

itemId#

string

Returns#

Promise<{ checked: boolean; enabled: boolean; title: string; } | null>

Inherited from#

Menu.getItemInfo

popup()#

popup(x?, y?): Promise<void>

Defined in: menu.ts:193

Pops this menu as a context menu at window coordinates — call from a contextmenu DOM event (e.preventDefault() then popup(e.x, e.y)). Omitting the position uses the current cursor location.

Parameters#

x?#

number

y?#

number

Returns#

Promise<void>

Inherited from#

Menu.popup

remove()#

remove(itemId): Promise<void>

Defined in: menu.ts:203

Removes a runtime item by id.

Parameters#

itemId#

string

Returns#

Promise<void>

Inherited from#

Menu.remove

removeAt()#

removeAt(index): Promise<void>

Defined in: menu.ts:215

Removes a runtime item by structural index (upstream removeAt).

Parameters#

index#

number

Returns#

Promise<void>

Inherited from#

Menu.removeAt

setAsAppMenu()#

setAsAppMenu(): Promise<void>

Defined in: menu.ts:147

Returns#

Promise<void>

Inherited from#

Menu.setAsAppMenu

setAsHelpMenuForNSApp()#

setAsHelpMenuForNSApp(): Promise<void>

Defined in: menu.ts:253

Marks this submenu as the Help menu of the application.

Returns#

Promise<void>

Inherited from#

Menu.setAsHelpMenuForNSApp

setAsWindowMenu()#

setAsWindowMenu(label): Promise<void>

Defined in: menu.ts:238

Mounts this menu as one window's own menu bar.

Parameters#

label#

string

Returns#

Promise<void>

Inherited from#

Menu.setAsWindowMenu

setAsWindowsMenuForNSApp()#

setAsWindowsMenuForNSApp(): Promise<void>

Defined in: menu.ts:246

Routes the Window-role submenu to NSApp (Windows menu behaviors).

Returns#

Promise<void>

Inherited from#

Menu.setAsWindowsMenuForNSApp

setItemAccelerator()#

setItemAccelerator(itemId, accelerator): Promise<void>

Defined in: menu.ts:177

Sets the shortcut shown on an item ("CmdOrCtrl+K").

Parameters#

itemId#

string

accelerator#

string

Returns#

Promise<void>

Inherited from#

Menu.setItemAccelerator

setItemChecked()#

setItemChecked(itemId, checked): Promise<void>

Defined in: menu.ts:168

Sets the state mark of a check/radio item.

Parameters#

itemId#

string

checked#

boolean

Returns#

Promise<void>

Inherited from#

Menu.setItemChecked

setItemEnabled()#

setItemEnabled(itemId, enabled): Promise<void>

Defined in: menu.ts:151

Parameters#

itemId#

string

enabled#

boolean

Returns#

Promise<void>

Inherited from#

Menu.setItemEnabled

setItemIcon()#

setItemIcon(itemId, icon): Promise<void>

Defined in: menu.ts:229

Sets a stock native icon on an existing item (IconMenuItem.setIcon).

Parameters#

itemId#

string

icon#

string

Returns#

Promise<void>

Inherited from#

Menu.setItemIcon

setItemTitle()#

setItemTitle(itemId, title): Promise<void>

Defined in: menu.ts:159

Parameters#

itemId#

string

title#

string

Returns#

Promise<void>

Inherited from#

Menu.setItemTitle

snapshot()#

snapshot(): Promise<MenuItemLive[]>

Defined in: menu.ts:224

Structured live snapshot of every direct child (upstream items(); renamed here because this class already carries the config-tree items field from v1).

Returns#

Promise<MenuItemLive[]>

Inherited from#

Menu.snapshot

create()#

static create(parent, options): Promise<Submenu>

Defined in: menu.ts:469

Parameters#

parent#

Menu

options#

id?#

string

text#

string

Returns#

Promise<Submenu>

default()#

static default(id?): Promise<Menu>

Defined in: menu.ts:265

Builds and registers the standard platform application menu under an auto-generated root id (upstream Menu.default()).

Parameters#

id?#

string = "$default"

Returns#

Promise<Menu>

Inherited from#

Menu.default

new()#

static new(options): Promise<Menu>

Defined in: menu.ts:272

Upstream-style construction: creates AND registers in one call.

Parameters#

options#

id?#

string

items#

Omit<MenuItemOptions, "id"> & object[]

Returns#

Promise<Menu>

Inherited from#

Menu.new

Interfaces#

AboutMetadata#

Defined in: menu.ts:74

Metadata for the standard About panel item (upstream AboutMetadata).

Properties#

authors?#

optional authors?: string[]

Defined in: menu.ts:78

comments?#

optional comments?: string

Defined in: menu.ts:79

copyright?#

optional copyright?: string

Defined in: menu.ts:80

credits?#

optional credits?: string

Defined in: menu.ts:84

license?#

optional license?: string

Defined in: menu.ts:81

name?#

optional name?: string

Defined in: menu.ts:75

shortVersion?#

optional shortVersion?: string

Defined in: menu.ts:77

version?#

optional version?: string

Defined in: menu.ts:76

website?#

optional website?: string

Defined in: menu.ts:82

websiteLabel?#

optional websiteLabel?: string

Defined in: menu.ts:83

---

IconMenuItemOptions#

Defined in: menu.ts:88

Options for items carrying a stock icon (upstream IconMenuItemOptions).

Properties#

accelerator?#

optional accelerator?: string

Defined in: menu.ts:94

enabled?#

optional enabled?: boolean

Defined in: menu.ts:93

icon#

icon: string

Defined in: menu.ts:92

A NativeIcon kind (file/image-id sources land later).

id?#

optional id?: string

Defined in: menu.ts:89

text#

text: string

Defined in: menu.ts:90

---

MenuEvent#

Defined in: menu.ts:127

Properties#

itemId#

itemId: string

Defined in: menu.ts:129

menuId#

menuId: string

Defined in: menu.ts:128

---

MenuItemLive#

Defined in: menu.ts:98

Live child snapshot served by Menu.items (upstream items()).

Properties#

checked#

checked: boolean

Defined in: menu.ts:103

enabled#

enabled: boolean

Defined in: menu.ts:102

hasSubmenu#

hasSubmenu: boolean

Defined in: menu.ts:105

id#

id: string

Defined in: menu.ts:99

menuId#

menuId: string

Defined in: menu.ts:100

separator#

separator: boolean

Defined in: menu.ts:104

title#

title: string

Defined in: menu.ts:101

---

MenuItemOptions#

Defined in: menu.ts:108

Properties#

accelerator?#

optional accelerator?: string

Defined in: menu.ts:118

Item shortcut ("CmdOrCtrl+Shift+K"; shown on the item, parsed host-side).

checked?#

optional checked?: boolean

Defined in: menu.ts:116

Initial checked state for check/radio items.

children?#

optional children?: MenuItemOptions[]

Defined in: menu.ts:124

Nested submenu items.

enabled?#

optional enabled?: boolean

Defined in: menu.ts:111

icon?#

optional icon?: string

Defined in: menu.ts:122

Stock native icon kind (NativeIcon value or explicit image name).

id#

id: string

Defined in: menu.ts:109

predefined?#

optional predefined?: string

Defined in: menu.ts:120

Predefined system behavior ("copy"/"paste"/"quit"/"about"/…).

separator?#

optional separator?: boolean

Defined in: menu.ts:112

text#

text: string

Defined in: menu.ts:110

type?#

optional type?: "normal" | "check" | "radio"

Defined in: menu.ts:114

Item kind: normal / check / radio.

Type Aliases#

NativeIcon#

NativeIcon = typeof NativeIcon[keyof typeof NativeIcon]

Defined in: menu.ts:13

Stock native icons (Tauri NativeIcon parity) — resolved host-side to AppKit template images; unmapped names degrade to icon-less items.

Variables#

NativeIcon#

const NativeIcon: object

Defined in: menu.ts:13

Stock native icons (Tauri NativeIcon parity) — resolved host-side to AppKit template images; unmapped names degrade to icon-less items.

Type Declaration#

Add#

readonly Add: "Add" = "Add"

Advanced#

readonly Advanced: "Advanced" = "Advanced"

Bluetooth#

readonly Bluetooth: "Bluetooth" = "Bluetooth"

Bookmarks#

readonly Bookmarks: "Bookmarks" = "Bookmarks"

Caution#

readonly Caution: "Caution" = "Caution"

ColorPanel#

readonly ColorPanel: "ColorPanel" = "ColorPanel"

ColumnView#

readonly ColumnView: "ColumnView" = "ColumnView"

Computer#

readonly Computer: "Computer" = "Computer"

EnterFullScreen#

readonly EnterFullScreen: "EnterFullScreen" = "EnterFullScreen"

Everyone#

readonly Everyone: "Everyone" = "Everyone"

ExitFullScreen#

readonly ExitFullScreen: "ExitFullScreen" = "ExitFullScreen"

FlowView#

readonly FlowView: "FlowView" = "FlowView"

Folder#

readonly Folder: "Folder" = "Folder"

FolderBurnable#

readonly FolderBurnable: "FolderBurnable" = "FolderBurnable"

FolderSmart#

readonly FolderSmart: "FolderSmart" = "FolderSmart"

FollowLinkFreestanding#

readonly FollowLinkFreestanding: "FollowLinkFreestanding" = "FollowLinkFreestanding"

FontPanel#

readonly FontPanel: "FontPanel" = "FontPanel"

GoLeft#

readonly GoLeft: "GoLeft" = "GoLeft"

GoRight#

readonly GoRight: "GoRight" = "GoRight"

Home#

readonly Home: "Home" = "Home"

IChatTheater#

readonly IChatTheater: "IChatTheater" = "IChatTheater"

IconView#

readonly IconView: "IconView" = "IconView"

Info#

readonly Info: "Info" = "Info"

InvalidDataFreestanding#

readonly InvalidDataFreestanding: "InvalidDataFreestanding" = "InvalidDataFreestanding"

LeftFacingTriangle#

readonly LeftFacingTriangle: "LeftFacingTriangle" = "LeftFacingTriangle"

ListView#

readonly ListView: "ListView" = "ListView"

LockLocked#

readonly LockLocked: "LockLocked" = "LockLocked"

LockUnlocked#

readonly LockUnlocked: "LockUnlocked" = "LockUnlocked"

MenuMixedState#

readonly MenuMixedState: "MenuMixedState" = "MenuMixedState"

MenuOnState#

readonly MenuOnState: "MenuOnState" = "MenuOnState"

MobileMe#

readonly MobileMe: "MobileMe" = "MobileMe"

MultipleDocuments#

readonly MultipleDocuments: "MultipleDocuments" = "MultipleDocuments"

Network#

readonly Network: "Network" = "Network"

Path#

readonly Path: "Path" = "Path"

PreferencesGeneral#

readonly PreferencesGeneral: "PreferencesGeneral" = "PreferencesGeneral"

QuickLook#

readonly QuickLook: "QuickLook" = "QuickLook"

Refresh#

readonly Refresh: "Refresh" = "Refresh"

RefreshFreestanding#

readonly RefreshFreestanding: "RefreshFreestanding" = "RefreshFreestanding"

Remove#

readonly Remove: "Remove" = "Remove"

RevealFreestanding#

readonly RevealFreestanding: "RevealFreestanding" = "RevealFreestanding"

RightFacingTriangle#

readonly RightFacingTriangle: "RightFacingTriangle" = "RightFacingTriangle"

Share#

readonly Share: "Share" = "Share"

Slideshow#

readonly Slideshow: "Slideshow" = "Slideshow"

SmartBadge#

readonly SmartBadge: "SmartBadge" = "SmartBadge"

StatusAvailable#

readonly StatusAvailable: "StatusAvailable" = "StatusAvailable"

StatusNone#

readonly StatusNone: "StatusNone" = "StatusNone"

StatusPartiallyAvailable#

readonly StatusPartiallyAvailable: "StatusPartiallyAvailable" = "StatusPartiallyAvailable"

StatusUnavailable#

readonly StatusUnavailable: "StatusUnavailable" = "StatusUnavailable"

StopProgress#

readonly StopProgress: "StopProgress" = "StopProgress"

StopProgressFreestanding#

readonly StopProgressFreestanding: "StopProgressFreestanding" = "StopProgressFreestanding"

TrashEmpty#

readonly TrashEmpty: "TrashEmpty" = "TrashEmpty"

TrashFull#

readonly TrashFull: "TrashFull" = "TrashFull"

User#

readonly User: "User" = "User"

UserAccounts#

readonly UserAccounts: "UserAccounts" = "UserAccounts"

UserGroup#

readonly UserGroup: "UserGroup" = "UserGroup"

UserGuest#

readonly UserGuest: "UserGuest" = "UserGuest"

Functions#

onMenuEvent()#

onMenuEvent(handler): Promise<UnlistenFn>

Defined in: menu.ts:495

Listens to menu item clicks.

Parameters#

handler#

(event) => void

Returns#

Promise<UnlistenFn>

---

setAppMenu()#

setAppMenu(items): Promise<Menu>

Defined in: menu.ts:487

Creates a menu and installs it as the application menu bar.

Parameters#

items#

MenuItemOptions[]

Returns#

Promise<Menu>