File size: 6,429 Bytes
adb87a5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | 'use strict';
var core = require('./core.cjs');
var image = require('./image.cjs');
var dpi = require('./dpi.cjs');
// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
/**
* 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');
* ```
*/
class TrayIcon extends core.Resource {
constructor(rid, id) {
super(rid);
this.id = id;
}
/** Gets a tray icon using the provided id. */
static async getById(id) {
return core.invoke('plugin:tray|get_by_id', { id }).then((rid) => rid ? new TrayIcon(rid, id) : null);
}
/**
* 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 async removeById(id) {
return core.invoke('plugin:tray|remove_by_id', { id });
}
/**
* 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 async new(options) {
if (options === null || options === void 0 ? void 0 : options.menu) {
// @ts-expect-error we only need the rid and kind
options.menu = [options.menu.rid, options.menu.kind];
}
if (options === null || options === void 0 ? void 0 : options.icon) {
options.icon = image.transformImage(options.icon);
}
const handler = new core.Channel();
if (options === null || options === void 0 ? void 0 : options.action) {
const action = options.action;
handler.onmessage = (e) => action(mapEvent(e));
delete options.action;
}
return core.invoke('plugin:tray|new', {
options: options !== null && options !== void 0 ? options : {},
handler
}).then(([rid, id]) => new TrayIcon(rid, id));
}
/**
* 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"] }
* ```
*/
async setIcon(icon) {
let trayIcon = null;
if (icon) {
trayIcon = image.transformImage(icon);
}
return core.invoke('plugin:tray|set_icon', { rid: this.rid, icon: trayIcon });
}
/**
* Sets a new tray menu.
*
* #### Platform-specific:
*
* - **Linux**: once a menu is set it cannot be removed so `null` has no effect
*/
async setMenu(menu) {
if (menu) {
// @ts-expect-error we only need the rid and kind
menu = [menu.rid, menu.kind];
}
return core.invoke('plugin:tray|set_menu', { rid: this.rid, menu });
}
/**
* Sets the tooltip for this tray icon.
*
* #### Platform-specific:
*
* - **Linux:** Unsupported
*/
async setTooltip(tooltip) {
return core.invoke('plugin:tray|set_tooltip', { rid: this.rid, tooltip });
}
/**
* 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
*/
async setTitle(title) {
return core.invoke('plugin:tray|set_title', { rid: this.rid, title });
}
/** Show or hide this tray icon. */
async setVisible(visible) {
return core.invoke('plugin:tray|set_visible', { rid: this.rid, visible });
}
/**
* 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`.
*/
async setTempDirPath(path) {
return core.invoke('plugin:tray|set_temp_dir_path', { rid: this.rid, path });
}
/** Sets the current icon as a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc). **macOS only** */
async setIconAsTemplate(asTemplate) {
return core.invoke('plugin:tray|set_icon_as_template', {
rid: this.rid,
asTemplate
});
}
/**
* Disable or enable showing the tray menu on left click.
*
* #### Platform-specific:
*
* - **Linux**: Unsupported.
*
* @deprecated use {@linkcode TrayIcon.setShowMenuOnLeftClick} instead.
*/
async setMenuOnLeftClick(onLeft) {
return core.invoke('plugin:tray|set_show_menu_on_left_click', {
rid: this.rid,
onLeft
});
}
/**
* Disable or enable showing the tray menu on left click.
*
* #### Platform-specific:
*
* - **Linux**: Unsupported.
*
* @since 2.2.0
*/
async setShowMenuOnLeftClick(onLeft) {
return core.invoke('plugin:tray|set_show_menu_on_left_click', {
rid: this.rid,
onLeft
});
}
}
function mapEvent(e) {
const out = e;
out.position = new dpi.PhysicalPosition(e.position);
out.rect.position = new dpi.PhysicalPosition(e.rect.position);
out.rect.size = new dpi.PhysicalSize(e.rect.size);
return out;
}
exports.TrayIcon = TrayIcon;
|