Skip to content
Tauri

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 { getCurrent } from "@tauri-apps/api/window";
getCurrent().listen("my-window-event", ({ event, payload }) => { });

References

DragDropEvent

Re-exports DragDropEvent

DragDropPayload

Re-exports DragDropPayload

LogicalPosition

Re-exports LogicalPosition

LogicalSize

Re-exports LogicalSize

PhysicalPosition

Re-exports PhysicalPosition

PhysicalSize

Re-exports PhysicalSize

Enumerations

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/tooling/api/src/window.ts#L2001

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/tooling/api/src/window.ts#L1901

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/tooling/api/src/window.ts#L1993

ContentBackground
ContentBackground: "contentBackground";

macOS 10.14+

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

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/tooling/api/src/window.ts#L1913

FullScreenUI
FullScreenUI: "fullScreenUI";

macOS 10.14+

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

HeaderView
HeaderView: "headerView";

macOS 10.14+

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

HudWindow
HudWindow: "hudWindow";

macOS 10.14+

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

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/tooling/api/src/window.ts#L1907

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/tooling/api/src/window.ts#L1919

Menu: "menu";

macOS 10.11+

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

Mica
Mica: "mica";

Windows 11 Only

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

Popover
Popover: "popover";

macOS 10.11+

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

Selection
Selection: "selection";

macOS 10.10+

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

Sheet
Sheet: "sheet";

macOS 10.14+

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

Sidebar: "sidebar";

macOS 10.11+

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

Tabbed
Tabbed: "tabbed";

Tabbed effect that matches the system dark perefence Windows 11 Only

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

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/tooling/api/src/window.ts#L2009

TabbedLight
TabbedLight: "tabbedLight";

Tabbed effect with light mode Windows 11 Only

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

Titlebar
Titlebar: "titlebar";

macOS 10.10+

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

Tooltip
Tooltip: "tooltip";

macOS 10.14+

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

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/tooling/api/src/window.ts#L1925

UnderPageBackground
UnderPageBackground: "underPageBackground";

macOS 10.14+

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

UnderWindowBackground
UnderWindowBackground: "underWindowBackground";

macOS 10.14+

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

WindowBackground
WindowBackground: "windowBackground";

macOS 10.14+

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


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/tooling/api/src/window.ts#L2031

FollowsWindowActiveState
FollowsWindowActiveState: "followsWindowActiveState";

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

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

Inactive
Inactive: "inactive";

Make window effect state always inactive macOS only

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


ProgressBarStatus

Enumeration Members

Error
Error: "error";

Error state. Treated as Normal on linux

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

Indeterminate
Indeterminate: "indeterminate";

Indeterminate state. Treated as Normal on Linux and macOS

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

None
None: "none";

Hide progress bar.

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

Normal
Normal: "normal";

Normal state.

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

Paused
Paused: "paused";

Paused state. Treated as Normal on Linux

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


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/tooling/api/src/window.ts#L92

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/tooling/api/src/window.ts#L98

Classes

CloseRequestedEvent

Constructors

new CloseRequestedEvent()
new CloseRequestedEvent(event): CloseRequestedEvent
Parameters
ParameterType
eventEvent<null>
Returns

CloseRequestedEvent

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

Properties

PropertyModifierTypeDefault valueDescription
_preventDefaultprivatebooleanfalse-
eventpublicEventNameundefinedEvent name
idpublicnumberundefinedEvent identifier used to unlisten

Methods

isPreventDefault()
isPreventDefault(): boolean
Returns

boolean

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

preventDefault()
preventDefault(): void
Returns

void

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


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

Extended by

Constructors

new Window()
new Window(label, options): Window

Creates a new Window.

Parameters
ParameterTypeDescription
labelstringThe unique window label. Must be alphanumeric: a-zA-Z-/:_.
optionsWindowOptions-
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/tooling/api/src/window.ts#L282

Properties

PropertyTypeDescription
labelstringThe window label. It is a unique identifier for the window, can be used to reference it later.
listenersRecord<string, EventCallback<any>[]>Local event listeners.

Methods

center()
center(): Promise<void>

Centers the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

clearEffects()
clearEffects(): Promise<void>

