window

Provides APIs to create windows, communicate with other windows and manipulate the current window.

Window events

Events can be listened to using Window.listen:

import { getCurrentWindow } from "@tauri-apps/api/window";getCurrentWindow().listen("my-window-event", ({ event, payload }) => { });

References

Color

Re-exports Color

DragDropEvent

Re-exports DragDropEvent

LogicalPosition

Re-exports LogicalPosition

LogicalSize

Re-exports LogicalSize

PhysicalPosition

Re-exports PhysicalPosition

PhysicalSize

Re-exports PhysicalSize

Enumerations

BackgroundThrottlingPolicy

Background throttling policy

Since

2.0.0

Enumeration Members

Disabled

Disabled: "disabled";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2133

Suspend

Suspend: "suspend";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2135

Throttle

Throttle: "throttle";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2134

Effect

Platform-specific window effects

Since

2.0.0

Enumeration Members

Acrylic

Acrylic: "acrylic";

Windows 10/11

Notes

This effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2272

AppearanceBased

AppearanceBased: "appearanceBased";

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.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2172

Blur

Blur: "blur";

Windows 7/10/11(22H1) Only

Notes

This effect has bad performance when resizing/dragging the window on Windows 11 build 22621.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2264

ContentBackground

ContentBackground: "contentBackground";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2244

Dark

Dark: "dark";

macOS 10.14-

Deprecated

since macOS 10.14. Use a semantic material instead.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2184

FullScreenUI

FullScreenUI: "fullScreenUI";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2236

HeaderView

HeaderView: "headerView";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2220

HudWindow

HudWindow: "hudWindow";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2232

Light

Light: "light";

macOS 10.14-

Deprecated

since macOS 10.14. Use a semantic material instead.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2178

MediumLight

MediumLight: "mediumLight";

macOS 10.14-

Deprecated

since macOS 10.14. Use a semantic material instead.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2190

Menu

Menu: "menu";

macOS 10.11+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2208

Mica

Mica: "mica";

Windows 11 Only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2256

Popover

Popover: "popover";

macOS 10.11+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2212

Selection

Selection: "selection";

macOS 10.10+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2204

Sheet

Sheet: "sheet";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2224

Sidebar: "sidebar";

macOS 10.11+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2216

Tabbed

Tabbed: "tabbed";

Tabbed effect that matches the system dark preference Windows 11 Only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2276

TabbedDark

TabbedDark: "tabbedDark";

Tabbed effect with dark mode but only if dark mode is enabled on the system Windows 11 Only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2280

TabbedLight

TabbedLight: "tabbedLight";

Tabbed effect with light mode Windows 11 Only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2284

Titlebar

Titlebar: "titlebar";

macOS 10.10+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2200

Tooltip

Tooltip: "tooltip";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2240

UltraDark

UltraDark: "ultraDark";

macOS 10.14-

Deprecated

since macOS 10.14. Use a semantic material instead.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2196

UnderPageBackground

UnderPageBackground: "underPageBackground";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2252

UnderWindowBackground

UnderWindowBackground: "underWindowBackground";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2248

WindowBackground

WindowBackground: "windowBackground";

macOS 10.14+

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2228

EffectState

Window effect state macOS only

See

https://developer.apple.com/documentation/appkit/nsvisualeffectview/state

Since

2.0.0

Enumeration Members

Active

Active: "active";

Make window effect state always active macOS only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2302

FollowsWindowActiveState

FollowsWindowActiveState: "followsWindowActiveState";

Make window effect state follow the window’s active state macOS only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2298

Inactive

Inactive: "inactive";

Make window effect state always inactive macOS only

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2306

ProgressBarStatus

Enumeration Members

Error

Error: "error";

Error state. Treated as Normal on linux

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L220

Indeterminate

Indeterminate: "indeterminate";

Indeterminate state. Treated as Normal on Linux and macOS

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L212

None

None: "none";

Hide progress bar.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L204

Normal

Normal: "normal";

Normal state.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L208

Paused

Paused: "paused";

Paused state. Treated as Normal on Linux

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L216

ScrollBarStyle

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

Enumeration Members

Default

Default: "default";

The default scrollbar style for the webview.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2151

FluentOverlay

FluentOverlay: "fluentOverlay";

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

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2158

UserAttentionType

