@zturnlibs/ztron-api

---

tray#

Classes#

TrayIcon#

Defined in: tray.ts:94

类风格的托盘 API——@tauri-apps/api/tray TrayIcon 的移植。G5/B9：宿主保留至多 MAX_TRAYS 个 NSStatusItem；无 id 的方法作用于旧默认实例，带 id 的方法寻址其他实例。

Properties#

id#

readonly id: string

Defined in: tray.ts:95

Methods#

destroy()#

destroy(): Promise<void>

Defined in: tray.ts:198

移除托盘项。

Returns#

Promise<void>

onClick()#

onClick(handler): Promise<() => Promise<void>>

Defined in: tray.ts:193

监听点击（仅在未挂菜单时）。

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

onDetailedClick()#

onDetailedClick(handler): Promise<() => Promise<void>>

Defined in: tray.ts:146

富点击流（G5/B9）：宿主能提供时 handler 收到归属信息——button/clickCount/double/屏幕坐标；旧版 onClick 保持零参形状。

Parameters#

handler#

(e) => void

Returns#

Promise<() => Promise<void>>

setIcon()#

setIcon(icon): Promise<void>

Defined in: tray.ts:170

Parameters#

icon#

ImageLike

Returns#

Promise<void>

setIconAsTemplate()#

setIconAsTemplate(asTemplate): Promise<void>

Defined in: tray.ts:188

把当前图标标记为模板图像——macOS 在亮/暗菜单栏中自适应渲染（单色 alpha 图）。

Parameters#

asTemplate#

boolean

Returns#

Promise<void>

setMenu()#

setMenu(menuId): Promise<void>

Defined in: tray.ts:175

挂接已注册的菜单（macOS 上左键弹出）。

Parameters#

menuId#

string

Returns#

Promise<void>

setShowMenuOnLeftClick()#

setShowMenuOnLeftClick(on): Promise<void>

Defined in: tray.ts:134

切换实例的左键弹菜单行为（默认 = 旧实例）。

Parameters#

on#

boolean

Returns#

Promise<void>

setTitle()#

setTitle(title): Promise<void>

Defined in: tray.ts:162

Parameters#

title#

string

Returns#

Promise<void>

setTooltip()#

setTooltip(tooltip): Promise<void>

Defined in: tray.ts:166

Parameters#

tooltip#

string

Returns#

Promise<void>

setVisible()#

setVisible(visible): Promise<void>

Defined in: tray.ts:180

显示/隐藏托盘项。

Parameters#

visible#

boolean

Returns#

Promise<void>

create()#

static create(options?): Promise<TrayIcon>

Defined in: tray.ts:102

创建原生托盘项（title/tooltip 可选；id 用于额外实例）。

Parameters#

options?#

icon?#

ImageLike

id?#

string

menuOnLeftClick?#

boolean

title?#

string

tooltip?#

string

Returns#

Promise<TrayIcon>

getById()#

static getById(id): Promise<boolean>

Defined in: tray.ts:124

此 id 的托盘实例是否存在（上游 TrayIcon.getById）。

Parameters#

id#

string

Returns#

Promise<boolean>

removeById()#

static removeById(id): Promise<void>

Defined in: tray.ts:129

按 id 移除实例（上游 TrayIcon.removeById）。

Parameters#

id#

string

Returns#

Promise<void>

Interfaces#

TrayOptions#

Defined in: tray.ts:9

Properties#

title#

title: string

Defined in: tray.ts:10

tooltip?#

optional tooltip?: string

Defined in: tray.ts:11

Variables#

tray#

const tray: object

Defined in: tray.ts:79

Type Declaration#

create#

create: (options) => Promise<void> = createTray

创建带文本标题的系统托盘项。

Parameters#

options#

TrayOptions

Returns#

Promise<void>

destroy#

destroy: () => Promise<void> = destroyTray

Returns#

Promise<void>

onClick#

onClick: (handler) => Promise<() => Promise<void>> = onTrayClick

监听托盘点击。

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

setIcon#

setIcon: (icon) => Promise<void> = setTrayIcon

从文件路径、已注册 Image 或原始字节设置托盘图标（transformImage 归一化参数）。

Parameters#

icon#

ImageLike

Returns#

Promise<void>

setMenu#

setMenu: (menuId) => Promise<void> = setTrayMenu

把已注册的菜单挂到托盘（macOS 上左键弹出，遵循 NSStatusItem 惯例——Quit/Preferences 的标准位置）。

Parameters#

menuId#

string

Returns#

Promise<void>

setTitle#

setTitle: (title) => Promise<void> = setTrayTitle

Parameters#

title#

string

Returns#

Promise<void>

setTooltip#

setTooltip: (tooltip) => Promise<void> = setTrayTooltip

Parameters#

tooltip#

string

Returns#

Promise<void>

Functions#

createTray()#

createTray(options): Promise<void>

Defined in: tray.ts:15

创建带文本标题的系统托盘项。

Parameters#

options#

TrayOptions

Returns#

Promise<void>

---

destroyTray()#

destroyTray(): Promise<void>

Defined in: tray.ts:42

Returns#

Promise<void>

---

getTrayById()#

getTrayById(id): Promise<boolean>

Defined in: tray.ts:62

此 id 的托盘实例是否存在。

Parameters#

id#

string

Returns#

Promise<boolean>

---

onTrayClick()#

onTrayClick(handler): Promise<() => Promise<void>>

Defined in: tray.ts:55

监听托盘点击。

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

---

removeTrayById()#

removeTrayById(id): Promise<void>

Defined in: tray.ts:67

按 id 移除额外的托盘实例。

Parameters#

id#

string

Returns#

Promise<void>

---

setShowMenuOnLeftClick()#

setShowMenuOnLeftClick(on, id?): Promise<void>

Defined in: tray.ts:72

切换左键弹菜单行为（默认 = 旧实例）。

Parameters#

on#

boolean

id?#

string

Returns#

Promise<void>

---

setTrayIcon()#

setTrayIcon(icon): Promise<void>

Defined in: tray.ts:34

从文件路径、已注册 Image 或原始字节设置托盘图标（transformImage 归一化参数）。

Parameters#

icon#

ImageLike

Returns#

Promise<void>

---

setTrayMenu()#

setTrayMenu(menuId): Promise<void>

Defined in: tray.ts:50

把已注册的菜单挂到托盘（macOS 上左键弹出，遵循 NSStatusItem 惯例——Quit/Preferences 的标准位置）。

Parameters#

menuId#

string

Returns#

Promise<void>

---

setTrayTitle()#

setTrayTitle(title): Promise<void>

Defined in: tray.ts:22

Parameters#

title#

string

Returns#

Promise<void>

---

setTrayTooltip()#

setTrayTooltip(tooltip): Promise<void>

Defined in: tray.ts:26

Parameters#

tooltip#

string

Returns#

Promise<void>