@zturnlibs/ztron-api

---

tray#

Classes#

TrayIcon#

Defined in: tray.ts:94

Class-based tray API — a port of @tauri-apps/api/tray TrayIcon. G5/B9: the host keeps up to MAX_TRAYS NSStatusItems; the no-id methods target the legacy default instance, id-bearing ones address others.

Properties#

id#

readonly id: string

Defined in: tray.ts:95

Methods#

destroy()#

destroy(): Promise<void>

Defined in: tray.ts:198

Removes the tray item.

Returns#

Promise<void>

onClick()#

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

Defined in: tray.ts:193

Listens for clicks (only when no menu is attached).

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

onDetailedClick()#

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

Defined in: tray.ts:146

Rich click stream (G5/B9): handler receives attribution when the host can provide it — button/clickCount/double/screen coords; legacy onClick keeps its zero-arg shape.

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

Marks the current icon as a template image — macOS renders it adaptively in light/dark menu bars (monochrome alpha-only art).

Parameters#

asTemplate#

boolean

Returns#

Promise<void>

setMenu()#

setMenu(menuId): Promise<void>

Defined in: tray.ts:175

Attaches a registered menu (left-click shows it on macOS).

Parameters#

menuId#

string

Returns#

Promise<void>

setShowMenuOnLeftClick()#

setShowMenuOnLeftClick(on): Promise<void>

Defined in: tray.ts:134

Toggles left-click menu attachment for the given instance.

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

Shows/hides the tray item.

Parameters#

visible#

boolean

Returns#

Promise<void>

create()#

static create(options?): Promise<TrayIcon>

Defined in: tray.ts:102

Creates the native tray item (title/tooltip optional; id for extra instances).

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

Whether an instance with this id exists (upstream TrayIcon.getById).

Parameters#

id#

string

Returns#

Promise<boolean>

removeById()#

static removeById(id): Promise<void>

Defined in: tray.ts:129

Removes an instance by id (upstream 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

Creates a system tray item with a text title.

Parameters#

options#

TrayOptions

Returns#

Promise<void>

destroy#

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

Returns#

Promise<void>

onClick#

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

Listens to tray clicks.

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

setIcon#

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

Sets the tray icon from a file path, a registered Image, or raw bytes (transformImage normalizes the argument).

Parameters#

icon#

ImageLike

Returns#

Promise<void>

setMenu#

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

Attaches a registered menu to the tray (left-click shows it on macOS, per NSStatusItem convention — the standard place for 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

Creates a system tray item with a text title.

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

Whether a tray instance with this id exists.

Parameters#

id#

string

Returns#

Promise<boolean>

---

onTrayClick()#

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

Defined in: tray.ts:55

Listens to tray clicks.

Parameters#

handler#

() => void

Returns#

Promise<() => Promise<void>>

---

removeTrayById()#

removeTrayById(id): Promise<void>

Defined in: tray.ts:67

Removes an extra tray instance by id.

Parameters#

id#

string

Returns#

Promise<void>

---

setShowMenuOnLeftClick()#

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

Defined in: tray.ts:72

Toggles left-click menu behavior for an instance (default = legacy one).

Parameters#

on#

boolean

id?#

string

Returns#

Promise<void>

---

setTrayIcon()#

setTrayIcon(icon): Promise<void>

Defined in: tray.ts:34

Sets the tray icon from a file path, a registered Image, or raw bytes (transformImage normalizes the argument).

Parameters#

icon#

ImageLike

Returns#

Promise<void>

---

setTrayMenu()#

setTrayMenu(menuId): Promise<void>

Defined in: tray.ts:50

Attaches a registered menu to the tray (left-click shows it on macOS, per NSStatusItem convention — the standard place for 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>