Class 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');

Hierarchy (View Summary)

Resource
- TrayIcon

Index

Properties

Accessors

rid

Methods

close getById removeById new setIcon setMenu setTooltip setTitle setVisible setTempDirPath setIconAsTemplate setMenuOnLeftClick setShowMenuOnLeftClick

Properties

id

id: string

The id associated with this tray icon.

Accessors

rid

get rid(): number
Returns number
Inherited from Resource.rid
- Defined in core.ts:309

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
- Defined in core.ts:321

`Static`getById

getById(id: string): Promise<null | TrayIcon>
Gets a tray icon using the provided id.
Parameters
- id: string
Returns Promise<null | TrayIcon>
- Defined in tray.ts:168

`Static`removeById

removeById(id: string): 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
- id: string
Returns Promise<void>
- Defined in tray.ts:180

`Static`new

new(options?: TrayIconOptions): 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
- Optionaloptions: TrayIconOptions
Returns Promise<TrayIcon>
- Defined in tray.ts:192

setIcon

setIcon(
    icon:
        | null
        | string
        | number[]
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Image,
): Promise<void>
Sets a new tray icon. If null is provided, it will remove the icon.

Note that you may 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
- icon: null | string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image
Returns Promise<void>
- Defined in tray.ts:224

setMenu

setMenu(menu: null | Submenu | 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
- menu: null | Submenu | Menu
Returns Promise<void>
- Defined in tray.ts:241

setTooltip

setTooltip(tooltip: null | string): Promise<void>
Sets the tooltip for this tray icon.

Platform-specific:
- Linux: Unsupported
Parameters
- tooltip: null | string
Returns Promise<void>
- Defined in tray.ts:256

setTitle

setTitle(title: null | string): 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
- title: null | string
Returns Promise<void>
- Defined in tray.ts:272

setVisible

setVisible(visible: boolean): Promise<void>
Show or hide this tray icon.
Parameters
- visible: boolean
Returns Promise<void>
- Defined in tray.ts:277

setTempDirPath

setTempDirPath(path: null | string): 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
- path: null | string
Returns Promise<void>
- Defined in tray.ts:287

setIconAsTemplate

setIconAsTemplate(asTemplate: boolean): Promise<void>
Sets the current icon as a template. macOS only
Parameters
- asTemplate: boolean
Returns Promise<void>
- Defined in tray.ts:292

setMenuOnLeftClick

setMenuOnLeftClick(onLeft: boolean): Promise<void>
Disable or enable showing the tray menu on left click.

Platform-specific:
- Linux: Unsupported.
Parameters
- onLeft: boolean
Returns Promise<void>
Deprecated
use TrayIcon.setShowMenuOnLeftClick instead.
- Defined in tray.ts:308

setShowMenuOnLeftClick

setShowMenuOnLeftClick(onLeft: boolean): Promise<void>
Disable or enable showing the tray menu on left click.

Platform-specific:
- Linux: Unsupported.
Parameters
- onLeft: boolean
Returns Promise<void>
Since
2.2.0
- Defined in tray.ts:324

Class TrayIcon

Warning

Example

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

id

Accessors

rid

Returns number

Methods

close

Returns Promise<void>

StaticgetById

Parameters

Returns Promise<null | TrayIcon>

StaticremoveById

Parameters

Returns Promise<void>

Staticnew

Platform-specific:

Parameters

Returns Promise<TrayIcon>

setIcon

Parameters

Returns Promise<void>

setMenu

Platform-specific:

Parameters

Returns Promise<void>

setTooltip

Platform-specific:

Parameters

Returns Promise<void>

setTitle

Platform-specific:

Parameters

Returns Promise<void>

setVisible

Parameters

Returns Promise<void>

setTempDirPath

Parameters

Returns Promise<void>

setIconAsTemplate

Parameters

Returns Promise<void>

setMenuOnLeftClick

Platform-specific:

Parameters

Returns Promise<void>

Deprecated

setShowMenuOnLeftClick

Platform-specific:

Parameters

Returns Promise<void>

Since

Settings

On This Page

`Static`getById

`Static`removeById

`Static`new