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 this object early, you need to call {@linkcode TrayIcon.close}.

Constructors

constructor()

Types

object Companion

Properties

The id associated with this tray icon.

val rid: Double

Functions

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.

fun setIcon(icon: ArrayBuffer?): Promise<Void>

fun setIcon(icon: Uint8Array<*>?): Promise<Void>

fun setIcon(icon: ReadonlyArray<Double>?): Promise<Void>

fun setIcon(icon: String?): Promise<Void>

fun setIcon(icon: Image?): Promise<Void>

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

setIconAsTemplate

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

Sets the current icon as a template. macOS only

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

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

Sets a new tray menu.

setMenuOnLeftClick

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

Disable or enable showing the tray menu on left click.

setShowMenuOnLeftClick

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

Disable or enable showing the tray menu on left click.

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

Sets the tray icon temp dir path. Linux only.

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

Sets the tooltip for this tray icon.

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

Sets the tooltip for this tray icon.

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

Show or hide this tray icon.