Attention type to request on a window.

Since

1.0.0

Enumeration Members

Critical

Critical: 1;

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.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L129

Informational

Informational: 2;

Platform-specific

• macOS: Bounces the dock icon once.
• Windows: Flashes the taskbar button until the application is in focus.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L135

Classes

CloseRequestedEvent

Constructors

new CloseRequestedEvent()

new CloseRequestedEvent(event): CloseRequestedEvent

Parameters

Returns

CloseRequestedEvent

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L145

Properties

Methods

isPreventDefault()

isPreventDefault(): boolean

Returns

boolean

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L154

preventDefault()

preventDefault(): void

Returns

void

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L150

Window

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

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 backendawait appWindow.emit("some-event", "data");// listen to an event from the backendconst unlisten = await appWindow.listen("event-name", e => {});unlisten();

Since

2.0.0

Extended by

• WebviewWindow

Constructors

new Window()

new Window(label, options): Window

Creates a new Window.

Parameters

Returns

Window

The Window instance to communicate with the window.

Example

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});

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L328

Properties

Methods

activityName()

activityName(): Promise<string>

Returns

Promise<string>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L853

center()

center(): Promise<void>

Centers the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().center();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L877

clearEffects()

clearEffects(): Promise<void>

Clear any applied effects if possible.

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1265

close()

close(): Promise<void>

Closes the window.

Note this emits a closeRequested event so you can intercept it. To force window close, use Window.destroy.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().close();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1186

destroy()

destroy(): Promise<void>

Destroys the window. Behaves like Window.close but forces the window close instead of emitting a closeRequested event.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().destroy();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1202

emit()

emit<T>(event, payload?): Promise<void>

Emits an event to all targets.

Type Parameters

Parameters

Returns

Promise<void>

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().emit('window-loaded', { loggedIn: true, token: 'authToken' });

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L479

emitTo()

emitTo<T>(   target,   event,payload?): Promise<void>

Emits an event to all targets matching the given target.

Type Parameters

Parameters

Returns

Promise<void>

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().emit('main', 'window-loaded', { loggedIn: true, token: 'authToken' });

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L506

hide()

hide(): Promise<void>

Sets the window visibility to false.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().hide();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1168

innerPosition()

innerPosition(): Promise<PhysicalPosition>

The position of the top-left hand corner of the window’s client area relative to the top-left hand corner of the desktop.

Returns

Promise<PhysicalPosition>

The window’s inner position.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const position = await getCurrentWindow().innerPosition();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L567

innerSize()

innerSize(): Promise<PhysicalSize>

The physical size of the window’s client area. The client area is the content of the window, excluding the title bar and borders.

Returns

Promise<PhysicalSize>

The window’s inner size.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const size = await getCurrentWindow().innerSize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L600

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>

Whether the window is configured to be always on top of other windows or not.

Returns

Promise<boolean>

Whether the window is visible or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const alwaysOnTop = await getCurrentWindow().isAlwaysOnTop();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L847

isClosable()

isClosable(): Promise<boolean>

Gets the window’s native close button state.

Platform-specific

• iOS / Android: Unsupported.

Returns

Promise<boolean>

Whether the window’s native close button is enabled or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const closable = await getCurrentWindow().isClosable();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L780

isDecorated()

isDecorated(): Promise<boolean>

Gets the window’s current decorated state.

Returns

Promise<boolean>

Whether the window is decorated or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const decorated = await getCurrentWindow().isDecorated();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L701

isEnabled()

isEnabled(): Promise<boolean>

Whether the window is enabled or disabled.

Returns

Promise<boolean>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setEnabled(false);

Since

2.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L969

isFocused()

isFocused(): Promise<boolean>

Gets the window’s current focus state.

Returns

Promise<boolean>

Whether the window is focused or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const focused = await getCurrentWindow().isFocused();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L685

isFullscreen()

isFullscreen(): Promise<boolean>

Gets the window’s current fullscreen state.

Returns

Promise<boolean>

Whether the window is in fullscreen mode or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const fullscreen = await getCurrentWindow().isFullscreen();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L639

isMaximizable()

isMaximizable(): Promise<boolean>

Gets the window’s native maximize button state.

Platform-specific

• Linux / iOS / Android: Unsupported.

Returns

Promise<boolean>

