// 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 { getCurrent } from "@tauri-apps/api/window"; * getCurrent().listen("my-window-event", ({ event, payload }) => { }); * ``` * * @module */ import { LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize } from './dpi' import type { Event, EventName, EventCallback, UnlistenFn } from './event' import { TauriEvent, // imported for documentation purposes // eslint-disable-next-line type EventTarget, emit, emitTo, listen, once } from './event' import { invoke } from './core' import { WebviewWindow } from './webviewWindow' import type { DragDropEvent, DragDropPayload } from './webview' import { Image, transformImage } from './image' /** * Allows you to retrieve information about a given monitor. * * @since 1.0.0 */ export interface Monitor { /** Human-readable name of the monitor */ name: string | null /** The monitor's resolution. */ size: PhysicalSize /** the Top-left corner position of the monitor relative to the larger full screen area. */ position: PhysicalPosition /** The scale factor that can be used to map physical pixels to logical pixels. */ scaleFactor: number } type Theme = 'light' | 'dark' type TitleBarStyle = 'visible' | 'transparent' | 'overlay' type ResizeDirection = | 'East' | 'North' | 'NorthEast' | 'NorthWest' | 'South' | 'SouthEast' | 'SouthWest' | 'West' /** * The payload for the `scaleChange` event. * * @since 1.0.2 */ interface ScaleFactorChanged { /** The new window scale factor. */ scaleFactor: number /** The new window size */ size: PhysicalSize } /** * Attention type to request on a window. * * @since 1.0.0 */ enum 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. */ Critical = 1, /** * #### Platform-specific * - **macOS:** Bounces the dock icon once. * - **Windows:** Flashes the taskbar button until the application is in focus. */ Informational } class CloseRequestedEvent { /** Event name */ event: EventName /** Event identifier used to unlisten */ id: number private _preventDefault = false constructor(event: Event) { this.event = event.event this.id = event.id } preventDefault(): void { this._preventDefault = true } isPreventDefault(): boolean { return this._preventDefault } } export type CursorIcon = | 'default' | 'crosshair' | 'hand' | 'arrow' | 'move' | 'text' | 'wait' | 'help' | 'progress' // something cannot be done | 'notAllowed' | 'contextMenu' | 'cell' | 'verticalText' | 'alias' | 'copy' | 'noDrop' // something can be grabbed | 'grab' /// something is grabbed | 'grabbing' | 'allScroll' | 'zoomIn' | 'zoomOut' // edge is to be moved | 'eResize' | 'nResize' | 'neResize' | 'nwResize' | 'sResize' | 'seResize' | 'swResize' | 'wResize' | 'ewResize' | 'nsResize' | 'neswResize' | 'nwseResize' | 'colResize' | 'rowResize' export enum ProgressBarStatus { /** * Hide progress bar. */ None = 'none', /** * Normal state. */ Normal = 'normal', /** * Indeterminate state. **Treated as Normal on Linux and macOS** */ Indeterminate = 'indeterminate', /** * Paused state. **Treated as Normal on Linux** */ Paused = 'paused', /** * Error state. **Treated as Normal on linux** */ Error = 'error' } export interface ProgressBarState { /** * The progress bar status. */ status?: ProgressBarStatus /** * The progress bar progress. This can be a value ranging from `0` to `100` */ progress?: number } /** * Get an instance of `Window` for the current window. * * @since 1.0.0 */ function getCurrent(): Window { 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 */ function getAll(): Window[] { return window.__TAURI_INTERNALS__.metadata.windows.map( (w) => new Window(w.label, { // @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'] /** @ignore */ export type WindowLabel = string /** * 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 { /** The window label. It is a unique identifier for the window, can be used to reference it later. */ label: WindowLabel /** Local event listeners. */ // eslint-disable-next-line @typescript-eslint/no-explicit-any listeners: Record>> /** * 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: WindowLabel, options: WindowOptions = {}) { 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?.skip) { invoke('plugin:window|create', { options: { ...options, parent: typeof options.parent === 'string' ? options.parent : options.parent?.label, label } }) .then(async () => this.emit('tauri://created')) .catch(async (e: string) => 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 getByLabel(label: string): Window | null { return getAll().find((w) => w.label === label) ?? null } /** * Get an instance of `Window` for the current window. */ static getCurrent(): Window { return getCurrent() } /** * Gets a list of instances of `Window` for all available windows. */ static getAll(): Window[] { return getAll() } /** * 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(): Promise { for (const w of getAll()) { if (await w.isFocused()) { return w } } return null } /** * Listen to an emitted event on this window. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const unlisten = await getCurrent().listen('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: EventName, handler: EventCallback ): Promise { if (this._handleTauriEvent(event, handler)) { return Promise.resolve(() => { // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, security/detect-object-injection const listeners = this.listeners[event] listeners.splice(listeners.indexOf(handler), 1) }) } return listen(event, handler, { target: { kind: 'Window', label: this.label } }) } /** * Listen to an emitted event on this window only once. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const unlisten = await getCurrent().once('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: string, handler: EventCallback): Promise { if (this._handleTauriEvent(event, handler)) { return Promise.resolve(() => { // eslint-disable-next-line security/detect-object-injection const listeners = this.listeners[event] listeners.splice(listeners.indexOf(handler), 1) }) } return once(event, handler, { target: { kind: 'Window', label: this.label } }) } /** * Emits an event to all {@link EventTarget|targets}. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().emit('window-loaded', { loggedIn: true, token: 'authToken' }); * ``` * * @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`. * @param payload Event payload. */ async emit(event: string, payload?: unknown): Promise { if (localTauriEvents.includes(event)) { // eslint-disable-next-line for (const handler of this.listeners[event] || []) { handler({ event, id: -1, payload }) } return Promise.resolve() } return emit(event, payload) } /** * Emits an event to all {@link EventTarget|targets} matching the given target. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: string | EventTarget, event: string, payload?: unknown ): Promise { if (localTauriEvents.includes(event)) { // eslint-disable-next-line for (const handler of this.listeners[event] || []) { handler({ event, id: -1, payload }) } return Promise.resolve() } return emitTo(target, event, payload) } /** @ignore */ _handleTauriEvent(event: string, handler: EventCallback): boolean { 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 { getCurrent } from '@tauri-apps/api/window'; * const factor = await getCurrent().scaleFactor(); * ``` * * @returns The window's monitor scale factor. */ async scaleFactor(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * const position = await getCurrent().innerPosition(); * ``` * * @returns The window's inner position. */ async innerPosition(): Promise { return invoke<{ x: number; y: number }>('plugin:window|inner_position', { label: this.label }).then(({ x, y }) => new PhysicalPosition(x, y)) } /** * The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const position = await getCurrent().outerPosition(); * ``` * * @returns The window's outer position. */ async outerPosition(): Promise { return invoke<{ x: number; y: number }>('plugin:window|outer_position', { label: this.label }).then(({ x, y }) => new PhysicalPosition(x, y)) } /** * 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 { getCurrent } from '@tauri-apps/api/window'; * const size = await getCurrent().innerSize(); * ``` * * @returns The window's inner size. */ async innerSize(): Promise { return invoke<{ width: number; height: number }>( 'plugin:window|inner_size', { label: this.label } ).then(({ width, height }) => new PhysicalSize(width, height)) } /** * 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 { getCurrent } from '@tauri-apps/api/window'; * const size = await getCurrent().outerSize(); * ``` * * @returns The window's outer size. */ async outerSize(): Promise { return invoke<{ width: number; height: number }>( 'plugin:window|outer_size', { label: this.label } ).then(({ width, height }) => new PhysicalSize(width, height)) } /** * Gets the window's current fullscreen state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const fullscreen = await getCurrent().isFullscreen(); * ``` * * @returns Whether the window is in fullscreen mode or not. */ async isFullscreen(): Promise { return invoke('plugin:window|is_fullscreen', { label: this.label }) } /** * Gets the window's current minimized state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const minimized = await getCurrent().isMinimized(); * ``` */ async isMinimized(): Promise { return invoke('plugin:window|is_minimized', { label: this.label }) } /** * Gets the window's current maximized state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const maximized = await getCurrent().isMaximized(); * ``` * * @returns Whether the window is maximized or not. */ async isMaximized(): Promise { return invoke('plugin:window|is_maximized', { label: this.label }) } /** * Gets the window's current focus state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const focused = await getCurrent().isFocused(); * ``` * * @returns Whether the window is focused or not. */ async isFocused(): Promise { return invoke('plugin:window|is_focused', { label: this.label }) } /** * Gets the window's current decorated state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const decorated = await getCurrent().isDecorated(); * ``` * * @returns Whether the window is decorated or not. */ async isDecorated(): Promise { return invoke('plugin:window|is_decorated', { label: this.label }) } /** * Gets the window's current resizable state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const resizable = await getCurrent().isResizable(); * ``` * * @returns Whether the window is resizable or not. */ async isResizable(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * const maximizable = await getCurrent().isMaximizable(); * ``` * * @returns Whether the window's native maximize button is enabled or not. */ async isMaximizable(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * const minimizable = await getCurrent().isMinimizable(); * ``` * * @returns Whether the window's native minimize button is enabled or not. */ async isMinimizable(): Promise { return invoke('plugin:window|is_minimizable', { label: this.label }) } /** * Gets the window's native close button state. * * #### Platform-specific * * - **iOS / Android:** Unsupported. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const closable = await getCurrent().isClosable(); * ``` * * @returns Whether the window's native close button is enabled or not. */ async isClosable(): Promise { return invoke('plugin:window|is_closable', { label: this.label }) } /** * Gets the window's current visible state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const visible = await getCurrent().isVisible(); * ``` * * @returns Whether the window is visible or not. */ async isVisible(): Promise { return invoke('plugin:window|is_visible', { label: this.label }) } /** * Gets the window's current title. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * const title = await getCurrent().title(); * ``` */ async title(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * const theme = await getCurrent().theme(); * ``` * * @returns The window theme. */ async theme(): Promise { return invoke('plugin:window|theme', { label: this.label }) } // Setters /** * Centers the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().center(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async center(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().requestUserAttention(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async requestUserAttention( requestType: UserAttentionType | null ): Promise { let requestType_ = null if (requestType) { if (requestType === UserAttentionType.Critical) { requestType_ = { type: 'Critical' } } else { requestType_ = { type: 'Informational' } } } return invoke('plugin:window|request_user_attention', { label: this.label, value: requestType_ }) } /** * Updates the window resizable flag. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setResizable(false); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setResizable(resizable: boolean): Promise { return invoke('plugin:window|set_resizable', { label: this.label, value: resizable }) } /** * 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setMaximizable(false); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setMaximizable(maximizable: boolean): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setMinimizable(false); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setMinimizable(minimizable: boolean): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setClosable(false); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setClosable(closable: boolean): Promise { return invoke('plugin:window|set_closable', { label: this.label, value: closable }) } /** * Sets the window title. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setTitle('Tauri'); * ``` * * @param title The new title * @returns A promise indicating the success or failure of the operation. */ async setTitle(title: string): Promise { return invoke('plugin:window|set_title', { label: this.label, value: title }) } /** * Maximizes the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().maximize(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async maximize(): Promise { return invoke('plugin:window|maximize', { label: this.label }) } /** * Unmaximizes the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().unmaximize(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async unmaximize(): Promise { return invoke('plugin:window|unmaximize', { label: this.label }) } /** * Toggles the window maximized state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().toggleMaximize(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async toggleMaximize(): Promise { return invoke('plugin:window|toggle_maximize', { label: this.label }) } /** * Minimizes the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().minimize(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async minimize(): Promise { return invoke('plugin:window|minimize', { label: this.label }) } /** * Unminimizes the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().unminimize(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async unminimize(): Promise { return invoke('plugin:window|unminimize', { label: this.label }) } /** * Sets the window visibility to true. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().show(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async show(): Promise { return invoke('plugin:window|show', { label: this.label }) } /** * Sets the window visibility to false. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().hide(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async hide(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().close(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async close(): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().destroy(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async destroy(): Promise { return invoke('plugin:window|destroy', { label: this.label }) } /** * Whether the window should have borders and bars. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return 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 ndecorated window have a 1px white border, * and on Windows 11, it will have a rounded corners. * - **Linux:** Unsupported. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setShadow(false); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setShadow(enable: boolean): Promise { return invoke('plugin:window|set_shadow', { label: this.label, value: enable }) } /** * Set window effects. */ async setEffects(effects: Effects): Promise { return invoke('plugin:window|set_effects', { label: this.label, value: effects }) } /** * Clear any applied effects if possible. */ async clearEffects(): Promise { return invoke('plugin:window|set_effects', { label: this.label, value: null }) } /** * Whether the window should always be on top of other windows. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return invoke('plugin:window|set_always_on_top', { label: this.label, value: alwaysOnTop }) } /** * Whether the window should always be below other windows. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setContentProtected(true); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setContentProtected(protected_: boolean): Promise { return invoke('plugin:window|set_content_protected', { label: this.label, value: protected_ }) } /** * Resizes the window with a new inner size. * @example * ```typescript * import { getCurrent, LogicalSize } from '@tauri-apps/api/window'; * await getCurrent().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: LogicalSize | PhysicalSize): Promise { if (!size || (size.type !== 'Logical' && size.type !== 'Physical')) { throw new Error( 'the `size` argument must be either a LogicalSize or a PhysicalSize instance' ) } const value = {} as Record value[`${size.type}`] = { width: size.width, height: size.height } return invoke('plugin:window|set_size', { label: this.label, value }) } /** * Sets the window minimum inner size. If the `size` argument is not provided, the constraint is unset. * @example * ```typescript * import { getCurrent, PhysicalSize } from '@tauri-apps/api/window'; * await getCurrent().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: LogicalSize | PhysicalSize | null | undefined ): Promise { if (size && size.type !== 'Logical' && size.type !== 'Physical') { throw new Error( 'the `size` argument must be either a LogicalSize or a PhysicalSize instance' ) } let value = null as Record | null if (size) { value = {} value[`${size.type}`] = { width: size.width, height: size.height } } return invoke('plugin:window|set_min_size', { label: this.label, value }) } /** * Sets the window maximum inner size. If the `size` argument is undefined, the constraint is unset. * @example * ```typescript * import { getCurrent, LogicalSize } from '@tauri-apps/api/window'; * await getCurrent().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: LogicalSize | PhysicalSize | null | undefined ): Promise { if (size && size.type !== 'Logical' && size.type !== 'Physical') { throw new Error( 'the `size` argument must be either a LogicalSize or a PhysicalSize instance' ) } let value = null as Record | null if (size) { value = {} value[`${size.type}`] = { width: size.width, height: size.height } } return invoke('plugin:window|set_max_size', { label: this.label, value }) } /** * Sets the window outer position. * @example * ```typescript * import { getCurrent, LogicalPosition } from '@tauri-apps/api/window'; * await getCurrent().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: LogicalPosition | PhysicalPosition ): Promise { if ( !position || (position.type !== 'Logical' && position.type !== 'Physical') ) { throw new Error( 'the `position` argument must be either a LogicalPosition or a PhysicalPosition instance' ) } const value = {} as Record value[`${position.type}`] = { x: position.x, y: position.y } return invoke('plugin:window|set_position', { label: this.label, value }) } /** * Sets the window fullscreen state. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return invoke('plugin:window|set_fullscreen', { label: this.label, value: fullscreen }) } /** * Bring the window to front and focus. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setFocus(); * ``` * * @returns A promise indicating the success or failure of the operation. */ async setFocus(): Promise { return invoke('plugin:window|set_focus', { label: this.label }) } /** * Sets the window icon. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setIcon('/tauri/awesome.png'); * ``` * * Note that you 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: string | Image | Uint8Array | ArrayBuffer | number[] ): Promise { return invoke('plugin:window|set_icon', { label: this.label, value: transformImage(icon) }) } /** * Whether the window icon should be hidden from the taskbar or not. * * #### Platform-specific * * - **macOS:** Unsupported. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return 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 { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return invoke('plugin:window|set_cursor_visible', { label: this.label, value: visible }) } /** * Modifies the cursor icon of the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().setCursorIcon('help'); * ``` * * @param icon The new cursor icon. * @returns A promise indicating the success or failure of the operation. */ async setCursorIcon(icon: CursorIcon): Promise { return invoke('plugin:window|set_cursor_icon', { label: this.label, value: icon }) } /** * Changes the position of the cursor in window coordinates. * @example * ```typescript * import { getCurrent, LogicalPosition } from '@tauri-apps/api/window'; * await getCurrent().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: LogicalPosition | PhysicalPosition ): Promise { if ( !position || (position.type !== 'Logical' && position.type !== 'Physical') ) { throw new Error( 'the `position` argument must be either a LogicalPosition or a PhysicalPosition instance' ) } const value = {} as Record value[`${position.type}`] = { x: position.x, y: position.y } return invoke('plugin:window|set_cursor_position', { label: this.label, value }) } /** * Changes the cursor events behavior. * * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().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: boolean): Promise { return invoke('plugin:window|set_ignore_cursor_events', { label: this.label, value: ignore }) } /** * Starts dragging the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().startDragging(); * ``` * * @return A promise indicating the success or failure of the operation. */ async startDragging(): Promise { return invoke('plugin:window|start_dragging', { label: this.label }) } /** * Starts resize-dragging the window. * @example * ```typescript * import { getCurrent } from '@tauri-apps/api/window'; * await getCurrent().startResizeDragging(); * ``` * * @return A promise indicating the success or failure of the operation. */ async startResizeDragging(direction: ResizeDirection): Promise { return invoke('plugin:window|start_resize_dragging', { label: this.label, value: direction }) } /** * 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 { getCurrent, ProgressBarStatus } from '@tauri-apps/api/window'; * await getCurrent().setProgressBar({ * status: ProgressBarStatus.Normal, * progress: 50, * }); * ``` * * @return A promise indicating the success or failure of the operation. */ async setProgressBar(state: ProgressBarState): Promise { return 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: boolean): Promise { return invoke('plugin:window|set_visible_on_all_workspaces', { label: this.label, value: visible }) } // Listeners /** * Listen to window resize. * * @example * ```typescript * import { getCurrent } from "@tauri-apps/api/window"; * const unlisten = await getCurrent().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: EventCallback): Promise { return this.listen(TauriEvent.WINDOW_RESIZED, (e) => { e.payload = mapPhysicalSize(e.payload) handler(e) }) } /** * Listen to window move. * * @example * ```typescript * import { getCurrent } from "@tauri-apps/api/window"; * const unlisten = await getCurrent().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: EventCallback): Promise { return this.listen(TauriEvent.WINDOW_MOVED, (e) => { e.payload = mapPhysicalPosition(e.payload) handler(e) }) } /** * Listen to window close requested. Emitted when the user requests to closes the window. * * @example * ```typescript * import { getCurrent } from "@tauri-apps/api/window"; * import { confirm } from '@tauri-apps/api/dialog'; * const unlisten = await getCurrent().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. */ /* eslint-disable @typescript-eslint/promise-function-async */ async onCloseRequested( handler: (event: CloseRequestedEvent) => void | Promise ): Promise { return this.listen(TauriEvent.WINDOW_CLOSE_REQUESTED, (event) => { const evt = new CloseRequestedEvent(event) void Promise.resolve(handler(evt)).then(() => { if (!evt.isPreventDefault()) { return this.destroy() } }) }) } /* eslint-enable */ /** * 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 { getCurrent } from "@tauri-apps/api/webview"; * const unlisten = await getCurrent().onDragDropEvent((event) => { * if (event.payload.type === 'hover') { * console.log('User hovering', event.payload.paths); * } 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: EventCallback ): Promise { const unlistenDrag = await this.listen( TauriEvent.DRAG, (event) => { handler({ ...event, payload: { type: 'dragged', paths: event.payload.paths, position: mapPhysicalPosition(event.payload.position) } }) } ) const unlistenDrop = await this.listen( TauriEvent.DROP, (event) => { handler({ ...event, payload: { type: 'dropped', paths: event.payload.paths, position: mapPhysicalPosition(event.payload.position) } }) } ) const unlistenDragOver = await this.listen( TauriEvent.DROP_OVER, (event) => { handler({ ...event, payload: { type: 'dragOver', position: mapPhysicalPosition(event.payload.position) } }) } ) const unlistenCancel = await this.listen( TauriEvent.DROP_CANCELLED, (event) => { handler({ ...event, payload: { type: 'cancelled' } }) } ) return () => { unlistenDrag() unlistenDrop() unlistenDragOver() unlistenCancel() } } /** * Listen to window focus change. * * @example * ```typescript * import { getCurrent } from "@tauri-apps/api/window"; * const unlisten = await getCurrent().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: EventCallback): Promise { const unlistenFocus = await this.listen( TauriEvent.WINDOW_FOCUS, (event) => { handler({ ...event, payload: true }) } ) const unlistenBlur = await this.listen( 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 { getCurrent } from "@tauri-apps/api/window"; * const unlisten = await getCurrent().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: EventCallback ): Promise { return this.listen( TauriEvent.WINDOW_SCALE_FACTOR_CHANGED, handler ) } /** * Listen to the system theme change. * * @example * ```typescript * import { getCurrent } from "@tauri-apps/api/window"; * const unlisten = await getCurrent().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: EventCallback): Promise { return this.listen(TauriEvent.WINDOW_THEME_CHANGED, handler) } } /** * an array RGBA colors. Each value has minimum of 0 and maximum of 255. * * @since 2.0.0 */ type Color = [number, number, number, number] /** * Platform-specific window effects * * @since 2.0.0 */ enum 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. */ AppearanceBased = 'appearanceBased', /** * **macOS 10.14-** * * @deprecated since macOS 10.14. Use a semantic material instead. */ Light = 'light', /** * **macOS 10.14-** * * @deprecated since macOS 10.14. Use a semantic material instead. */ Dark = 'dark', /** * **macOS 10.14-** * * @deprecated since macOS 10.14. Use a semantic material instead. */ MediumLight = 'mediumLight', /** * **macOS 10.14-** * * @deprecated since macOS 10.14. Use a semantic material instead. */ UltraDark = 'ultraDark', /** * **macOS 10.10+** */ Titlebar = 'titlebar', /** * **macOS 10.10+** */ Selection = 'selection', /** * **macOS 10.11+** */ Menu = 'menu', /** * **macOS 10.11+** */ Popover = 'popover', /** * **macOS 10.11+** */ Sidebar = 'sidebar', /** * **macOS 10.14+** */ HeaderView = 'headerView', /** * **macOS 10.14+** */ Sheet = 'sheet', /** * **macOS 10.14+** */ WindowBackground = 'windowBackground', /** * **macOS 10.14+** */ HudWindow = 'hudWindow', /** * **macOS 10.14+** */ FullScreenUI = 'fullScreenUI', /** * **macOS 10.14+** */ Tooltip = 'tooltip', /** * **macOS 10.14+** */ ContentBackground = 'contentBackground', /** * **macOS 10.14+** */ UnderWindowBackground = 'underWindowBackground', /** * **macOS 10.14+** */ UnderPageBackground = 'underPageBackground', /** * **Windows 11 Only** */ Mica = 'mica', /** * **Windows 7/10/11(22H1) Only** * * ## Notes * * This effect has bad performance when resizing/dragging the window on Windows 11 build 22621. */ 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. */ Acrylic = 'acrylic', /** * Tabbed effect that matches the system dark perefence **Windows 11 Only** */ Tabbed = 'tabbed', /** * Tabbed effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only** */ TabbedDark = 'tabbedDark', /** * Tabbed effect with light mode **Windows 11 Only** */ TabbedLight = 'tabbedLight' } /** * Window effect state **macOS only** * * @see https://developer.apple.com/documentation/appkit/nsvisualeffectview/state * * @since 2.0.0 */ enum EffectState { /** * Make window effect state follow the window's active state **macOS only** */ FollowsWindowActiveState = 'followsWindowActiveState', /** * Make window effect state always active **macOS only** */ Active = 'active', /** * Make window effect state always inactive **macOS only** */ Inactive = 'inactive' } /** The window effects configuration object * * @since 2.0.0 */ interface Effects { /** * List of Window effects to apply to the Window. * Conflicting effects will apply the first one and ignore the rest. */ effects: Effect[] /** * Window effect state **macOS Only** */ state?: EffectState /** * Window effect corner radius **macOS Only** */ radius?: number /** * Window effect color. Affects {@link Effect.Blur} and {@link Effect.Acrylic} only * on Windows 10 v1903+. Doesn't have any effect on Windows 7 or Windows 11. */ color?: Color } /** * Configuration for the window to create. * * @since 1.0.0 */ interface WindowOptions { /** Show window in the center of the screen.. */ center?: boolean /** The initial vertical position. Only applies if `y` is also set. */ x?: number /** The initial horizontal position. Only applies if `x` is also set. */ y?: number /** The initial width. */ width?: number /** The initial height. */ height?: number /** The minimum width. Only applies if `minHeight` is also set. */ minWidth?: number /** The minimum height. Only applies if `minWidth` is also set. */ minHeight?: number /** The maximum width. Only applies if `maxHeight` is also set. */ maxWidth?: number /** The maximum height. Only applies if `maxWidth` is also set. */ maxHeight?: number /** Whether the window is resizable or not. */ resizable?: boolean /** Window title. */ title?: string /** Whether the window is in fullscreen mode or not. */ fullscreen?: boolean /** Whether the window will be initially focused or not. */ focus?: boolean /** * Whether the window is transparent or not. * Note that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri.conf.json > app > macOSPrivateApi`. * WARNING: Using private APIs on `macOS` prevents your application from being accepted to the `App Store`. */ transparent?: boolean /** Whether the window should be maximized upon creation or not. */ maximized?: boolean /** Whether the window should be immediately visible upon creation or not. */ visible?: boolean /** Whether the window should have borders and bars or not. */ decorations?: boolean /** Whether the window should always be on top of other windows or not. */ alwaysOnTop?: boolean /** Whether the window should always be below other windows. */ alwaysOnBottom?: boolean /** Prevents the window contents from being captured by other apps. */ contentProtected?: boolean /** Whether or not the window icon should be added to the taskbar. */ skipTaskbar?: boolean /** * Whether or not the window has shadow. * * #### Platform-specific * * - **Windows:** * - `false` has no effect on decorated window, shadows are always ON. * - `true` will make ndecorated window have a 1px white border, * and on Windows 11, it will have a rounded corners. * - **Linux:** Unsupported. * * @since 2.0.0 */ shadow?: boolean /** * The initial window theme. Defaults to the system theme. * * Only implemented on Windows and macOS 10.14+. */ theme?: Theme /** * The style of the macOS title bar. */ titleBarStyle?: TitleBarStyle /** * If `true`, sets the window title to be hidden on macOS. */ hiddenTitle?: boolean /** * Defines the window [tabbing identifier](https://developer.apple.com/documentation/appkit/nswindow/1644704-tabbingidentifier) on macOS. * * Windows with the same tabbing identifier will be grouped together. * If the tabbing identifier is not set, automatic tabbing will be disabled. */ tabbingIdentifier?: string /** * Whether the window's native maximize button is enabled or not. Defaults to `true`. */ maximizable?: boolean /** * Whether the window's native minimize button is enabled or not. Defaults to `true`. */ minimizable?: boolean /** * Whether the window's native close button is enabled or not. Defaults to `true`. */ closable?: boolean /** * Sets a parent to the window to be created. Can be either a {@linkcode Window} or a label of the window. * * #### Platform-specific * * - **Windows**: This sets the passed parent as an owner window to the window to be created. * From [MSDN owned windows docs](https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#owned-windows): * - An owned window is always above its owner in the z-order. * - The system automatically destroys an owned window when its owner is destroyed. * - An owned window is hidden when its owner is minimized. * - **Linux**: This makes the new window transient for parent, see * - **macOS**: This adds the window as a child of parent, see */ parent?: Window | WebviewWindow | string /** Whether the window should be visible on all workspaces or virtual desktops. * * ## Platform-specific * * - **Windows / iOS / Android:** Unsupported. * * @since 2.0.0 */ visibleOnAllWorkspaces?: boolean } function mapMonitor(m: Monitor | null): Monitor | null { return m === null ? null : { name: m.name, scaleFactor: m.scaleFactor, position: mapPhysicalPosition(m.position), size: mapPhysicalSize(m.size) } } function mapPhysicalPosition(m: PhysicalPosition): PhysicalPosition { return new PhysicalPosition(m.x, m.y) } function mapPhysicalSize(m: PhysicalSize): PhysicalSize { return new PhysicalSize(m.width, m.height) } /** * 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 = currentMonitor(); * ``` * * @since 1.0.0 */ async function currentMonitor(): Promise { return 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 = primaryMonitor(); * ``` * * @since 1.0.0 */ async function primaryMonitor(): Promise { return 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 = monitorFromPoint(); * ``` * * @since 1.0.0 */ async function monitorFromPoint(x: number, y: number): Promise { return 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 = availableMonitors(); * ``` * * @since 1.0.0 */ async function availableMonitors(): Promise { return invoke('plugin:window|available_monitors').then( (ms) => ms.map(mapMonitor) as Monitor[] ) } /** * 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(): Promise { return invoke('plugin:window|cursor_position').then( mapPhysicalPosition ) } export { Window, CloseRequestedEvent, getCurrent, getAll, LogicalSize, PhysicalSize, LogicalPosition, PhysicalPosition, UserAttentionType, Effect, EffectState, currentMonitor, monitorFromPoint, primaryMonitor, availableMonitors, cursorPosition } export type { Effects, Theme, TitleBarStyle, ScaleFactorChanged, WindowOptions, Color, DragDropEvent, DragDropPayload }