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>
1804 lines
62 KiB
TypeScript
1804 lines
62 KiB
TypeScript
/**
|
||
* 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
|
||
*/
|
||
import { LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize, Position, Size } from './dpi';
|
||
import type { Event, EventName, EventCallback, UnlistenFn } from './event';
|
||
import { type EventTarget } from './event';
|
||
import { WebviewWindow } from './webviewWindow';
|
||
import type { DragDropEvent } from './webview';
|
||
import { Image } 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 monitor's work area. */
|
||
workArea: {
|
||
position: PhysicalPosition;
|
||
size: PhysicalSize;
|
||
};
|
||
/** 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
|
||
*/
|
||
declare 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 = 2
|
||
}
|
||
declare class CloseRequestedEvent {
|
||
/** Event name */
|
||
event: EventName;
|
||
/** Event identifier used to unlisten */
|
||
id: number;
|
||
private _preventDefault;
|
||
constructor(event: Event<unknown>);
|
||
preventDefault(): void;
|
||
isPreventDefault(): boolean;
|
||
}
|
||
export type CursorIcon = 'default' | 'crosshair' | 'hand' | 'arrow' | 'move' | 'text' | 'wait' | 'help' | 'progress' | 'notAllowed' | 'contextMenu' | 'cell' | 'verticalText' | 'alias' | 'copy' | 'noDrop' | 'grab' | 'grabbing' | 'allScroll' | 'zoomIn' | 'zoomOut' | 'eResize' | 'nResize' | 'neResize' | 'nwResize' | 'sResize' | 'seResize' | 'swResize' | 'wResize' | 'ewResize' | 'nsResize' | 'neswResize' | 'nwseResize' | 'colResize' | 'rowResize';
|
||
export declare 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 WindowSizeConstraints {
|
||
minWidth?: number;
|
||
minHeight?: number;
|
||
maxWidth?: number;
|
||
maxHeight?: number;
|
||
}
|
||
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
|
||
*/
|
||
declare function getCurrentWindow(): Window;
|
||
/**
|
||
* Gets a list of instances of `Window` for all available windows.
|
||
*
|
||
* @since 1.0.0
|
||
*/
|
||
declare function getAllWindows(): Promise<Window[]>;
|
||
/** @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
|
||
*/
|
||
declare 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. */
|
||
listeners: Record<string, Array<EventCallback<any>>>;
|
||
/**
|
||
* 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);
|
||
/**
|
||
* 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): Promise<Window | null>;
|
||
/**
|
||
* Get an instance of `Window` for the current window.
|
||
*/
|
||
static getCurrent(): Window;
|
||
/**
|
||
* Gets a list of instances of `Window` for all available windows.
|
||
*/
|
||
static getAll(): Promise<Window[]>;
|
||
/**
|
||
* 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 getFocusedWindow(): Promise<Window | 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.
|
||
*/
|
||
listen<T>(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
once<T>(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
emit<T>(event: string, payload?: T): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
emitTo<T>(target: string | EventTarget, event: string, payload?: T): Promise<void>;
|
||
/** @ignore */
|
||
_handleTauriEvent<T>(event: string, handler: EventCallback<T>): boolean;
|
||
/**
|
||
* 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.
|
||
*/
|
||
scaleFactor(): Promise<number>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
innerPosition(): Promise<PhysicalPosition>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
outerPosition(): Promise<PhysicalPosition>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
innerSize(): Promise<PhysicalSize>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
outerSize(): Promise<PhysicalSize>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isFullscreen(): Promise<boolean>;
|
||
/**
|
||
* Gets the window's current minimized state.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const minimized = await getCurrentWindow().isMinimized();
|
||
* ```
|
||
*/
|
||
isMinimized(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isMaximized(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isFocused(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isDecorated(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isResizable(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isMaximizable(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isMinimizable(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isClosable(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isVisible(): Promise<boolean>;
|
||
/**
|
||
* Gets the window's current title.
|
||
* @example
|
||
* ```typescript
|
||
* import { getCurrentWindow } from '@tauri-apps/api/window';
|
||
* const title = await getCurrentWindow().title();
|
||
* ```
|
||
*/
|
||
title(): Promise<string>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
theme(): Promise<Theme | null>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
isAlwaysOnTop(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
center(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
requestUserAttention(requestType: UserAttentionType | null): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setResizable(resizable: boolean): Promise<void>;
|
||
/**
|
||
* 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
|
||
*/
|
||
setEnabled(enabled: boolean): Promise<void>;
|
||
/**
|
||
* 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
|
||
*/
|
||
isEnabled(): Promise<boolean>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setMaximizable(maximizable: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setMinimizable(minimizable: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setClosable(closable: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setTitle(title: string): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
maximize(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
unmaximize(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
toggleMaximize(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
minimize(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
unminimize(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
show(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
hide(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
close(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
destroy(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setDecorations(decorations: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setShadow(enable: boolean): Promise<void>;
|
||
/**
|
||
* Set window effects.
|
||
*/
|
||
setEffects(effects: Effects): Promise<void>;
|
||
/**
|
||
* Clear any applied effects if possible.
|
||
*/
|
||
clearEffects(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setAlwaysOnBottom(alwaysOnBottom: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setContentProtected(protected_: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setSize(size: LogicalSize | PhysicalSize | Size): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setMinSize(size: LogicalSize | PhysicalSize | Size | null | undefined): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setMaxSize(size: LogicalSize | PhysicalSize | Size | null | undefined): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setSizeConstraints(constraints: WindowSizeConstraints | null | undefined): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setPosition(position: LogicalPosition | PhysicalPosition | Position): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setFullscreen(fullscreen: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setSimpleFullscreen(fullscreen: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setFocus(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setFocusable(focusable: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setIcon(icon: string | Image | Uint8Array | ArrayBuffer | number[]): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setSkipTaskbar(skip: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setCursorGrab(grab: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setCursorVisible(visible: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setCursorIcon(icon: CursorIcon): Promise<void>;
|
||
/**
|
||
* 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
|
||
*/
|
||
setBackgroundColor(color: Color): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setCursorPosition(position: LogicalPosition | PhysicalPosition | Position): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setIgnoreCursorEvents(ignore: boolean): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
startDragging(): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
startResizeDragging(direction: ResizeDirection): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setBadgeCount(count?: number): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setBadgeLabel(label?: string): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setOverlayIcon(icon?: string | Image | Uint8Array | ArrayBuffer | number[]): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
setProgressBar(state: ProgressBarState): Promise<void>;
|
||
/**
|
||
* Sets whether the window should be visible on all workspaces or virtual desktops.
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **Windows / iOS / Android:** Unsupported.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
setVisibleOnAllWorkspaces(visible: boolean): Promise<void>;
|
||
/**
|
||
* Sets the title bar style. **macOS only**.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
setTitleBarStyle(style: TitleBarStyle): Promise<void>;
|
||
/**
|
||
* 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
|
||
*/
|
||
setTheme(theme?: Theme | null): Promise<void>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onResized(handler: EventCallback<PhysicalSize>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onMoved(handler: EventCallback<PhysicalPosition>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onCloseRequested(handler: (event: CloseRequestedEvent) => void | Promise<void>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onDragDropEvent(handler: EventCallback<DragDropEvent>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onFocusChanged(handler: EventCallback<boolean>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onScaleChanged(handler: EventCallback<ScaleFactorChanged>): Promise<UnlistenFn>;
|
||
/**
|
||
* 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.
|
||
*/
|
||
onThemeChanged(handler: EventCallback<Theme>): Promise<UnlistenFn>;
|
||
}
|
||
/**
|
||
* An RGBA color. Each value has minimum of 0 and maximum of 255.
|
||
*
|
||
* It can be either a string `#ffffff`, an array of 3 or 4 elements or an object.
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
type Color = [number, number, number] | [number, number, number, number] | {
|
||
red: number;
|
||
green: number;
|
||
blue: number;
|
||
alpha: number;
|
||
} | string;
|
||
/**
|
||
* Background throttling policy
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
declare enum BackgroundThrottlingPolicy {
|
||
Disabled = "disabled",
|
||
Throttle = "throttle",
|
||
Suspend = "suspend"
|
||
}
|
||
/**
|
||
* 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
|
||
*/
|
||
declare enum ScrollBarStyle {
|
||
/**
|
||
* The default scrollbar style for the webview.
|
||
*/
|
||
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
|
||
*/
|
||
FluentOverlay = "fluentOverlay"
|
||
}
|
||
/**
|
||
* Platform-specific window effects
|
||
*
|
||
* @since 2.0.0
|
||
*/
|
||
declare 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 preference **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
|
||
*/
|
||
declare 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;
|
||
}
|
||
/**
|
||
* Minimum margin to work area
|
||
*/
|
||
interface PreventOverflowMargin {
|
||
width: number;
|
||
height: number;
|
||
}
|
||
/**
|
||
* 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 in logical pixels. Only applies if `y` is also set. */
|
||
x?: number;
|
||
/** The initial horizontal position in logical pixels. Only applies if `x` is also set. */
|
||
y?: number;
|
||
/** The initial width in logical pixels. */
|
||
width?: number;
|
||
/** The initial height in logical pixels. */
|
||
height?: number;
|
||
/** The minimum width in logical pixels. Only applies if `minHeight` is also set. */
|
||
minWidth?: number;
|
||
/** The minimum height in logical pixels. Only applies if `minWidth` is also set. */
|
||
minHeight?: number;
|
||
/** The maximum width in logical pixels. Only applies if `maxHeight` is also set. */
|
||
maxWidth?: number;
|
||
/** The maximum height in logical pixels. Only applies if `maxWidth` is also set. */
|
||
maxHeight?: number;
|
||
/**
|
||
* Prevent the window from overflowing the working area (e.g. monitor size - taskbar size)
|
||
* on creation, which means the window size will be limited to `monitor size - taskbar size`
|
||
*
|
||
* Can either be set to `true` or to a {@link PreventOverflowMargin} object to set an additional margin
|
||
* that should be considered to determine the working area
|
||
* (in this case the window size will be limited to `monitor size - taskbar size - margin`)
|
||
*
|
||
* **NOTE**: The overflow check is only performed on window creation, resizes can still overflow
|
||
*
|
||
* #### Platform-specific
|
||
*
|
||
* - **iOS / Android:** Unsupported.
|
||
*/
|
||
preventOverflow?: boolean | PreventOverflowMargin;
|
||
/** 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 can be focused or not. */
|
||
focusable?: 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 undecorated 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;
|
||
/**
|
||
* The position of the window controls on macOS.
|
||
*
|
||
* Requires `titleBarStyle: 'overlay'` and `decorations: true`.
|
||
*
|
||
* @since 2.4.0
|
||
*/
|
||
trafficLightPosition?: LogicalPosition;
|
||
/**
|
||
* 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 <https://docs.gtk.org/gtk3/method.Window.set_transient_for.html>
|
||
* - **macOS**: This adds the window as a child of parent, see <https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc>
|
||
*/
|
||
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;
|
||
/**
|
||
* Window effects.
|
||
*
|
||
* Requires the window to be transparent.
|
||
*
|
||
* #### Platform-specific:
|
||
*
|
||
* - **Windows**: If using decorations or shadows, you may want to try this workaround <https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891>
|
||
* - **Linux**: Unsupported
|
||
*/
|
||
windowEffects?: Effects;
|
||
/**
|
||
* Set the window background color.
|
||
*
|
||
* #### Platform-specific:
|
||
*
|
||
* - **Android / iOS:** Unsupported.
|
||
* - **Windows**: alpha channel is ignored.
|
||
*
|
||
* @since 2.1.0
|
||
*/
|
||
backgroundColor?: Color;
|
||
/** Change the default background throttling behaviour.
|
||
*
|
||
* ## Platform-specific
|
||
*
|
||
* - **Linux / Windows / Android**: Unsupported. Workarounds like a pending WebLock transaction might suffice.
|
||
* - **iOS**: Supported since version 17.0+.
|
||
* - **macOS**: Supported since version 14.0+.
|
||
*
|
||
* see https://github.com/tauri-apps/tauri/issues/5250#issuecomment-2569380578
|
||
*
|
||
* @since 2.3.0
|
||
*/
|
||
backgroundThrottling?: BackgroundThrottlingPolicy;
|
||
/**
|
||
* Whether we should disable JavaScript code execution on the webview or not.
|
||
*/
|
||
javascriptDisabled?: boolean;
|
||
/**
|
||
* on macOS and iOS there is a link preview on long pressing links, this is enabled by default.
|
||
* see https://docs.rs/objc2-web-kit/latest/objc2_web_kit/struct.WKWebView.html#method.allowsLinkPreview
|
||
*/
|
||
allowLinkPreview?: boolean;
|
||
/**
|
||
* Allows disabling the input accessory view on iOS.
|
||
*
|
||
* The accessory view is the view that appears above the keyboard when a text input element is focused.
|
||
* It usually displays a view with "Done", "Next" buttons.
|
||
*/
|
||
disableInputAccessoryView?: boolean;
|
||
/**
|
||
* Specifies the native scrollbar style to use with the webview.
|
||
* CSS styles that modify the scrollbar are applied on top of the native appearance configured here.
|
||
*
|
||
* Defaults to `default`, which is the browser default.
|
||
*
|
||
* ## Platform-specific
|
||
*
|
||
* - **Windows**:
|
||
* - `fluentOverlay` requires WebView2 Runtime version 125.0.2535.41 or higher, and does nothing
|
||
* on older versions.
|
||
* - This option must be given the same value for all webviews.
|
||
* - **Linux / Android / iOS / macOS**: Unsupported. Only supports `Default` and performs no operation.
|
||
*/
|
||
scrollBarStyle?: ScrollBarStyle;
|
||
}
|
||
/**
|
||
* 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
|
||
*/
|
||
declare function currentMonitor(): Promise<Monitor | null>;
|
||
/**
|
||
* 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
|
||
*/
|
||
declare function primaryMonitor(): Promise<Monitor | null>;
|
||
/**
|
||
* 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
|
||
*/
|
||
declare function monitorFromPoint(x: number, y: number): Promise<Monitor | null>;
|
||
/**
|
||
* 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
|
||
*/
|
||
declare function availableMonitors(): Promise<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.
|
||
*/
|
||
declare function cursorPosition(): Promise<PhysicalPosition>;
|
||
export { Window, CloseRequestedEvent, getCurrentWindow, getAllWindows, LogicalSize, PhysicalSize, LogicalPosition, PhysicalPosition, UserAttentionType, Effect, EffectState, currentMonitor, monitorFromPoint, primaryMonitor, availableMonitors, cursorPosition };
|
||
export type { Effects, Theme, TitleBarStyle, ScaleFactorChanged, WindowOptions, Color, BackgroundThrottlingPolicy, DragDropEvent, ScrollBarStyle };
|