2848d79915
Rust backend: SQLite (WAL mode, 8 tables), vault encryption (Argon2id + AES-256-GCM), settings/connections/credentials services, 19 Tauri command wrappers. 46/46 tests passing. Vue 3 frontend: unlock/create vault flow, Pinia app store, Tailwind CSS v4 dark theme with Wraith branding. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2052 lines
66 KiB
JavaScript
2052 lines
66 KiB
JavaScript
'use strict';
|
||
|
||
var dpi = require('./dpi.cjs');
|
||
var event = require('./event.cjs');
|
||
var core = require('./core.cjs');
|
||
var image = require('./image.cjs');
|
||
|
||
// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
|
||
// SPDX-License-Identifier: Apache-2.0
|
||
// SPDX-License-Identifier: MIT
|
||
/**
|
||
* Provides APIs to create windows, communicate with other windows and manipulate the current window.
|
||
*
|
||
* #### Window events
|
||
*
|
||
* Events can be listened to using {@link Window.listen}:
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* getCurrentWindow().listen("my-window-event", ({ event, payload }) => { });
|
||
* ```
|
||
*
|
||
* @module
|
||
*/
|
||
/**
|
||
* Attention type to request on a window.
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
exports.UserAttentionType = void 0;
|
||
(function (UserAttentionType) {
|
||
/**
|
||
* #### Platform-specific
|
||
* - **macOS:** Bounces the dock icon until the application is in focus.
|
||
* - **Windows:** Flashes both the window and the taskbar button until the application is in focus.
|
||
*/
|
||
UserAttentionType[UserAttentionType["Critical"] = 1] = "Critical";
|
||
/**
|
||
* #### Platform-specific
|
||
* - **macOS:** Bounces the dock icon once.
|
||
* - **Windows:** Flashes the taskbar button until the application is in focus.
|
||
*/
|
||
UserAttentionType[UserAttentionType["Informational"] = 2] = "Informational";
|
||
})(exports.UserAttentionType || (exports.UserAttentionType = {}));
|
||
class CloseRequestedEvent {
|
||
constructor(event) {
|
||
this._preventDefault = false;
|
||
this.event = event.event;
|
||
this.id = event.id;
|
||
}
|
||
preventDefault() {
|
||
this._preventDefault = true;
|
||
}
|
||
isPreventDefault() {
|
||
return this._preventDefault;
|
||
}
|
||
}
|
||
exports.ProgressBarStatus = void 0;
|
||
(function (ProgressBarStatus) {
|
||
/**
|
||
* Hide progress bar.
|
||
*/
|
||
ProgressBarStatus["None"] = "none";
|
||
/**
|
||
* Normal state.
|
||
*/
|
||
ProgressBarStatus["Normal"] = "normal";
|
||
/**
|
||
* Indeterminate state. **Treated as Normal on Linux and macOS**
|
||
*/
|
||
ProgressBarStatus["Indeterminate"] = "indeterminate";
|
||
/**
|
||
* Paused state. **Treated as Normal on Linux**
|
||
*/
|
||
ProgressBarStatus["Paused"] = "paused";
|
||
/**
|
||
* Error state. **Treated as Normal on linux**
|
||
*/
|
||
ProgressBarStatus["Error"] = "error";
|
||
})(exports.ProgressBarStatus || (exports.ProgressBarStatus = {}));
|
||
/**
|
||
* Get an instance of `Window` for the current window.
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
function getCurrentWindow() {
|
||
return new Window(window.__TAURI_INTERNALS__.metadata.currentWindow.label, {
|
||
// @ts-expect-error `skip` is not defined in the public API but it is handled by the constructor
|
||
skip: true
|
||
});
|
||
}
|
||
/**
|
||
* Gets a list of instances of `Window` for all available windows.
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
async function getAllWindows() {
|
||
return core.invoke('plugin:window|get_all_windows').then((windows) => windows.map((w) => new Window(w, {
|
||
// @ts-expect-error `skip` is not defined in the public API but it is handled by the constructor
|
||
skip: true
|
||
})));
|
||
}
|
||
/** @ignore */
|
||
// events that are emitted right here instead of by the created window
|
||
const localTauriEvents = ['tauri://created', 'tauri://error'];
|
||
/**
|
||
* Create new window or get a handle to an existing one.
|
||
*
|
||
* Windows are identified by a *label* a unique identifier that can be used to reference it later.
|
||
* It may only contain alphanumeric characters `a-zA-Z` plus the following special characters `-`, `/`, `:` and `_`.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { Window } from "@tauri-apps/api/window"
|
||
*
|
||
* const appWindow = new Window('theUniqueLabel');
|
||
*
|
||
* appWindow.once('tauri://created', function () {
|
||
* // window successfully created
|
||
* });
|
||
* appWindow.once('tauri://error', function (e) {
|
||
* // an error happened creating the window
|
||
* });
|
||
*
|
||
* // emit an event to the backend
|
||
* await appWindow.emit("some-event", "data");
|
||
* // listen to an event from the backend
|
||
* const unlisten = await appWindow.listen("event-name", e => {});
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
class Window {
|
||
/**
|
||
* Creates a new Window.
|
||
* @example
|
||
* ```typescript
|
||
* import { Window } from '@tauri-apps/api/window';
|
||
* const appWindow = new Window('my-label');
|
||
* appWindow.once('tauri://created', function () {
|
||
* // window successfully created
|
||
* });
|
||
* appWindow.once('tauri://error', function (e) {
|
||
* // an error happened creating the window
|
||
* });
|
||
* ```
|
||
*
|
||
* @param label The unique window label. Must be alphanumeric: `a-zA-Z-/:_`.
|
||
* @returns The {@link Window} instance to communicate with the window.
|
||
*/
|
||
constructor(label, options = {}) {
|
||
var _a;
|
||
this.label = label;
|
||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||
this.listeners = Object.create(null);
|
||
// @ts-expect-error `skip` is not a public API so it is not defined in WindowOptions
|
||
if (!(options === null || options === void 0 ? void 0 : options.skip)) {
|
||
core.invoke('plugin:window|create', {
|
||
options: {
|
||
...options,
|
||
parent: typeof options.parent === 'string'
|
||
? options.parent
|
||
: (_a = options.parent) === null || _a === void 0 ? void 0 : _a.label,
|
||
label
|
||
}
|
||
})
|
||
.then(async () => this.emit('tauri://created'))
|
||
.catch(async (e) => this.emit('tauri://error', e));
|
||
}
|
||
}
|
||
/**
|
||
* Gets the Window associated with the given label.
|
||
* @example
|
||
* ```typescript
|
||
* import { Window } from '@tauri-apps/api/window';
|
||
* const mainWindow = Window.getByLabel('main');
|
||
* ```
|
||
*
|
||
* @param label The window label.
|
||
* @returns The Window instance to communicate with the window or null if the window doesn't exist.
|
||
*/
|
||
static async getByLabel(label) {
|
||
var _a;
|
||
return (_a = (await getAllWindows()).find((w) => w.label === label)) !== null && _a !== void 0 ? _a : null;
|
||
}
|
||
/**
|
||
* Get an instance of `Window` for the current window.
|
||
*/
|
||
static getCurrent() {
|
||
return getCurrentWindow();
|
||
}
|
||
/**
|
||
* Gets a list of instances of `Window` for all available windows.
|
||
*/
|
||
static async getAll() {
|
||
return getAllWindows();
|
||
}
|
||
/**
|
||
* Gets the focused window.
|
||
* @example
|
||
* ```typescript
|
||
* import { Window } from '@tauri-apps/api/window';
|
||
* const focusedWindow = Window.getFocusedWindow();
|
||
* ```
|
||
*
|
||
* @returns The Window instance or `undefined` if there is not any focused window.
|
||
*/
|
||
static async getFocusedWindow() {
|
||
for (const w of await getAllWindows()) {
|
||
if (await w.isFocused()) {
|
||
return w;
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
/**
|
||
* Listen to an emitted event on this window.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const unlisten = await getCurrentWindow().listen<string>('state-changed', (event) => {
|
||
* console.log(`Got error: ${payload}`);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
|
||
* @param handler Event handler.
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async listen(event$1, handler) {
|
||
if (this._handleTauriEvent(event$1, handler)) {
|
||
return () => {
|
||
// eslint-disable-next-line security/detect-object-injection
|
||
const listeners = this.listeners[event$1];
|
||
listeners.splice(listeners.indexOf(handler), 1);
|
||
};
|
||
}
|
||
return event.listen(event$1, handler, {
|
||
target: { kind: 'Window', label: this.label }
|
||
});
|
||
}
|
||
/**
|
||
* Listen to an emitted event on this window only once.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const unlisten = await getCurrentWindow().once<null>('initialized', (event) => {
|
||
* console.log(`Window initialized!`);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
|
||
* @param handler Event handler.
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async once(event$1, handler) {
|
||
if (this._handleTauriEvent(event$1, handler)) {
|
||
return () => {
|
||
// eslint-disable-next-line security/detect-object-injection
|
||
const listeners = this.listeners[event$1];
|
||
listeners.splice(listeners.indexOf(handler), 1);
|
||
};
|
||
}
|
||
return event.once(event$1, handler, {
|
||
target: { kind: 'Window', label: this.label }
|
||
});
|
||
}
|
||
/**
|
||
* Emits an event to all {@link EventTarget|targets}.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().emit('window-loaded', { loggedIn: true, token: 'authToken' });
|
||
* ```
|
||
*
|
||
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
|
||
* @param payload Event payload.
|
||
*/
|
||
async emit(event$1, payload) {
|
||
if (localTauriEvents.includes(event$1)) {
|
||
// eslint-disable-next-line
|
||
for (const handler of this.listeners[event$1] || []) {
|
||
handler({
|
||
event: event$1,
|
||
id: -1,
|
||
payload
|
||
});
|
||
}
|
||
return;
|
||
}
|
||
return event.emit(event$1, payload);
|
||
}
|
||
/**
|
||
* Emits an event to all {@link EventTarget|targets} matching the given target.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().emit('main', 'window-loaded', { loggedIn: true, token: 'authToken' });
|
||
* ```
|
||
* @param target Label of the target Window/Webview/WebviewWindow or raw {@link EventTarget} object.
|
||
* @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
|
||
* @param payload Event payload.
|
||
*/
|
||
async emitTo(target, event$1, payload) {
|
||
if (localTauriEvents.includes(event$1)) {
|
||
// eslint-disable-next-line security/detect-object-injection
|
||
for (const handler of this.listeners[event$1] || []) {
|
||
handler({
|
||
event: event$1,
|
||
id: -1,
|
||
payload
|
||
});
|
||
}
|
||
return;
|
||
}
|
||
return event.emitTo(target, event$1, payload);
|
||
}
|
||
/** @ignore */
|
||
_handleTauriEvent(event, handler) {
|
||
if (localTauriEvents.includes(event)) {
|
||
if (!(event in this.listeners)) {
|
||
// eslint-disable-next-line
|
||
this.listeners[event] = [handler];
|
||
}
|
||
else {
|
||
// eslint-disable-next-line
|
||
this.listeners[event].push(handler);
|
||
}
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
// Getters
|
||
/**
|
||
* The scale factor that can be used to map physical pixels to logical pixels.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const factor = await getCurrentWindow().scaleFactor();
|
||
* ```
|
||
*
|
||
* @returns The window's monitor scale factor.
|
||
*/
|
||
async scaleFactor() {
|
||
return core.invoke('plugin:window|scale_factor', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const position = await getCurrentWindow().innerPosition();
|
||
* ```
|
||
*
|
||
* @returns The window's inner position.
|
||
*/
|
||
async innerPosition() {
|
||
return core.invoke('plugin:window|inner_position', {
|
||
label: this.label
|
||
}).then((p) => new dpi.PhysicalPosition(p));
|
||
}
|
||
/**
|
||
* The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const position = await getCurrentWindow().outerPosition();
|
||
* ```
|
||
*
|
||
* @returns The window's outer position.
|
||
*/
|
||
async outerPosition() {
|
||
return core.invoke('plugin:window|outer_position', {
|
||
label: this.label
|
||
}).then((p) => new dpi.PhysicalPosition(p));
|
||
}
|
||
/**
|
||
* The physical size of the window's client area.
|
||
* The client area is the content of the window, excluding the title bar and borders.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const size = await getCurrentWindow().innerSize();
|
||
* ```
|
||
*
|
||
* @returns The window's inner size.
|
||
*/
|
||
async innerSize() {
|
||
return core.invoke('plugin:window|inner_size', {
|
||
label: this.label
|
||
}).then((s) => new dpi.PhysicalSize(s));
|
||
}
|
||
/**
|
||
* The physical size of the entire window.
|
||
* These dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const size = await getCurrentWindow().outerSize();
|
||
* ```
|
||
*
|
||
* @returns The window's outer size.
|
||
*/
|
||
async outerSize() {
|
||
return core.invoke('plugin:window|outer_size', {
|
||
label: this.label
|
||
}).then((s) => new dpi.PhysicalSize(s));
|
||
}
|
||
/**
|
||
* Gets the window's current fullscreen state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const fullscreen = await getCurrentWindow().isFullscreen();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is in fullscreen mode or not.
|
||
*/
|
||
async isFullscreen() {
|
||
return core.invoke('plugin:window|is_fullscreen', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current minimized state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const minimized = await getCurrentWindow().isMinimized();
|
||
* ```
|
||
*/
|
||
async isMinimized() {
|
||
return core.invoke('plugin:window|is_minimized', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current maximized state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const maximized = await getCurrentWindow().isMaximized();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is maximized or not.
|
||
*/
|
||
async isMaximized() {
|
||
return core.invoke('plugin:window|is_maximized', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current focus state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const focused = await getCurrentWindow().isFocused();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is focused or not.
|
||
*/
|
||
async isFocused() {
|
||
return core.invoke('plugin:window|is_focused', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current decorated state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const decorated = await getCurrentWindow().isDecorated();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is decorated or not.
|
||
*/
|
||
async isDecorated() {
|
||
return core.invoke('plugin:window|is_decorated', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current resizable state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const resizable = await getCurrentWindow().isResizable();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is resizable or not.
|
||
*/
|
||
async isResizable() {
|
||
return core.invoke('plugin:window|is_resizable', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's native maximize button state.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux / iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const maximizable = await getCurrentWindow().isMaximizable();
|
||
* ```
|
||
*
|
||
* @returns Whether the window's native maximize button is enabled or not.
|
||
*/
|
||
async isMaximizable() {
|
||
return core.invoke('plugin:window|is_maximizable', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's native minimize button state.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux / iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const minimizable = await getCurrentWindow().isMinimizable();
|
||
* ```
|
||
*
|
||
* @returns Whether the window's native minimize button is enabled or not.
|
||
*/
|
||
async isMinimizable() {
|
||
return core.invoke('plugin:window|is_minimizable', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's native close button state.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const closable = await getCurrentWindow().isClosable();
|
||
* ```
|
||
*
|
||
* @returns Whether the window's native close button is enabled or not.
|
||
*/
|
||
async isClosable() {
|
||
return core.invoke('plugin:window|is_closable', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current visible state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const visible = await getCurrentWindow().isVisible();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is visible or not.
|
||
*/
|
||
async isVisible() {
|
||
return core.invoke('plugin:window|is_visible', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current title.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const title = await getCurrentWindow().title();
|
||
* ```
|
||
*/
|
||
async title() {
|
||
return core.invoke('plugin:window|title', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Gets the window's current theme.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **macOS:** Theme was introduced on macOS 10.14. Returns `light` on macOS 10.13 and below.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const theme = await getCurrentWindow().theme();
|
||
* ```
|
||
*
|
||
* @returns The window theme.
|
||
*/
|
||
async theme() {
|
||
return core.invoke('plugin:window|theme', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window is configured to be always on top of other windows or not.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const alwaysOnTop = await getCurrentWindow().isAlwaysOnTop();
|
||
* ```
|
||
*
|
||
* @returns Whether the window is visible or not.
|
||
*/
|
||
async isAlwaysOnTop() {
|
||
return core.invoke('plugin:window|is_always_on_top', {
|
||
label: this.label
|
||
});
|
||
}
|
||
// Setters
|
||
/**
|
||
* Centers the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().center();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async center() {
|
||
return core.invoke('plugin:window|center', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Requests user attention to the window, this has no effect if the application
|
||
* is already focused. How requesting for user attention manifests is platform dependent,
|
||
* see `UserAttentionType` for details.
|
||
*
|
||
* Providing `null` will unset the request for user attention. Unsetting the request for
|
||
* user attention might not be done automatically by the WM when the window receives input.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **macOS:** `null` has no effect.
|
||
* - **Linux:** Urgency levels have the same effect.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().requestUserAttention();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async requestUserAttention(requestType) {
|
||
let requestType_ = null;
|
||
if (requestType) {
|
||
if (requestType === exports.UserAttentionType.Critical) {
|
||
requestType_ = { type: 'Critical' };
|
||
}
|
||
else {
|
||
requestType_ = { type: 'Informational' };
|
||
}
|
||
}
|
||
return core.invoke('plugin:window|request_user_attention', {
|
||
label: this.label,
|
||
value: requestType_
|
||
});
|
||
}
|
||
/**
|
||
* Updates the window resizable flag.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setResizable(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setResizable(resizable) {
|
||
return core.invoke('plugin:window|set_resizable', {
|
||
label: this.label,
|
||
value: resizable
|
||
});
|
||
}
|
||
/**
|
||
* Enable or disable the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setEnabled(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async setEnabled(enabled) {
|
||
return core.invoke('plugin:window|set_enabled', {
|
||
label: this.label,
|
||
value: enabled
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window is enabled or disabled.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setEnabled(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async isEnabled() {
|
||
return core.invoke('plugin:window|is_enabled', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Sets whether the window's native maximize button is enabled or not.
|
||
* If resizable is set to false, this setting is ignored.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode.
|
||
* - **Linux / iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setMaximizable(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setMaximizable(maximizable) {
|
||
return core.invoke('plugin:window|set_maximizable', {
|
||
label: this.label,
|
||
value: maximizable
|
||
});
|
||
}
|
||
/**
|
||
* Sets whether the window's native minimize button is enabled or not.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux / iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setMinimizable(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setMinimizable(minimizable) {
|
||
return core.invoke('plugin:window|set_minimizable', {
|
||
label: this.label,
|
||
value: minimizable
|
||
});
|
||
}
|
||
/**
|
||
* Sets whether the window's native close button is enabled or not.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux:** GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible
|
||
* - **iOS / Android:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setClosable(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setClosable(closable) {
|
||
return core.invoke('plugin:window|set_closable', {
|
||
label: this.label,
|
||
value: closable
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window title.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setTitle('Tauri');
|
||
* ```
|
||
*
|
||
* @param title The new title
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setTitle(title) {
|
||
return core.invoke('plugin:window|set_title', {
|
||
label: this.label,
|
||
value: title
|
||
});
|
||
}
|
||
/**
|
||
* Maximizes the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().maximize();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async maximize() {
|
||
return core.invoke('plugin:window|maximize', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Unmaximizes the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().unmaximize();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async unmaximize() {
|
||
return core.invoke('plugin:window|unmaximize', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Toggles the window maximized state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().toggleMaximize();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async toggleMaximize() {
|
||
return core.invoke('plugin:window|toggle_maximize', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Minimizes the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().minimize();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async minimize() {
|
||
return core.invoke('plugin:window|minimize', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Unminimizes the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().unminimize();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async unminimize() {
|
||
return core.invoke('plugin:window|unminimize', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window visibility to true.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().show();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async show() {
|
||
return core.invoke('plugin:window|show', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window visibility to false.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().hide();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async hide() {
|
||
return core.invoke('plugin:window|hide', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Closes the window.
|
||
*
|
||
* Note this emits a closeRequested event so you can intercept it. To force window close, use {@link Window.destroy}.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().close();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async close() {
|
||
return core.invoke('plugin:window|close', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Destroys the window. Behaves like {@link Window.close} but forces the window close instead of emitting a closeRequested event.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().destroy();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async destroy() {
|
||
return core.invoke('plugin:window|destroy', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window should have borders and bars.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setDecorations(false);
|
||
* ```
|
||
*
|
||
* @param decorations Whether the window should have borders and bars.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setDecorations(decorations) {
|
||
return core.invoke('plugin:window|set_decorations', {
|
||
label: this.label,
|
||
value: decorations
|
||
});
|
||
}
|
||
/**
|
||
* Whether or not the window should have shadow.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Windows:**
|
||
* - `false` has no effect on decorated window, shadows are always ON.
|
||
* - `true` will make undecorated window have a 1px white border,
|
||
* and on Windows 11, it will have a rounded corners.
|
||
* - **Linux:** Unsupported.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setShadow(false);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setShadow(enable) {
|
||
return core.invoke('plugin:window|set_shadow', {
|
||
label: this.label,
|
||
value: enable
|
||
});
|
||
}
|
||
/**
|
||
* Set window effects.
|
||
*/
|
||
async setEffects(effects) {
|
||
return core.invoke('plugin:window|set_effects', {
|
||
label: this.label,
|
||
value: effects
|
||
});
|
||
}
|
||
/**
|
||
* Clear any applied effects if possible.
|
||
*/
|
||
async clearEffects() {
|
||
return core.invoke('plugin:window|set_effects', {
|
||
label: this.label,
|
||
value: null
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window should always be on top of other windows.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setAlwaysOnTop(true);
|
||
* ```
|
||
*
|
||
* @param alwaysOnTop Whether the window should always be on top of other windows or not.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setAlwaysOnTop(alwaysOnTop) {
|
||
return core.invoke('plugin:window|set_always_on_top', {
|
||
label: this.label,
|
||
value: alwaysOnTop
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window should always be below other windows.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setAlwaysOnBottom(true);
|
||
* ```
|
||
*
|
||
* @param alwaysOnBottom Whether the window should always be below other windows or not.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setAlwaysOnBottom(alwaysOnBottom) {
|
||
return core.invoke('plugin:window|set_always_on_bottom', {
|
||
label: this.label,
|
||
value: alwaysOnBottom
|
||
});
|
||
}
|
||
/**
|
||
* Prevents the window contents from being captured by other apps.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setContentProtected(true);
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setContentProtected(protected_) {
|
||
return core.invoke('plugin:window|set_content_protected', {
|
||
label: this.label,
|
||
value: protected_
|
||
});
|
||
}
|
||
/**
|
||
* Resizes the window with a new inner size.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setSize(new LogicalSize(600, 500));
|
||
* ```
|
||
*
|
||
* @param size The logical or physical inner size.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setSize(size) {
|
||
return core.invoke('plugin:window|set_size', {
|
||
label: this.label,
|
||
value: size instanceof dpi.Size ? size : new dpi.Size(size)
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window minimum inner size. If the `size` argument is not provided, the constraint is unset.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, PhysicalSize } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setMinSize(new PhysicalSize(600, 500));
|
||
* ```
|
||
*
|
||
* @param size The logical or physical inner size, or `null` to unset the constraint.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setMinSize(size) {
|
||
return core.invoke('plugin:window|set_min_size', {
|
||
label: this.label,
|
||
value: size instanceof dpi.Size ? size : size ? new dpi.Size(size) : null
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window maximum inner size. If the `size` argument is undefined, the constraint is unset.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setMaxSize(new LogicalSize(600, 500));
|
||
* ```
|
||
*
|
||
* @param size The logical or physical inner size, or `null` to unset the constraint.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setMaxSize(size) {
|
||
return core.invoke('plugin:window|set_max_size', {
|
||
label: this.label,
|
||
value: size instanceof dpi.Size ? size : size ? new dpi.Size(size) : null
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window inner size constraints.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setSizeConstraints({ minWidth: 300 });
|
||
* ```
|
||
*
|
||
* @param constraints The logical or physical inner size, or `null` to unset the constraint.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setSizeConstraints(constraints) {
|
||
function logical(pixel) {
|
||
return pixel ? { Logical: pixel } : null;
|
||
}
|
||
return core.invoke('plugin:window|set_size_constraints', {
|
||
label: this.label,
|
||
value: {
|
||
minWidth: logical(constraints === null || constraints === void 0 ? void 0 : constraints.minWidth),
|
||
minHeight: logical(constraints === null || constraints === void 0 ? void 0 : constraints.minHeight),
|
||
maxWidth: logical(constraints === null || constraints === void 0 ? void 0 : constraints.maxWidth),
|
||
maxHeight: logical(constraints === null || constraints === void 0 ? void 0 : constraints.maxHeight)
|
||
}
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window outer position.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setPosition(new LogicalPosition(600, 500));
|
||
* ```
|
||
*
|
||
* @param position The new position, in logical or physical pixels.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setPosition(position) {
|
||
return core.invoke('plugin:window|set_position', {
|
||
label: this.label,
|
||
value: position instanceof dpi.Position ? position : new dpi.Position(position)
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window fullscreen state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setFullscreen(true);
|
||
* ```
|
||
*
|
||
* @param fullscreen Whether the window should go to fullscreen or not.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setFullscreen(fullscreen) {
|
||
return core.invoke('plugin:window|set_fullscreen', {
|
||
label: this.label,
|
||
value: fullscreen
|
||
});
|
||
}
|
||
/**
|
||
* On macOS, Toggles a fullscreen mode that doesn’t require a new macOS space. Returns a boolean indicating whether the transition was successful (this won’t work if the window was already in the native fullscreen).
|
||
* This is how fullscreen used to work on macOS in versions before Lion. And allows the user to have a fullscreen window without using another space or taking control over the entire monitor.
|
||
*
|
||
* On other platforms, this is the same as {@link Window.setFullscreen}.
|
||
*
|
||
* @param fullscreen Whether the window should go to simple fullscreen or not.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setSimpleFullscreen(fullscreen) {
|
||
return core.invoke('plugin:window|set_simple_fullscreen', {
|
||
label: this.label,
|
||
value: fullscreen
|
||
});
|
||
}
|
||
/**
|
||
* Bring the window to front and focus.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setFocus();
|
||
* ```
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setFocus() {
|
||
return core.invoke('plugin:window|set_focus', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Sets whether the window can be focused.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **macOS**: If the window is already focused, it is not possible to unfocus it after calling `set_focusable(false)`.
|
||
* In this case, you might consider calling {@link Window.setFocus} but it will move the window to the back i.e. at the bottom in terms of z-order.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setFocusable(true);
|
||
* ```
|
||
*
|
||
* @param focusable Whether the window can be focused.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setFocusable(focusable) {
|
||
return core.invoke('plugin:window|set_focusable', {
|
||
label: this.label,
|
||
value: focusable
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window icon.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setIcon('/tauri/awesome.png');
|
||
* ```
|
||
*
|
||
* 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"] }
|
||
* ```
|
||
*
|
||
* @param icon Icon bytes or path to the icon file.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setIcon(icon) {
|
||
return core.invoke('plugin:window|set_icon', {
|
||
label: this.label,
|
||
value: image.transformImage(icon)
|
||
});
|
||
}
|
||
/**
|
||
* Whether the window icon should be hidden from the taskbar or not.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **macOS:** Unsupported.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setSkipTaskbar(true);
|
||
* ```
|
||
*
|
||
* @param skip true to hide window icon, false to show it.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setSkipTaskbar(skip) {
|
||
return core.invoke('plugin:window|set_skip_taskbar', {
|
||
label: this.label,
|
||
value: skip
|
||
});
|
||
}
|
||
/**
|
||
* Grabs the cursor, preventing it from leaving the window.
|
||
*
|
||
* There's no guarantee that the cursor will be hidden. You should
|
||
* hide it by yourself if you want so.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux:** Unsupported.
|
||
* - **macOS:** This locks the cursor in a fixed location, which looks visually awkward.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setCursorGrab(true);
|
||
* ```
|
||
*
|
||
* @param grab `true` to grab the cursor icon, `false` to release it.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setCursorGrab(grab) {
|
||
return core.invoke('plugin:window|set_cursor_grab', {
|
||
label: this.label,
|
||
value: grab
|
||
});
|
||
}
|
||
/**
|
||
* Modifies the cursor's visibility.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Windows:** The cursor is only hidden within the confines of the window.
|
||
* - **macOS:** The cursor is hidden as long as the window has input focus, even if the cursor is
|
||
* outside of the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setCursorVisible(false);
|
||
* ```
|
||
*
|
||
* @param visible If `false`, this will hide the cursor. If `true`, this will show the cursor.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setCursorVisible(visible) {
|
||
return core.invoke('plugin:window|set_cursor_visible', {
|
||
label: this.label,
|
||
value: visible
|
||
});
|
||
}
|
||
/**
|
||
* Modifies the cursor icon of the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setCursorIcon('help');
|
||
* ```
|
||
*
|
||
* @param icon The new cursor icon.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setCursorIcon(icon) {
|
||
return core.invoke('plugin:window|set_cursor_icon', {
|
||
label: this.label,
|
||
value: icon
|
||
});
|
||
}
|
||
/**
|
||
* Sets the window background color.
|
||
*
|
||
* #### Platform-specific:
|
||
*
|
||
* - **Windows:** alpha channel is ignored.
|
||
* - **iOS / Android:** Unsupported.
|
||
*
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*
|
||
* @since 2.1.0
|
||
*/
|
||
async setBackgroundColor(color) {
|
||
return core.invoke('plugin:window|set_background_color', { color });
|
||
}
|
||
/**
|
||
* Changes the position of the cursor in window coordinates.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setCursorPosition(new LogicalPosition(600, 300));
|
||
* ```
|
||
*
|
||
* @param position The new cursor position.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setCursorPosition(position) {
|
||
return core.invoke('plugin:window|set_cursor_position', {
|
||
label: this.label,
|
||
value: position instanceof dpi.Position ? position : new dpi.Position(position)
|
||
});
|
||
}
|
||
/**
|
||
* Changes the cursor events behavior.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setIgnoreCursorEvents(true);
|
||
* ```
|
||
*
|
||
* @param ignore `true` to ignore the cursor events; `false` to process them as usual.
|
||
* @returns A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setIgnoreCursorEvents(ignore) {
|
||
return core.invoke('plugin:window|set_ignore_cursor_events', {
|
||
label: this.label,
|
||
value: ignore
|
||
});
|
||
}
|
||
/**
|
||
* Starts dragging the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().startDragging();
|
||
* ```
|
||
*
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async startDragging() {
|
||
return core.invoke('plugin:window|start_dragging', {
|
||
label: this.label
|
||
});
|
||
}
|
||
/**
|
||
* Starts resize-dragging the window.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().startResizeDragging();
|
||
* ```
|
||
*
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async startResizeDragging(direction) {
|
||
return core.invoke('plugin:window|start_resize_dragging', {
|
||
label: this.label,
|
||
value: direction
|
||
});
|
||
}
|
||
/**
|
||
* Sets the badge count. It is app wide and not specific to this window.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Windows**: Unsupported. Use @{linkcode Window.setOverlayIcon} instead.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setBadgeCount(5);
|
||
* ```
|
||
*
|
||
* @param count The badge count. Use `undefined` to remove the badge.
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setBadgeCount(count) {
|
||
return core.invoke('plugin:window|set_badge_count', {
|
||
label: this.label,
|
||
value: count
|
||
});
|
||
}
|
||
/**
|
||
* Sets the badge cont **macOS only**.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setBadgeLabel("Hello");
|
||
* ```
|
||
*
|
||
* @param label The badge label. Use `undefined` to remove the badge.
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setBadgeLabel(label) {
|
||
return core.invoke('plugin:window|set_badge_label', {
|
||
label: this.label,
|
||
value: label
|
||
});
|
||
}
|
||
/**
|
||
* Sets the overlay icon. **Windows only**
|
||
* The overlay icon can be set for every window.
|
||
*
|
||
*
|
||
* 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"] }
|
||
* ```
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setOverlayIcon("/tauri/awesome.png");
|
||
* ```
|
||
*
|
||
* @param icon Icon bytes or path to the icon file. Use `undefined` to remove the overlay icon.
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setOverlayIcon(icon) {
|
||
return core.invoke('plugin:window|set_overlay_icon', {
|
||
label: this.label,
|
||
value: icon ? image.transformImage(icon) : undefined
|
||
});
|
||
}
|
||
/**
|
||
* Sets the taskbar progress state.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux / macOS**: Progress bar is app-wide and not specific to this window.
|
||
* - **Linux**: Only supported desktop environments with `libunity` (e.g. GNOME).
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow, ProgressBarStatus } from '@tauri-apps/api/window';
|
||
* await getCurrentWindow().setProgressBar({
|
||
* status: ProgressBarStatus.Normal,
|
||
* progress: 50,
|
||
* });
|
||
* ```
|
||
*
|
||
* @return A promise indicating the success or failure of the operation.
|
||
*/
|
||
async setProgressBar(state) {
|
||
return core.invoke('plugin:window|set_progress_bar', {
|
||
label: this.label,
|
||
value: state
|
||
});
|
||
}
|
||
/**
|
||
* Sets whether the window should be visible on all workspaces or virtual desktops.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Windows / iOS / Android:** Unsupported.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async setVisibleOnAllWorkspaces(visible) {
|
||
return core.invoke('plugin:window|set_visible_on_all_workspaces', {
|
||
label: this.label,
|
||
value: visible
|
||
});
|
||
}
|
||
/**
|
||
* Sets the title bar style. **macOS only**.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async setTitleBarStyle(style) {
|
||
return core.invoke('plugin:window|set_title_bar_style', {
|
||
label: this.label,
|
||
value: style
|
||
});
|
||
}
|
||
/**
|
||
* Set window theme, pass in `null` or `undefined` to follow system theme
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Linux / macOS**: Theme is app-wide and not specific to this window.
|
||
* - **iOS / Android:** Unsupported.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
async setTheme(theme) {
|
||
return core.invoke('plugin:window|set_theme', {
|
||
label: this.label,
|
||
value: theme
|
||
});
|
||
}
|
||
// Listeners
|
||
/**
|
||
* Listen to window resize.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* const unlisten = await getCurrentWindow().onResized(({ payload: size }) => {
|
||
* console.log('Window resized', size);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onResized(handler) {
|
||
return this.listen(event.TauriEvent.WINDOW_RESIZED, (e) => {
|
||
e.payload = new dpi.PhysicalSize(e.payload);
|
||
handler(e);
|
||
});
|
||
}
|
||
/**
|
||
* Listen to window move.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* const unlisten = await getCurrentWindow().onMoved(({ payload: position }) => {
|
||
* console.log('Window moved', position);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onMoved(handler) {
|
||
return this.listen(event.TauriEvent.WINDOW_MOVED, (e) => {
|
||
e.payload = new dpi.PhysicalPosition(e.payload);
|
||
handler(e);
|
||
});
|
||
}
|
||
/**
|
||
* Listen to window close requested. Emitted when the user requests to closes the window.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* import { confirm } from '@tauri-apps/api/dialog';
|
||
* const unlisten = await getCurrentWindow().onCloseRequested(async (event) => {
|
||
* const confirmed = await confirm('Are you sure?');
|
||
* if (!confirmed) {
|
||
* // user did not confirm closing the window; let's prevent it
|
||
* event.preventDefault();
|
||
* }
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onCloseRequested(handler) {
|
||
// eslint-disable-next-line @typescript-eslint/no-misused-promises
|
||
return this.listen(event.TauriEvent.WINDOW_CLOSE_REQUESTED, async (event) => {
|
||
const evt = new CloseRequestedEvent(event);
|
||
await handler(evt);
|
||
if (!evt.isPreventDefault()) {
|
||
await this.destroy();
|
||
}
|
||
});
|
||
}
|
||
/**
|
||
* Listen to a file drop event.
|
||
* The listener is triggered when the user hovers the selected files on the webview,
|
||
* drops the files or cancels the operation.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/webview";
|
||
* const unlisten = await getCurrentWindow().onDragDropEvent((event) => {
|
||
* if (event.payload.type === 'over') {
|
||
* console.log('User hovering', event.payload.position);
|
||
* } else if (event.payload.type === 'drop') {
|
||
* console.log('User dropped', event.payload.paths);
|
||
* } else {
|
||
* console.log('File drop cancelled');
|
||
* }
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onDragDropEvent(handler) {
|
||
const unlistenDrag = await this.listen(event.TauriEvent.DRAG_ENTER, (event) => {
|
||
handler({
|
||
...event,
|
||
payload: {
|
||
type: 'enter',
|
||
paths: event.payload.paths,
|
||
position: new dpi.PhysicalPosition(event.payload.position)
|
||
}
|
||
});
|
||
});
|
||
const unlistenDragOver = await this.listen(event.TauriEvent.DRAG_OVER, (event) => {
|
||
handler({
|
||
...event,
|
||
payload: {
|
||
type: 'over',
|
||
position: new dpi.PhysicalPosition(event.payload.position)
|
||
}
|
||
});
|
||
});
|
||
const unlistenDrop = await this.listen(event.TauriEvent.DRAG_DROP, (event) => {
|
||
handler({
|
||
...event,
|
||
payload: {
|
||
type: 'drop',
|
||
paths: event.payload.paths,
|
||
position: new dpi.PhysicalPosition(event.payload.position)
|
||
}
|
||
});
|
||
});
|
||
const unlistenCancel = await this.listen(event.TauriEvent.DRAG_LEAVE, (event) => {
|
||
handler({ ...event, payload: { type: 'leave' } });
|
||
});
|
||
return () => {
|
||
unlistenDrag();
|
||
unlistenDrop();
|
||
unlistenDragOver();
|
||
unlistenCancel();
|
||
};
|
||
}
|
||
/**
|
||
* Listen to window focus change.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* const unlisten = await getCurrentWindow().onFocusChanged(({ payload: focused }) => {
|
||
* console.log('Focus changed, window is focused? ' + focused);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onFocusChanged(handler) {
|
||
const unlistenFocus = await this.listen(event.TauriEvent.WINDOW_FOCUS, (event) => {
|
||
handler({ ...event, payload: true });
|
||
});
|
||
const unlistenBlur = await this.listen(event.TauriEvent.WINDOW_BLUR, (event) => {
|
||
handler({ ...event, payload: false });
|
||
});
|
||
return () => {
|
||
unlistenFocus();
|
||
unlistenBlur();
|
||
};
|
||
}
|
||
/**
|
||
* Listen to window scale change. Emitted when the window's scale factor has changed.
|
||
* The following user actions can cause DPI changes:
|
||
* - Changing the display's resolution.
|
||
* - Changing the display's scale factor (e.g. in Control Panel on Windows).
|
||
* - Moving the window to a display with a different scale factor.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* const unlisten = await getCurrentWindow().onScaleChanged(({ payload }) => {
|
||
* console.log('Scale changed', payload.scaleFactor, payload.size);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onScaleChanged(handler) {
|
||
return this.listen(event.TauriEvent.WINDOW_SCALE_FACTOR_CHANGED, handler);
|
||
}
|
||
/**
|
||
* Listen to the system theme change.
|
||
*
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from "@tauri-apps/api/window";
|
||
* const unlisten = await getCurrentWindow().onThemeChanged(({ payload: theme }) => {
|
||
* console.log('New theme: ' + theme);
|
||
* });
|
||
*
|
||
* // you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
|
||
* unlisten();
|
||
* ```
|
||
*
|
||
* @returns A promise resolving to a function to unlisten to the event.
|
||
* Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
|
||
*/
|
||
async onThemeChanged(handler) {
|
||
return this.listen(event.TauriEvent.WINDOW_THEME_CHANGED, handler);
|
||
}
|
||
}
|
||
/**
|
||
* Background throttling policy
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
var BackgroundThrottlingPolicy;
|
||
(function (BackgroundThrottlingPolicy) {
|
||
BackgroundThrottlingPolicy["Disabled"] = "disabled";
|
||
BackgroundThrottlingPolicy["Throttle"] = "throttle";
|
||
BackgroundThrottlingPolicy["Suspend"] = "suspend";
|
||
})(BackgroundThrottlingPolicy || (BackgroundThrottlingPolicy = {}));
|
||
/**
|
||
* The scrollbar style to use in the webview.
|
||
*
|
||
* ## Platform-specific
|
||
*
|
||
* **Windows**: This option must be given the same value for all webviews.
|
||
*
|
||
* @since 2.8.0
|
||
*/
|
||
var ScrollBarStyle;
|
||
(function (ScrollBarStyle) {
|
||
/**
|
||
* The default scrollbar style for the webview.
|
||
*/
|
||
ScrollBarStyle["Default"] = "default";
|
||
/**
|
||
* Fluent UI style overlay scrollbars. **Windows Only**
|
||
*
|
||
* Requires WebView2 Runtime version 125.0.2535.41 or higher, does nothing on older versions,
|
||
* see https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/?tabs=dotnetcsharp#10253541
|
||
*/
|
||
ScrollBarStyle["FluentOverlay"] = "fluentOverlay";
|
||
})(ScrollBarStyle || (ScrollBarStyle = {}));
|
||
/**
|
||
* Platform-specific window effects
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
exports.Effect = void 0;
|
||
(function (Effect) {
|
||
/**
|
||
* A default material appropriate for the view's effectiveAppearance. **macOS 10.14-**
|
||
*
|
||
* @deprecated since macOS 10.14. You should instead choose an appropriate semantic material.
|
||
*/
|
||
Effect["AppearanceBased"] = "appearanceBased";
|
||
/**
|
||
* **macOS 10.14-**
|
||
*
|
||
* @deprecated since macOS 10.14. Use a semantic material instead.
|
||
*/
|
||
Effect["Light"] = "light";
|
||
/**
|
||
* **macOS 10.14-**
|
||
*
|
||
* @deprecated since macOS 10.14. Use a semantic material instead.
|
||
*/
|
||
Effect["Dark"] = "dark";
|
||
/**
|
||
* **macOS 10.14-**
|
||
*
|
||
* @deprecated since macOS 10.14. Use a semantic material instead.
|
||
*/
|
||
Effect["MediumLight"] = "mediumLight";
|
||
/**
|
||
* **macOS 10.14-**
|
||
*
|
||
* @deprecated since macOS 10.14. Use a semantic material instead.
|
||
*/
|
||
Effect["UltraDark"] = "ultraDark";
|
||
/**
|
||
* **macOS 10.10+**
|
||
*/
|
||
Effect["Titlebar"] = "titlebar";
|
||
/**
|
||
* **macOS 10.10+**
|
||
*/
|
||
Effect["Selection"] = "selection";
|
||
/**
|
||
* **macOS 10.11+**
|
||
*/
|
||
Effect["Menu"] = "menu";
|
||
/**
|
||
* **macOS 10.11+**
|
||
*/
|
||
Effect["Popover"] = "popover";
|
||
/**
|
||
* **macOS 10.11+**
|
||
*/
|
||
Effect["Sidebar"] = "sidebar";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["HeaderView"] = "headerView";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["Sheet"] = "sheet";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["WindowBackground"] = "windowBackground";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["HudWindow"] = "hudWindow";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["FullScreenUI"] = "fullScreenUI";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["Tooltip"] = "tooltip";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["ContentBackground"] = "contentBackground";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["UnderWindowBackground"] = "underWindowBackground";
|
||
/**
|
||
* **macOS 10.14+**
|
||
*/
|
||
Effect["UnderPageBackground"] = "underPageBackground";
|
||
/**
|
||
* **Windows 11 Only**
|
||
*/
|
||
Effect["Mica"] = "mica";
|
||
/**
|
||
* **Windows 7/10/11(22H1) Only**
|
||
*
|
||
* #### Notes
|
||
*
|
||
* This effect has bad performance when resizing/dragging the window on Windows 11 build 22621.
|
||
*/
|
||
Effect["Blur"] = "blur";
|
||
/**
|
||
* **Windows 10/11**
|
||
*
|
||
* #### Notes
|
||
*
|
||
* This effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.
|
||
*/
|
||
Effect["Acrylic"] = "acrylic";
|
||
/**
|
||
* Tabbed effect that matches the system dark preference **Windows 11 Only**
|
||
*/
|
||
Effect["Tabbed"] = "tabbed";
|
||
/**
|
||
* Tabbed effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only**
|
||
*/
|
||
Effect["TabbedDark"] = "tabbedDark";
|
||
/**
|
||
* Tabbed effect with light mode **Windows 11 Only**
|
||
*/
|
||
Effect["TabbedLight"] = "tabbedLight";
|
||
})(exports.Effect || (exports.Effect = {}));
|
||
/**
|
||
* Window effect state **macOS only**
|
||
*
|
||
* @see https://developer.apple.com/documentation/appkit/nsvisualeffectview/state
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
exports.EffectState = void 0;
|
||
(function (EffectState) {
|
||
/**
|
||
* Make window effect state follow the window's active state **macOS only**
|
||
*/
|
||
EffectState["FollowsWindowActiveState"] = "followsWindowActiveState";
|
||
/**
|
||
* Make window effect state always active **macOS only**
|
||
*/
|
||
EffectState["Active"] = "active";
|
||
/**
|
||
* Make window effect state always inactive **macOS only**
|
||
*/
|
||
EffectState["Inactive"] = "inactive";
|
||
})(exports.EffectState || (exports.EffectState = {}));
|
||
function mapMonitor(m) {
|
||
return m === null
|
||
? null
|
||
: {
|
||
name: m.name,
|
||
scaleFactor: m.scaleFactor,
|
||
position: new dpi.PhysicalPosition(m.position),
|
||
size: new dpi.PhysicalSize(m.size),
|
||
workArea: {
|
||
position: new dpi.PhysicalPosition(m.workArea.position),
|
||
size: new dpi.PhysicalSize(m.workArea.size)
|
||
}
|
||
};
|
||
}
|
||
/**
|
||
* Returns the monitor on which the window currently resides.
|
||
* Returns `null` if current monitor can't be detected.
|
||
* @example
|
||
* ```typescript
|
||
* import { currentMonitor } from '@tauri-apps/api/window';
|
||
* const monitor = await currentMonitor();
|
||
* ```
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
async function currentMonitor() {
|
||
return core.invoke('plugin:window|current_monitor').then(mapMonitor);
|
||
}
|
||
/**
|
||
* Returns the primary monitor of the system.
|
||
* Returns `null` if it can't identify any monitor as a primary one.
|
||
* @example
|
||
* ```typescript
|
||
* import { primaryMonitor } from '@tauri-apps/api/window';
|
||
* const monitor = await primaryMonitor();
|
||
* ```
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
async function primaryMonitor() {
|
||
return core.invoke('plugin:window|primary_monitor').then(mapMonitor);
|
||
}
|
||
/**
|
||
* Returns the monitor that contains the given point. Returns `null` if can't find any.
|
||
* @example
|
||
* ```typescript
|
||
* import { monitorFromPoint } from '@tauri-apps/api/window';
|
||
* const monitor = await monitorFromPoint(100.0, 200.0);
|
||
* ```
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
async function monitorFromPoint(x, y) {
|
||
return core.invoke('plugin:window|monitor_from_point', {
|
||
x,
|
||
y
|
||
}).then(mapMonitor);
|
||
}
|
||
/**
|
||
* Returns the list of all the monitors available on the system.
|
||
* @example
|
||
* ```typescript
|
||
* import { availableMonitors } from '@tauri-apps/api/window';
|
||
* const monitors = await availableMonitors();
|
||
* ```
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
async function availableMonitors() {
|
||
return core.invoke('plugin:window|available_monitors').then((ms) => ms.map(mapMonitor));
|
||
}
|
||
/**
|
||
* Get the cursor position relative to the top-left hand corner of the desktop.
|
||
*
|
||
* Note that the top-left hand corner of the desktop is not necessarily the same as the screen.
|
||
* If the user uses a desktop with multiple monitors,
|
||
* the top-left hand corner of the desktop is the top-left hand corner of the main monitor on Windows and macOS
|
||
* or the top-left of the leftmost monitor on X11.
|
||
*
|
||
* The coordinates can be negative if the top-left hand corner of the window is outside of the visible screen region.
|
||
*/
|
||
async function cursorPosition() {
|
||
return core.invoke('plugin:window|cursor_position').then((v) => new dpi.PhysicalPosition(v));
|
||
}
|
||
|
||
exports.LogicalPosition = dpi.LogicalPosition;
|
||
exports.LogicalSize = dpi.LogicalSize;
|
||
exports.PhysicalPosition = dpi.PhysicalPosition;
|
||
exports.PhysicalSize = dpi.PhysicalSize;
|
||
exports.CloseRequestedEvent = CloseRequestedEvent;
|
||
exports.Window = Window;
|
||
exports.availableMonitors = availableMonitors;
|
||
exports.currentMonitor = currentMonitor;
|
||
exports.cursorPosition = cursorPosition;
|
||
exports.getAllWindows = getAllWindows;
|
||
exports.getCurrentWindow = getCurrentWindow;
|
||
exports.monitorFromPoint = monitorFromPoint;
|
||
exports.primaryMonitor = primaryMonitor;
|