Whether the window’s native maximize button is enabled or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const maximizable = await getCurrentWindow().isMaximizable();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L738

isMaximized()

isMaximized(): Promise<boolean>

Gets the window’s current maximized state.

Returns

Promise<boolean>

Whether the window is maximized or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const maximized = await getCurrentWindow().isMaximized();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L669

isMinimizable()

isMinimizable(): Promise<boolean>

Gets the window’s native minimize button state.

Platform-specific

• Linux / iOS / Android: Unsupported.

Returns

Promise<boolean>

Whether the window’s native minimize button is enabled or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const minimizable = await getCurrentWindow().isMinimizable();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L759

isMinimized()

isMinimized(): Promise<boolean>

Gets the window’s current minimized state.

Returns

Promise<boolean>

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const minimized = await getCurrentWindow().isMinimized();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L653

isResizable()

isResizable(): Promise<boolean>

Gets the window’s current resizable state.

Returns

Promise<boolean>

Whether the window is resizable or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const resizable = await getCurrentWindow().isResizable();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L717

isVisible()

isVisible(): Promise<boolean>

Gets the window’s current visible state.

Returns

Promise<boolean>

Whether the window is visible or not.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const visible = await getCurrentWindow().isVisible();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L796

listen()

listen<T>(event, handler): Promise<UnlistenFn>

Listen to an emitted event on this window.

Type Parameters

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L417

maximize()

maximize(): Promise<void>

Maximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().maximize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1072

minimize()

minimize(): Promise<void>

Minimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().minimize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1120

onCloseRequested()

onCloseRequested(handler): Promise<UnlistenFn>

Listen to window close requested. Emitted when the user requests to closes the window.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1927

onDragDropEvent()

onDragDropEvent(handler): 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.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1965

onFocusChanged()

onFocusChanged(handler): Promise<UnlistenFn>

Listen to window focus change.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2043

onMoved()

onMoved(handler): Promise<UnlistenFn>

Listen to window move.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1898

onResized()

onResized(handler): Promise<UnlistenFn>

Listen to window resize.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1874

onScaleChanged()

onScaleChanged(handler): 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.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2083

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>

Listen to the system theme change.

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2109

once()

once<T>(event, handler): Promise<UnlistenFn>

Listen to an emitted event on this window only once.

Type Parameters

Parameters

Returns

Promise<UnlistenFn>

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.

Example

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 unmountedunlisten();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L452

outerPosition()

outerPosition(): Promise<PhysicalPosition>

The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

Returns

Promise<PhysicalPosition>

The window’s outer position.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const position = await getCurrentWindow().outerPosition();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L583

outerSize()

outerSize(): 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.

Returns

Promise<PhysicalSize>

The window’s outer size.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const size = await getCurrentWindow().outerSize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L620

requestUserAttention()

requestUserAttention(requestType): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().requestUserAttention();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L903

scaleFactor()

scaleFactor(): Promise<number>

The scale factor that can be used to map physical pixels to logical pixels.

Returns

Promise<number>

The window’s monitor scale factor.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const factor = await getCurrentWindow().scaleFactor();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L551

sceneIdentifier()

sceneIdentifier(): Promise<string>

Returns

Promise<string>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L859

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise<void>

