tray

Classes

TrayIcon

Tray icon class and associated methods. This type constructor is private, instead, you should use the static method TrayIcon.new.

Warning

Unlike Rust, javascript does not have any way to run cleanup code when an object is being removed by garbage collection, but this tray icon will be cleaned up when the tauri app exists, however if you want to cleanup this object early, you need to call TrayIcon.close.

Example

import { TrayIcon } from '@tauri-apps/api/tray';
const tray = await TrayIcon.new({ tooltip: 'awesome tray tooltip' });
tray.set_tooltip('new tooltip');

Extends

• Resource

Constructors

new TrayIcon()

private new TrayIcon(rid, id): TrayIcon

Parameters

Parameter	Type
rid	number
id	string

Returns

TrayIcon

Overrides

Resource.constructor

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L117

Properties

Property	Modifier	Type	Description	Inherited from
#rid	private	number	-	Resource.#rid
id	public	string	The id associated with this tray icon.	-

Accessors

rid

get rid(): number

Returns

number

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/core.ts#L222

Methods

close()

close(): Promise<void>

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Inherited from

Resource.close

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/core.ts#L234

setIcon()

setIcon(icon): Promise<void>

Sets a new tray icon. If null is provided, it will remove the icon.

Note that you need the image-ico or image-png Cargo features to use this API. To enable it, change your Cargo.toml file:

[dependencies]
tauri = { version = "...", features = ["...", "image-png"] }

Parameters

Parameter	Type
icon	| null | string | number[] | ArrayBuffer | Uint8Array | Image

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L178

setIconAsTemplate()

setIconAsTemplate(asTemplate): Promise<void>

Sets the current icon as a template. macOS only

Parameters

Parameter	Type
asTemplate	boolean

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L246

setMenu()

setMenu(menu): Promise<void>

Sets a new tray menu.

Platform-specific:

• Linux: once a menu is set it cannot be removed so null has no effect

Parameters

Parameter	Type
menu	null | Submenu | Menu

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L195

setMenuOnLeftClick()

setMenuOnLeftClick(onLeft): Promise<void>

Disable or enable showing the tray menu on left click. macOS only.

Parameters

Parameter	Type
onLeft	boolean

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L254

setTempDirPath()

setTempDirPath(path): Promise<void>

Sets the tray icon temp dir path. Linux only.

On Linux, we need to write the icon to the disk and usually it will be $XDG_RUNTIME_DIR/tray-icon or $TEMP/tray-icon.

Parameters

Parameter	Type
path	null | string

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L241

setTitle()

setTitle(title): Promise<void>

Sets the tooltip for this tray icon.

Platform-specific:

• Linux: The title will not be shown unless there is an icon as well. The title is useful for numerical and other frequently updated information. In general, it shouldn’t be shown unless a user requests it as it can take up a significant amount of space on the user’s panel. This may not be shown in all visualizations.
• Windows: Unsupported

Parameters

Parameter	Type
title	null | string

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L226

setTooltip()

setTooltip(tooltip): Promise<void>

Sets the tooltip for this tray icon.

Platform-specific:

• Linux: Unsupported

Parameters

Parameter	Type
tooltip	null | string

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L210

setVisible()

setVisible(visible): Promise<void>

Show or hide this tray icon.

Parameters

Parameter	Type
visible	boolean

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L231

getById()

static getById(id): Promise<null | TrayIcon>

Gets a tray icon using the provided id.

Parameters

Parameter	Type
id	string

Returns

Promise<null | TrayIcon>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L123

new()

static new(options?): Promise<TrayIcon>

Creates a new TrayIcon

Platform-specific:

• Linux: Sometimes the icon won’t be visible unless a menu is set. Setting an empty Menu is enough.

Parameters

Parameter	Type
options?	TrayIconOptions

Returns

Promise<TrayIcon>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L147

removeById()

static removeById(id): Promise<void>

Removes a tray icon using the provided id from tauri’s internal state.

Note that this may cause the tray icon to disappear if it wasn’t cloned somewhere else or referenced by JS.

Parameters

Parameter	Type
id	string

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/tray.ts#L135

Interfaces

TrayIconEvent

Describes a tray event emitted when a tray icon is clicked

Platform-specific:

• Linux: Unsupported. The event is not emitted even though the icon is shown, the icon will still show a context menu on right click.

Properties

Property	Type	Description
clickType	"Left" | "Right" | "Double"	The click type that triggered this event.
iconRect	object	Position and size of the tray icon.
iconRect.bottom	number	The y-coordinate of the lower-right corner of the rectangle.
iconRect.left	number	The x-coordinate of the upper-left corner of the rectangle.
iconRect.right	number	The x-coordinate of the lower-right corner of the rectangle.
iconRect.top	number	The y-coordinate of the upper-left corner of the rectangle.
id	string	Id of the tray icon which triggered this event.
x	number	Physical X Position of the click the triggered this event.
y	number	Physical Y Position of the click the triggered this event.

---

TrayIconOptions

TrayIcon.new|TrayIcon creation options

Properties

Property	Type	Description
action?	(event: TrayIconEvent) => void	A handler for an event on the tray icon.
icon?	| string | number[] | ArrayBuffer | Uint8Array | Image	The tray icon which could be icon bytes or path to the icon file. Note that you need the image-ico or image-png Cargo features to use this API. To enable it, change your Cargo.toml file: [dependencies] tauri = { version = ”…”, features = [”…”, “image-png”] }
iconAsTemplate?	boolean	Use the icon as a template. macOS only.
id?	string	The tray icon id. If undefined, a random one will be assigned
menu?	Submenu | Menu	The tray icon menu
menuOnLeftClick?	boolean	Whether to show the tray menu on left click or not, default is true. macOS only.
tempDirPath?	string	The tray icon temp dir path. Linux only. On Linux, we need to write the icon to the disk and usually it will be $XDG_RUNTIME_DIR/tray-icon or $TEMP/tray-icon.
title?	string	The tray title Platform-specific Linux: The title will not be shown unless there is an icon as well. The title is useful for numerical and other frequently updated information. In general, it shouldn’t be shown unless a user requests it as it can take up a significant amount of space on the user’s panel. This may not be shown in all visualizations. Windows: Unsupported.
tooltip?	string	The tray icon tooltip