Clear any applied effects if possible.

Returns

Promise<void>

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

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 { getCurrent } from '@tauri-apps/api/window';
await getCurrent().close();

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

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 { getCurrent } from '@tauri-apps/api/window';
await getCurrent().destroy();

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

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

Emits an event to all targets.

Parameters
ParameterTypeDescription
eventstringEvent name. Must include only alphanumeric characters, -, /, : and _.
payload?unknownEvent payload.
Returns

Promise<void>

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

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

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

Emits an event to all targets matching the given target.

Parameters
ParameterTypeDescription
targetstring | EventTargetLabel of the target Window/Webview/WebviewWindow or raw EventTarget object.
eventstringEvent name. Must include only alphanumeric characters, -, /, : and _.
payload?unknownEvent payload.
Returns

Promise<void>

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

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

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 { getCurrent } from '@tauri-apps/api/window';
await getCurrent().hide();

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

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 { getCurrent } from '@tauri-apps/api/window';
const position = await getCurrent().innerPosition();

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

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 { getCurrent } from '@tauri-apps/api/window';
const size = await getCurrent().innerSize();

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

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 { getCurrent } from '@tauri-apps/api/window';
const closable = await getCurrent().isClosable();

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

isDecorated()
isDecorated(): Promise<boolean>

Gets the window’s current decorated state.

Returns

Promise<boolean>

Whether the window is decorated or not.

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

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

isFocused()
isFocused(): Promise<boolean>

Gets the window’s current focus state.

Returns

Promise<boolean>

Whether the window is focused or not.

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

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

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 { getCurrent } from '@tauri-apps/api/window';
const fullscreen = await getCurrent().isFullscreen();

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

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 { getCurrent } from '@tauri-apps/api/window';
const maximizable = await getCurrent().isMaximizable();

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

isMaximized()
isMaximized(): Promise<boolean>

Gets the window’s current maximized state.

Returns

Promise<boolean>

Whether the window is maximized or not.

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

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

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 { getCurrent } from '@tauri-apps/api/window';
const minimizable = await getCurrent().isMinimizable();

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

isMinimized()
isMinimized(): Promise<boolean>

Gets the window’s current minimized state.

Returns

Promise<boolean>

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

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

isResizable()
isResizable(): Promise<boolean>

Gets the window’s current resizable state.

Returns

Promise<boolean>

Whether the window is resizable or not.

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

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

isVisible()
isVisible(): Promise<boolean>

Gets the window’s current visible state.

Returns

Promise<boolean>

Whether the window is visible or not.

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

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

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

Listen to an emitted event on this window.

Type parameters
Type parameter
T
Parameters
ParameterTypeDescription
eventEventNameEvent name. Must include only alphanumeric characters, -, /, : and _.
handlerEventCallback<T>Event handler.
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 { getCurrent } from '@tauri-apps/api/window';
const unlisten = await getCurrent().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();

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

maximize()
maximize(): Promise<void>

Maximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

minimize()
minimize(): Promise<void>

Minimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

onCloseRequested()
onCloseRequested(handler): Promise<UnlistenFn>

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

