kotlin-tauri-apps-api/tauri.apps.api.tray/TrayIcon

TrayIcon

external class TrayIcon : Resource(source)

Tray icon class and associated methods. This type constructor is private, instead, you should use the static method {@linkcode 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 and remove the tray early, you need to call {@linkcode TrayIcon.close}.

Constructors

constructor()

Types

external object Companion

Properties

external var id: String

The id associated with this tray icon.

external val rid: Double

Functions

external fun 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.

external fun setIcon(icon: JsImage?): Promise<Void>

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

setIconAsTemplate

external fun setIconAsTemplate(asTemplate: Boolean): Promise<Void>

Sets the current icon as a template. macOS only

setIconWithAsTemplate

external fun setIconWithAsTemplate(icon: JsImage?, asTemplate: Boolean): Promise<Void>

Sets a new tray icon and template status atomically. macOS only.

external fun setMenu(menu: Menu?): Promise<Void>

external fun setMenu(menu: Submenu?): Promise<Void>

Sets a new tray menu.

setMenuOnLeftClick

external fun setMenuOnLeftClick(onLeft: Boolean): Promise<Void>

Disable or enable showing the tray menu on left click.

setShowMenuOnLeftClick

external fun setShowMenuOnLeftClick(onLeft: Boolean): Promise<Void>

Disable or enable showing the tray menu on left click.

external fun setTempDirPath(path: String?): Promise<Void>

Sets the tray icon temp dir path. Linux only.

external fun setTitle(title: String?): Promise<Void>

Sets the title shown next to this tray icon.

external fun setTooltip(tooltip: String?): Promise<Void>

Sets the tooltip for this tray icon, shown when the cursor hovers it.

external fun setVisible(visible: Boolean): Promise<Void>

Show or hide this tray icon.