import type { Menu, Submenu } from './menu'; import { Resource } from './core'; import { Image } from './image'; import { PhysicalPosition, PhysicalSize } from './dpi'; export type MouseButtonState = 'Up' | 'Down'; export type MouseButton = 'Left' | 'Right' | 'Middle'; export type TrayIconEventType = 'Click' | 'DoubleClick' | 'Enter' | 'Move' | 'Leave'; export type TrayIconEventBase = { /** The tray icon event type */ type: T; /** Id of the tray icon which triggered this event. */ id: string; /** Physical position of the click the triggered this event. */ position: PhysicalPosition; /** Position and size of the tray icon. */ rect: { position: PhysicalPosition; size: PhysicalSize; }; }; export type TrayIconClickEvent = { /** Mouse button that triggered this event. */ button: MouseButton; /** Mouse button state when this event was triggered. */ buttonState: MouseButtonState; }; /** * Describes a tray icon event. * * #### 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. */ export type TrayIconEvent = (TrayIconEventBase<'Click'> & TrayIconClickEvent) | (TrayIconEventBase<'DoubleClick'> & Omit) | TrayIconEventBase<'Enter'> | TrayIconEventBase<'Move'> | TrayIconEventBase<'Leave'>; /** * Tray icon types and utilities. * * This package is also accessible with `window.__TAURI__.tray` when [`app.withGlobalTauri`](https://v2.tauri.app/reference/config/#withglobaltauri) in `tauri.conf.json` is set to `true`. * @module */ /** {@link TrayIcon.new|`TrayIcon`} creation options */ export interface TrayIconOptions { /** The tray icon id. If undefined, a random one will be assigned */ id?: string; /** The tray icon menu */ menu?: Menu | Submenu; /** * The tray icon which could be icon bytes or path to the icon file. * * 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: * ```toml * [dependencies] * tauri = { version = "...", features = ["...", "image-png"] } * ``` */ icon?: string | Uint8Array | ArrayBuffer | number[] | Image; /** The tray icon tooltip */ tooltip?: 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. */ title?: 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`. */ tempDirPath?: string; /** * Use the icon as a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc). **macOS only**. */ iconAsTemplate?: boolean; /** * Whether to show the tray menu on left click or not, default is `true`. * * #### Platform-specific: * * - **Linux**: Unsupported. * * @deprecated use {@linkcode TrayIconOptions.showMenuOnLeftClick} instead. */ menuOnLeftClick?: boolean; /** * Whether to show the tray menu on left click or not, default is `true`. * * #### Platform-specific: * * - **Linux**: Unsupported. * * @since 2.2.0 */ showMenuOnLeftClick?: boolean; /** A handler for an event on the tray icon. */ action?: (event: TrayIconEvent) => void; } /** * 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}. * * @example * ```ts * import { TrayIcon } from '@tauri-apps/api/tray'; * const tray = await TrayIcon.new({ tooltip: 'awesome tray tooltip' }); * tray.set_tooltip('new tooltip'); * ``` */ export declare class TrayIcon extends Resource { /** The id associated with this tray icon. */ id: string; private constructor(); /** Gets a tray icon using the provided id. */ static getById(id: string): Promise; /** * 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. */ static removeById(id: string): Promise; /** * Creates a new {@linkcode TrayIcon} * * #### Platform-specific: * * - **Linux:** Sometimes the icon won't be visible unless a menu is set. * Setting an empty {@linkcode Menu} is enough. */ static new(options?: TrayIconOptions): Promise; /** * 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: * ```toml * [dependencies] * tauri = { version = "...", features = ["...", "image-png"] } * ``` */ setIcon(icon: string | Image | Uint8Array | ArrayBuffer | number[] | null): Promise; /** * Sets a new tray menu. * * #### Platform-specific: * * - **Linux**: once a menu is set it cannot be removed so `null` has no effect */ setMenu(menu: Menu | Submenu | null): Promise; /** * Sets the tooltip for this tray icon. * * #### Platform-specific: * * - **Linux:** Unsupported */ setTooltip(tooltip: string | null): Promise; /** * 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 */ setTitle(title: string | null): Promise; /** Show or hide this tray icon. */ setVisible(visible: boolean): Promise; /** * 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`. */ setTempDirPath(path: string | null): Promise; /** Sets the current icon as a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc). **macOS only** */ setIconAsTemplate(asTemplate: boolean): Promise; /** * Disable or enable showing the tray menu on left click. * * #### Platform-specific: * * - **Linux**: Unsupported. * * @deprecated use {@linkcode TrayIcon.setShowMenuOnLeftClick} instead. */ setMenuOnLeftClick(onLeft: boolean): Promise; /** * Disable or enable showing the tray menu on left click. * * #### Platform-specific: * * - **Linux**: Unsupported. * * @since 2.2.0 */ setShowMenuOnLeftClick(onLeft: boolean): Promise; }