Parameters
ParameterType
handler(event) => void | Promise<void>
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 { getCurrent } from "@tauri-apps/api/window";
import { confirm } from '@tauri-apps/api/dialog';
const unlisten = await getCurrent().onCloseRequested(async (event) => {
const confirmed = await confirm('Are you sure?');
if (!confirmed) {
// user did not confirm closing the window; let's prevent it
event.preventDefault();
}
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

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
ParameterType
handlerEventCallback<DragDropEvent>
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 { getCurrent } from "@tauri-apps/api/webview";
const unlisten = await getCurrent().onDragDropEvent((event) => {
if (event.payload.type === 'hover') {
console.log('User hovering', event.payload.paths);
} else if (event.payload.type === 'drop') {
console.log('User dropped', event.payload.paths);
} else {
console.log('File drop cancelled');
}
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

onFocusChanged()
onFocusChanged(handler): Promise<UnlistenFn>

Listen to window focus change.

Parameters
ParameterType
handlerEventCallback<boolean>
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 { getCurrent } from "@tauri-apps/api/window";
const unlisten = await getCurrent().onFocusChanged(({ payload: focused }) => {
console.log('Focus changed, window is focused? ' + focused);
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

onMoved()
onMoved(handler): Promise<UnlistenFn>

Listen to window move.

Parameters
ParameterType
handlerEventCallback<PhysicalPosition>
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 { getCurrent } from "@tauri-apps/api/window";
const unlisten = await getCurrent().onMoved(({ payload: position }) => {
console.log('Window moved', position);
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

onResized()
onResized(handler): Promise<UnlistenFn>

Listen to window resize.

Parameters
ParameterType
handlerEventCallback<PhysicalSize>
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 { getCurrent } from "@tauri-apps/api/window";
const unlisten = await getCurrent().onResized(({ payload: size }) => {
console.log('Window resized', size);
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

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
ParameterType
handlerEventCallback<ScaleFactorChanged>
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 { getCurrent } from "@tauri-apps/api/window";
const unlisten = await getCurrent().onScaleChanged(({ payload }) => {
console.log('Scale changed', payload.scaleFactor, payload.size);
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

onThemeChanged()
onThemeChanged(handler): Promise<UnlistenFn>

Listen to the system theme change.

Parameters
ParameterType
handlerEventCallback<Theme>
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 { getCurrent } from "@tauri-apps/api/window";
const unlisten = await getCurrent().onThemeChanged(({ payload: theme }) => {
console.log('New theme: ' + theme);
});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

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

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

Listen to an emitted event on this window only once.

Type parameters
Type parameter
T
Parameters
ParameterTypeDescription
eventstringEvent name. Must include only alphanumeric characters, -, /, : and _.
handlerEventCallback<T>Event handler.
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 { getCurrent } from '@tauri-apps/api/window';
const unlisten = await getCurrent().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();

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

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 { getCurrent } from '@tauri-apps/api/window';
const position = await getCurrent().outerPosition();

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

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 { getCurrent } from '@tauri-apps/api/window';
const size = await getCurrent().outerSize();

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

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
ParameterType
requestTypenull | UserAttentionType
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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 { getCurrent } from '@tauri-apps/api/window';
const factor = await getCurrent().scaleFactor();

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

setAlwaysOnBottom()
setAlwaysOnBottom(alwaysOnBottom): Promise<void>

Whether the window should always be below other windows.

Parameters
ParameterTypeDescription
alwaysOnBottombooleanWhether the window should always be below other windows or not.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setAlwaysOnTop()
setAlwaysOnTop(alwaysOnTop): Promise<void>

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

Parameters
ParameterTypeDescription
alwaysOnTopbooleanWhether the window should always be on top of other windows or not.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterType
closableboolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setContentProtected()
setContentProtected(protected_): Promise<void>

Prevents the window contents from being captured by other apps.

Parameters
ParameterType
protected_boolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterTypeDescription
grabbooleantrue to grab the cursor icon, false to release it.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setCursorIcon()
setCursorIcon(icon): Promise<void>

Modifies the cursor icon of the window.

Parameters
ParameterTypeDescription
iconCursorIconThe new cursor icon.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setCursorPosition()
setCursorPosition(position): Promise<void>

Changes the position of the cursor in window coordinates.

Parameters
ParameterTypeDescription
positionLogicalPosition | PhysicalPositionThe new cursor position.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterTypeDescription
visiblebooleanIf false, this will hide the cursor. If true, this will show the cursor.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setDecorations()
setDecorations(decorations): Promise<void>

Whether the window should have borders and bars.

Parameters
ParameterTypeDescription
decorationsbooleanWhether the window should have borders and bars.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setEffects()
setEffects(effects): Promise<void>

Set window effects.

Parameters
ParameterType
effectsEffects
Returns

Promise<void>

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

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 { getCurrent } from '@tauri-apps/api/window';
await getCurrent().setFocus();

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

setFullscreen()
setFullscreen(fullscreen): Promise<void>

Sets the window fullscreen state.

Parameters
ParameterTypeDescription
fullscreenbooleanWhether the window should go to fullscreen or not.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setIcon()
setIcon(icon): Promise<void>

Sets the window icon.

Parameters
ParameterTypeDescription
icon| string | number[] | ArrayBuffer | Uint8Array | ImageIcon bytes or path to the icon file.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example
import { getCurrent } from '@tauri-apps/api/window';
await getCurrent().setIcon('/tauri/awesome.png');

Note that you need the image-ico or image-png Cargo features to use this API. To enable it, change your Cargo.toml file:

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

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

setIgnoreCursorEvents()
setIgnoreCursorEvents(ignore): Promise<void>

Changes the cursor events behavior.

Parameters
ParameterTypeDescription
ignorebooleantrue to ignore the cursor events; false to process them as usual.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setMaxSize()
setMaxSize(size): Promise<void>

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

Parameters
ParameterTypeDescription
sizeundefined | null | LogicalSize | PhysicalSizeThe logical or physical inner size, or null to unset the constraint.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterType
maximizableboolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setMinSize()
setMinSize(size): Promise<void>

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

Parameters
ParameterTypeDescription
sizeundefined | null | LogicalSize | PhysicalSizeThe logical or physical inner size, or null to unset the constraint.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setMinimizable()
setMinimizable(minimizable): Promise<void>

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

Platform-specific

  • Linux / iOS / Android: Unsupported.
Parameters
ParameterType
minimizableboolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setPosition()
setPosition(position): Promise<void>

Sets the window outer position.

Parameters
ParameterTypeDescription
positionLogicalPosition | PhysicalPositionThe new position, in logical or physical pixels.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterType
stateProgressBarState
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setResizable()
setResizable(resizable): Promise<void>

Updates the window resizable flag.

Parameters
ParameterType
resizableboolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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 ndecorated window have a 1px white border, and on Windows 11, it will have a rounded corners.
  • Linux: Unsupported.
Parameters
ParameterType
enableboolean
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setSize()
setSize(size): Promise<void>

Resizes the window with a new inner size.

Parameters
ParameterTypeDescription
sizeLogicalSize | PhysicalSizeThe logical or physical inner size.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setSkipTaskbar()
setSkipTaskbar(skip): Promise<void>

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

Platform-specific

  • macOS: Unsupported.
Parameters
ParameterTypeDescription
skipbooleantrue to hide window icon, false to show it.
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

setTitle()
setTitle(title): Promise<void>

Sets the window title.

Parameters
ParameterTypeDescription
titlestringThe new title
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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
ParameterType
visibleboolean
Returns

Promise<void>

Since

2.0.0

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

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 { getCurrent } from '@tauri-apps/api/window';
await getCurrent().show();

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

startDragging()
startDragging(): Promise<void>

Starts dragging the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

startResizeDragging()
startResizeDragging(direction): Promise<void>

Starts resize-dragging the window.

Parameters
ParameterType
directionResizeDirection
Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

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 { getCurrent } from '@tauri-apps/api/window';
const theme = await getCurrent().theme();

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

title()
title(): Promise<string>

Gets the window’s current title.

Returns

Promise<string>

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

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

toggleMaximize()
toggleMaximize(): Promise<void>

Toggles the window maximized state.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

unmaximize()
unmaximize(): Promise<void>

Unmaximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

unminimize()
unminimize(): Promise<void>

Unminimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

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

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

getAll()
static getAll(): Window[]

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

Returns

Window[]

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

getByLabel()
static getByLabel(label): null | Window

Gets the Window associated with the given label.

Parameters
ParameterTypeDescription
labelstringThe window label.
Returns

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/tooling/api/src/window.ts#L315

getCurrent()
static getCurrent(): Window

Get an instance of Window for the current window.

Returns

Window

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

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/tooling/api/src/window.ts#L343

Interfaces

Effects

The window effects configuration object

Since

2.0.0

Properties

PropertyTypeDescription
color?ColorWindow effect color. Affects Effect.Blur and Effect.Acrylic only on Windows 10 v1903+. Doesn’t have any effect on Windows 7 or Windows 11.
effectsEffect[]List of Window effects to apply to the Window. Conflicting effects will apply the first one and ignore the rest.
radius?numberWindow effect corner radius macOS Only
state?EffectStateWindow effect state macOS Only

Monitor

Allows you to retrieve information about a given monitor.

Since

1.0.0

Properties

PropertyTypeDescription
namenull | stringHuman-readable name of the monitor
positionPhysicalPositionthe Top-left corner position of the monitor relative to the larger full screen area.
scaleFactornumberThe scale factor that can be used to map physical pixels to logical pixels.
sizePhysicalSizeThe monitor’s resolution.

ProgressBarState

Properties

PropertyTypeDescription
progress?numberThe progress bar progress. This can be a value ranging from 0 to 100
status?ProgressBarStatusThe progress bar status.

ScaleFactorChanged

The payload for the scaleChange event.

Since

1.0.2

Properties

PropertyTypeDescription
scaleFactornumberThe new window scale factor.
sizePhysicalSizeThe new window size

WindowOptions

Configuration for the window to create.

Since

1.0.0

Properties

PropertyTypeDescription
alwaysOnBottom?booleanWhether the window should always be below other windows.
alwaysOnTop?booleanWhether the window should always be on top of other windows or not.
center?booleanShow window in the center of the screen..
closable?booleanWhether the window’s native close button is enabled or not. Defaults to true.
contentProtected?booleanPrevents the window contents from being captured by other apps.
decorations?booleanWhether the window should have borders and bars or not.
focus?booleanWhether the window will be initially focused or not.
fullscreen?booleanWhether the window is in fullscreen mode or not.
height?numberThe initial height.
hiddenTitle?booleanIf true, sets the window title to be hidden on macOS.
maxHeight?numberThe maximum height. Only applies if maxWidth is also set.
maxWidth?numberThe maximum width. Only applies if maxHeight is also set.
maximizable?booleanWhether the window’s native maximize button is enabled or not. Defaults to true.
maximized?booleanWhether the window should be maximized upon creation or not.
minHeight?numberThe minimum height. Only applies if minWidth is also set.
minWidth?numberThe minimum width. Only applies if minHeight is also set.
minimizable?booleanWhether the window’s native minimize button is enabled or not. Defaults to true.
parent?string | Window | WebviewWindow

Sets a parent to the window to be created. Can be either a 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:
resizable?booleanWhether the window is resizable or not.
shadow?boolean

Whether or not the window has shadow.

Platform-specific

  • Windows:
  • false has no effect on decorated window, shadows are always ON.
  • true will make ndecorated window have a 1px white border, and on Windows 11, it will have a rounded corners.
  • Linux: Unsupported.

Since

2.0.0

skipTaskbar?booleanWhether or not the window icon should be added to the taskbar.
tabbingIdentifier?string

Defines the window tabbing identifier on macOS.

Windows with the same tabbing identifier will be grouped together. If the tabbing identifier is not set, automatic tabbing will be disabled.

theme?Theme

The initial window theme. Defaults to the system theme.

Only implemented on Windows and macOS 10.14+.

title?stringWindow title.
titleBarStyle?TitleBarStyleThe style of the macOS title bar.
transparent?booleanWhether 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.
visible?booleanWhether the window should be immediately visible upon creation or not.
visibleOnAllWorkspaces?boolean

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

Platform-specific

  • Windows / iOS / Android: Unsupported.

Since

2.0.0

width?numberThe initial width.
x?numberThe initial vertical position. Only applies if y is also set.
y?numberThe initial horizontal position. Only applies if x is also set.

Type Aliases

Color

type Color: [number, number, number, number];

an array RGBA colors. Each value has minimum of 0 and maximum of 255.

Since

2.0.0

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


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/tooling/api/src/window.ts#L122


Theme

type Theme: "light" | "dark";

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


TitleBarStyle

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

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

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 = availableMonitors();

Since

1.0.0

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


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 = currentMonitor();

Since

1.0.0

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


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/tooling/api/src/window.ts#L2283


getAll()

function getAll(): Window[]

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

Returns

Window[]

Since

1.0.0

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


getCurrent()

function getCurrent(): 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/tooling/api/src/window.ts#L202


monitorFromPoint()

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

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

Parameters

ParameterType
xnumber
ynumber

Returns

Promise<Monitor | null>

Example

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

Since

1.0.0

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


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 = primaryMonitor();

Since

1.0.0

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


© 2024 Tauri Contributors. CC-BY / MIT