Whether the window should always be below other windows.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setAlwaysOnBottom(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1301

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>

Whether the window should always be on top of other windows.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setAlwaysOnTop(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1283

setBackgroundColor()

setBackgroundColor(color): Promise<void>

Sets the window background color.

Platform-specific:

• Windows: alpha channel is ignored.
• iOS / Android: Unsupported.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Since

2.1.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1635

setBadgeCount()

setBadgeCount(count?): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setBadgeCount(5);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1727

setBadgeLabel()

setBadgeLabel(label?): Promise<void>

Sets the badge cont macOS only.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setBadgeLabel("Hello");

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1746

setClosable()

setClosable(closable): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setClosable(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1037

setContentProtected()

setContentProtected(protected_): Promise<void>

Prevents the window contents from being captured by other apps.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setContentProtected(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1318

setCursorGrab()

setCursorGrab(grab): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setCursorGrab(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1574

setCursorIcon()

setCursorIcon(icon): Promise<void>

Modifies the cursor icon of the window.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setCursorIcon('help');

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1616

setCursorPosition()

setCursorPosition(position): Promise<void>

Changes the position of the cursor in window coordinates.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';await getCurrentWindow().setCursorPosition(new LogicalPosition(600, 300));

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1650

setCursorVisible()

setCursorVisible(visible): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setCursorVisible(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1598

setDecorations()

setDecorations(decorations): Promise<void>

Whether the window should have borders and bars.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setDecorations(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1219

setEffects()

setEffects(effects): Promise<void>

Set window effects.

Parameters

Returns

Promise<void>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1255

setEnabled()

setEnabled(enabled): Promise<void>

Enable or disable the window.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setEnabled(false);

Since

2.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L950

setFocus()

setFocus(): Promise<void>

Bring the window to front and focus.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setFocus();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1476

setFocusable()

setFocusable(focusable): 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 Window.setFocus but it will move the window to the back i.e. at the bottom in terms of z-order.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setFocusable(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1499

setFullscreen()

setFullscreen(fullscreen): Promise<void>

Sets the window fullscreen state.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setFullscreen(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1443

setIcon()

setIcon(icon): Promise<void>

Sets the window icon.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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:

[dependencies]tauri = { version = "...", features = ["...", "image-png"] }

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1524

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>

Changes the cursor events behavior.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setIgnoreCursorEvents(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1671

setMaxSize()

setMaxSize(size): Promise<void>

Sets the window maximum inner size. If the size argument is undefined, the constraint is unset.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';await getCurrentWindow().setMaxSize(new LogicalSize(600, 500));

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1374

setMaximizable()

setMaximizable(maximizable): Promise<void>

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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setMaximizable(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L992

setMinSize()

setMinSize(size): Promise<void>

Sets the window minimum inner size. If the size argument is not provided, the constraint is unset.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, PhysicalSize } from '@tauri-apps/api/window';await getCurrentWindow().setMinSize(new PhysicalSize(600, 500));

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1354

setMinimizable()

setMinimizable(minimizable): Promise<void>

Sets whether the window’s native minimize button is enabled or not.

Platform-specific

• Linux / iOS / Android: Unsupported.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setMinimizable(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1014

setOverlayIcon()

setOverlayIcon(icon?): 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:

[dependencies]tauri = { version = "...", features = ["...", "image-png"] }

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setOverlayIcon("/tauri/awesome.png");

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1775

setPosition()

setPosition(position): Promise<void>

Sets the window outer position.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, LogicalPosition } from '@tauri-apps/api/window';await getCurrentWindow().setPosition(new LogicalPosition(600, 500));

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1423

setProgressBar()

setProgressBar(state): 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).

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, ProgressBarStatus } from '@tauri-apps/api/window';await getCurrentWindow().setProgressBar({  status: ProgressBarStatus.Normal,  progress: 50,});

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1803

setResizable()

setResizable(resizable): Promise<void>

Updates the window resizable flag.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setResizable(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L931

setShadow()

setShadow(enable): 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.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setShadow(false);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1245

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): 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 Window.setFullscreen.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1459

setSize()

setSize(size): Promise<void>

Resizes the window with a new inner size.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';await getCurrentWindow().setSize(new LogicalSize(600, 500));

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1336

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>

Sets the window inner size constraints.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setSizeConstraints({ minWidth: 300 });

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1394

setSkipTaskbar()

setSkipTaskbar(skip): Promise<void>

Whether the window icon should be hidden from the taskbar or not.

Platform-specific

• macOS: Unsupported.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setSkipTaskbar(true);

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1548

setTheme()

setTheme(theme?): 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.

Parameters

Returns

Promise<void>

Since

2.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1848

setTitle()

setTitle(title): Promise<void>

Sets the window title.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().setTitle('Tauri');

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1055

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>

Sets the title bar style. macOS only.

Parameters

Returns

Promise<void>

Since

2.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1831

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible): Promise<void>

Sets whether the window should be visible on all workspaces or virtual desktops.

Platform-specific

• Windows / iOS / Android: Unsupported.

Parameters

Returns

Promise<void>

Since

2.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1819

show()

show(): Promise<void>

Sets the window visibility to true.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().show();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1152

startDragging()

startDragging(): Promise<void>

Starts dragging the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().startDragging();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1688

startResizeDragging()

startResizeDragging(direction): Promise<void>

Starts resize-dragging the window.

Parameters

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().startResizeDragging();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1704

theme()

theme(): Promise<null | Theme>

Gets the window’s current theme.

Platform-specific

• macOS: Theme was introduced on macOS 10.14. Returns light on macOS 10.13 and below.

Returns

Promise<null | Theme>

The window theme.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const theme = await getCurrentWindow().theme();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L831

title()

title(): Promise<string>

Gets the window’s current title.

Returns

Promise<string>

Example

import { getCurrentWindow } from '@tauri-apps/api/window';const title = await getCurrentWindow().title();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L810

toggleMaximize()

toggleMaximize(): Promise<void>

Toggles the window maximized state.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().toggleMaximize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1104

unmaximize()

unmaximize(): Promise<void>

Unmaximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().unmaximize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1088

unminimize()

unminimize(): Promise<void>

Unminimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().unminimize();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1136

getAll()

static getAll(): Promise<Window[]>

Gets a list of instances of Window for all available windows.

Returns

Promise<Window[]>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L375

getByLabel()

static getByLabel(label): Promise<null | Window>

Gets the Window associated with the given label.

Parameters

Returns

Promise<null | Window>

The Window instance to communicate with the window or null if the window doesn’t exist.

Example

import { Window } from '@tauri-apps/api/window';const mainWindow = Window.getByLabel('main');

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L361

getCurrent()

static getCurrent(): Window

Get an instance of Window for the current window.

Returns

Window

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L368

getFocusedWindow()

static getFocusedWindow(): Promise<null | Window>

Gets the focused window.

Returns

Promise<null | Window>

The Window instance or undefined if there is not any focused window.

Example

import { Window } from '@tauri-apps/api/window';const focusedWindow = Window.getFocusedWindow();

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L389

Interfaces

Effects

The window effects configuration object

Since

2.0.0

Properties

Monitor

Allows you to retrieve information about a given monitor.

Since

1.0.0

Properties

ProgressBarState

Properties

ScaleFactorChanged

The payload for the scaleChange event.

Since

1.0.2

Properties

WindowOptions

Configuration for the window to create.

Since

1.0.0

Properties

WindowSizeConstraints

Properties

Type Aliases

CursorIcon

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";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L159

Theme

type Theme: "light" | "dark";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L93

TitleBarStyle

type TitleBarStyle: "visible" | "transparent" | "overlay";

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L94

Functions

availableMonitors()

function availableMonitors(): Promise<Monitor[]>

Returns the list of all the monitors available on the system.

Returns

Promise<Monitor[]>

Example

import { availableMonitors } from '@tauri-apps/api/window';const monitors = await availableMonitors();

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2660

currentMonitor()

function currentMonitor(): Promise<Monitor | null>

Returns the monitor on which the window currently resides. Returns null if current monitor can’t be detected.

Returns

Promise<Monitor | null>

Example

import { currentMonitor } from '@tauri-apps/api/window';const monitor = await currentMonitor();

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2610

cursorPosition()

function cursorPosition(): Promise<PhysicalPosition>

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.

Returns

Promise<PhysicalPosition>

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2676

getAllWindows()

function getAllWindows(): Promise<Window[]>

Gets a list of instances of Window for all available windows.

Returns

Promise<Window[]>

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L258

getCurrentWindow()

function getCurrentWindow(): Window

Get an instance of Window for the current window.

Returns

Window

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L246

monitorFromPoint()

function monitorFromPoint(x, y): Promise<Monitor | null>

Returns the monitor that contains the given point. Returns null if can’t find any.

Parameters

Returns

Promise<Monitor | null>

Example

import { monitorFromPoint } from '@tauri-apps/api/window';const monitor = await monitorFromPoint(100.0, 200.0);

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2643

primaryMonitor()

function primaryMonitor(): Promise<Monitor | null>

Returns the primary monitor of the system. Returns null if it can’t identify any monitor as a primary one.

Returns

Promise<Monitor | null>

Example

import { primaryMonitor } from '@tauri-apps/api/window';const monitor = await primaryMonitor();

Since

1.0.0

Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2627

Support on Open CollectiveSponsor on GitHub

© 2026 Tauri Contributors. CC-BY / MIT

Last updated Oct 08, 2026