window

A promise indicating the success or failure of the operation.

Example

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

clearEffects()

clearEffects(): Promise<void>;

Defined in: packages/api/src/window.ts:1265

Clear any applied effects if possible.

Returns

close()

close(): Promise<void>;

Defined in: packages/api/src/window.ts:1186

Closes the window.

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

Returns

A promise indicating the success or failure of the operation.

Example

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

destroy()

destroy(): Promise<void>;

Defined in: packages/api/src/window.ts:1202

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

Returns

A promise indicating the success or failure of the operation.

Example

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

emit()

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

Defined in: packages/api/src/window.ts:479

Emits an event to all targets.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`event`	`string`	Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
`payload?`	`T`	Event payload.

Returns

Example

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

emitTo()

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

Defined in: packages/api/src/window.ts:506

Emits an event to all targets matching the given target.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`target`	\| `string` \| `EventTarget`	Label of the target Window/Webview/WebviewWindow or raw EventTarget object.
`event`	`string`	Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
`payload?`	`T`	Event payload.

Returns

Example

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

hide()

hide(): Promise<void>;

Defined in: packages/api/src/window.ts:1168

Sets the window visibility to false.

Returns

Promise<PhysicalPosition>

A promise indicating the success or failure of the operation.

Example

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

innerPosition()

innerPosition(): Promise<PhysicalPosition>;

Defined in: packages/api/src/window.ts:567

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

The window’s inner position.

Example

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

innerSize()

innerSize(): Promise<PhysicalSize>;

Defined in: packages/api/src/window.ts:600

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

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>;

Defined in: packages/api/src/window.ts:847

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

Returns

Whether the window is visible or not.

Example

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

isClosable()

isClosable(): Promise<boolean>;

Defined in: packages/api/src/window.ts:780

Gets the window’s native close button state.

Platform-specific

iOS / Android: Unsupported.

Returns

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

Example

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

isDecorated()

isDecorated(): Promise<boolean>;

Defined in: packages/api/src/window.ts:701

Gets the window’s current decorated state.

Returns

Whether the window is decorated or not.

Example

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

isEnabled()

isEnabled(): Promise<boolean>;

Defined in: packages/api/src/window.ts:969

Whether the window is enabled or disabled.

Returns

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

isFocused()

isFocused(): Promise<boolean>;

Defined in: packages/api/src/window.ts:685

Gets the window’s current focus state.

Returns

Whether the window is focused or not.

Example

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

isFullscreen()

isFullscreen(): Promise<boolean>;

Defined in: packages/api/src/window.ts:639

Gets the window’s current fullscreen state.

Returns

Whether the window is in fullscreen mode or not.

Example

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

isMaximizable()

isMaximizable(): Promise<boolean>;

Defined in: packages/api/src/window.ts:738

Gets the window’s native maximize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Returns

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

Example

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

isMaximized()

isMaximized(): Promise<boolean>;

Defined in: packages/api/src/window.ts:669

Gets the window’s current maximized state.

Returns

Whether the window is maximized or not.

Example

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

isMinimizable()

isMinimizable(): Promise<boolean>;

Defined in: packages/api/src/window.ts:759

Gets the window’s native minimize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Returns

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

Example

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

isMinimized()

isMinimized(): Promise<boolean>;

Defined in: packages/api/src/window.ts:653

Gets the window’s current minimized state.

Returns

Example

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

isResizable()

isResizable(): Promise<boolean>;

Defined in: packages/api/src/window.ts:717

Gets the window’s current resizable state.

Returns

Whether the window is resizable or not.

Example

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

isVisible()

isVisible(): Promise<boolean>;

Defined in: packages/api/src/window.ts:796

Gets the window’s current visible state.

Returns

Whether the window is visible or not.

Example

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

listen()

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

Defined in: packages/api/src/window.ts:417

Listen to an emitted event on this window.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`event`	`EventName`	Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
`handler`	`EventCallback<T>`	Event handler.

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

maximize()

maximize(): Promise<void>;

Defined in: packages/api/src/window.ts:1072

Maximizes the window.

Returns

A promise indicating the success or failure of the operation.

Example

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

minimize()

minimize(): Promise<void>;

Defined in: packages/api/src/window.ts:1120

Minimizes the window.

Returns

A promise indicating the success or failure of the operation.

Example

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

once()

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

Defined in: packages/api/src/window.ts:452

Listen to an emitted event on this window only once.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`event`	`EventName`	Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
`handler`	`EventCallback<T>`	Event handler.

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onCloseRequested()

onCloseRequested(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:1927

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

Parameters

Parameter	Type
`handler`	(`event`) => \| `void` \| `Promise<void>`

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onDragDropEvent()

onDragDropEvent(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:1965

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

Parameter	Type
`handler`	`EventCallback`<`DragDropEvent`>

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onFocusChanged()

onFocusChanged(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:2043

Listen to window focus change.

Parameters

Parameter	Type
`handler`	`EventCallback<boolean>`

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onMoved()

onMoved(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:1898

Listen to window move.

Parameters

Parameter	Type
`handler`	`EventCallback`<`PhysicalPosition`>

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onResized()

onResized(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:1874

Listen to window resize.

Parameters

Parameter	Type
`handler`	`EventCallback`<`PhysicalSize`>

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onScaleChanged()

onScaleChanged(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:2083

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

Parameter	Type
`handler`	`EventCallback`<`ScaleFactorChanged`>

Returns

A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

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 unmounted
unlisten();

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>;

Defined in: packages/api/src/window.ts:2109

Listen to the system theme change.

Parameters

Parameter	Type
`handler`	`EventCallback`<`Theme`>

Returns

Promise<PhysicalPosition>

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 unmounted
unlisten();

outerPosition()

outerPosition(): Promise<PhysicalPosition>;

Defined in: packages/api/src/window.ts:583

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

Returns

The window’s outer position.

Example

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

outerSize()

outerSize(): Promise<PhysicalSize>;

Defined in: packages/api/src/window.ts:620

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

requestUserAttention()

requestUserAttention(requestType): Promise<void>;

Defined in: packages/api/src/window.ts:903

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

Parameter	Type
`requestType`	\| `UserAttentionType` \| `null`

Returns

A promise indicating the success or failure of the operation.

Example

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

scaleFactor()

scaleFactor(): Promise<number>;

Defined in: packages/api/src/window.ts:551

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

sceneIdentifier()

sceneIdentifier(): Promise<string>;

Defined in: packages/api/src/window.ts:859

Returns

Promise<string>

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise<void>;

Defined in: packages/api/src/window.ts:1301

Whether the window should always be below other windows.

Parameters

Parameter	Type	Description
`alwaysOnBottom`	`boolean`	Whether the window should always be below other windows or not.

Returns

A promise indicating the success or failure of the operation.

Example

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

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>;

Defined in: packages/api/src/window.ts:1283

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

Parameters

Parameter	Type	Description
`alwaysOnTop`	`boolean`	Whether the window should always be on top of other windows or not.

Returns

A promise indicating the success or failure of the operation.

Example

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

setBackgroundColor()

setBackgroundColor(color): Promise<void>;

Defined in: packages/api/src/window.ts:1635

Sets the window background color.

Platform-specific

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

Parameters

Parameter	Type
`color`	`Color`

Returns

A promise indicating the success or failure of the operation.

Since

2.1.0

setBadgeCount()

setBadgeCount(count?): Promise<void>;

Defined in: packages/api/src/window.ts:1727

Sets the badge count. It is app wide and not specific to this window.

Platform-specific

Windows: Unsupported. Use @{linkcode Window.setOverlayIcon} instead.

Parameters

Parameter	Type	Description
`count?`	`number`	The badge count. Use `undefined` to remove the badge.

Returns

A promise indicating the success or failure of the operation.

Example

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

setBadgeLabel()

setBadgeLabel(label?): Promise<void>;

Defined in: packages/api/src/window.ts:1746

Sets the badge cont macOS only.

Parameters

Parameter	Type	Description
`label?`	`string`	The badge label. Use `undefined` to remove the badge.

Returns

A promise indicating the success or failure of the operation.

Example

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

setClosable()

setClosable(closable): Promise<void>;

Defined in: packages/api/src/window.ts:1037

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

Parameter	Type
`closable`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setContentProtected()

setContentProtected(protected_): Promise<void>;

Defined in: packages/api/src/window.ts:1318

Prevents the window contents from being captured by other apps.

Parameters

Parameter	Type
`protected_`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setCursorGrab()

setCursorGrab(grab): Promise<void>;

Defined in: packages/api/src/window.ts:1574

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

Parameter	Type	Description
`grab`	`boolean`	`true` to grab the cursor icon, `false` to release it.

Returns

A promise indicating the success or failure of the operation.

Example

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

setCursorIcon()

setCursorIcon(icon): Promise<void>;

Defined in: packages/api/src/window.ts:1616

Modifies the cursor icon of the window.

Parameters

Parameter	Type	Description
`icon`	`CursorIcon`	The new cursor icon.

Returns

A promise indicating the success or failure of the operation.

Example

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

setCursorPosition()

setCursorPosition(position): Promise<void>;

Defined in: packages/api/src/window.ts:1650

Changes the position of the cursor in window coordinates.

Parameters

Parameter	Type	Description
`position`	\| `PhysicalPosition` \| `LogicalPosition` \| `Position`	The new cursor position.

Returns

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

setCursorVisible()

setCursorVisible(visible): Promise<void>;

Defined in: packages/api/src/window.ts:1598

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

Parameter	Type	Description
`visible`	`boolean`	If `false`, this will hide the cursor. If `true`, this will show the cursor.

Returns

A promise indicating the success or failure of the operation.

Example

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

setDecorations()

setDecorations(decorations): Promise<void>;

Defined in: packages/api/src/window.ts:1219

Whether the window should have borders and bars.

Parameters

Parameter	Type	Description
`decorations`	`boolean`	Whether the window should have borders and bars.

Returns

A promise indicating the success or failure of the operation.

Example

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

setEffects()

setEffects(effects): Promise<void>;

Defined in: packages/api/src/window.ts:1255

Set window effects.

Parameters

Parameter	Type
`effects`	`Effects`

Returns

setEnabled()

setEnabled(enabled): Promise<void>;

Defined in: packages/api/src/window.ts:950

Enable or disable the window.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

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

setFocus()

setFocus(): Promise<void>;

Defined in: packages/api/src/window.ts:1476

Bring the window to front and focus.

Returns

A promise indicating the success or failure of the operation.

Example

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

setFocusable()

setFocusable(focusable): Promise<void>;

Defined in: packages/api/src/window.ts:1499

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

Parameter	Type	Description
`focusable`	`boolean`	Whether the window can be focused.

Returns

A promise indicating the success or failure of the operation.

Example

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

setFullscreen()

setFullscreen(fullscreen): Promise<void>;

Defined in: packages/api/src/window.ts:1443

Sets the window fullscreen state.

Parameters

Parameter	Type	Description
`fullscreen`	`boolean`	Whether the window should go to fullscreen or not.

Returns

A promise indicating the success or failure of the operation.

Example

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

setIcon()

setIcon(icon): Promise<void>;

Defined in: packages/api/src/window.ts:1524

Sets the window icon.

Parameters

Parameter	Type	Description
`icon`	\| `string` \| `Image` \| `Uint8Array` \| `ArrayBuffer` \| `number`[]	Icon bytes or path to the icon file.

Returns

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"] }

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>;

Defined in: packages/api/src/window.ts:1671

Changes the cursor events behavior.

Parameters

Parameter	Type	Description
`ignore`	`boolean`	`true` to ignore the cursor events; `false` to process them as usual.

Returns

A promise indicating the success or failure of the operation.

Example

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

setMaximizable()

setMaximizable(maximizable): Promise<void>;

Defined in: packages/api/src/window.ts:992

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

Parameter	Type
`maximizable`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setMaxSize()

setMaxSize(size): Promise<void>;

Defined in: packages/api/src/window.ts:1374

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

Parameters

Parameter	Type	Description
`size`	\| `PhysicalSize` \| `LogicalSize` \| `Size` \| `null` \| `undefined`	The logical or physical inner size, or `null` to unset the constraint.

Returns

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

setMinimizable()

setMinimizable(minimizable): Promise<void>;

Defined in: packages/api/src/window.ts:1014

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

Platform-specific

Linux / iOS / Android: Unsupported.

Parameters

Parameter	Type
`minimizable`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setMinSize()

setMinSize(size): Promise<void>;

Defined in: packages/api/src/window.ts:1354

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

Parameters

Parameter	Type	Description
`size`	\| `PhysicalSize` \| `LogicalSize` \| `Size` \| `null` \| `undefined`	The logical or physical inner size, or `null` to unset the constraint.

Returns

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

setOverlayIcon()

setOverlayIcon(icon?): Promise<void>;

Defined in: packages/api/src/window.ts:1775

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

Parameter	Type	Description
`icon?`	\| `string` \| `Image` \| `Uint8Array` \| `ArrayBuffer` \| `number`[]	Icon bytes or path to the icon file. Use `undefined` to remove the overlay icon.

Returns

A promise indicating the success or failure of the operation.

Example

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

setPosition()

setPosition(position): Promise<void>;

Defined in: packages/api/src/window.ts:1423

Sets the window outer position.

Parameters

Parameter	Type	Description
`position`	\| `PhysicalPosition` \| `LogicalPosition` \| `Position`	The new position, in logical or physical pixels.

Returns

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

setProgressBar()

setProgressBar(state): Promise<void>;

Defined in: packages/api/src/window.ts:1803

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

Parameter	Type
`state`	`ProgressBarState`

Returns

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

setResizable()

setResizable(resizable): Promise<void>;

Defined in: packages/api/src/window.ts:931

Updates the window resizable flag.

Parameters

Parameter	Type
`resizable`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setShadow()

setShadow(enable): Promise<void>;

Defined in: packages/api/src/window.ts:1245

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

Parameter	Type
`enable`	`boolean`

Returns

A promise indicating the success or failure of the operation.

Example

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

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): Promise<void>;

Defined in: packages/api/src/window.ts:1459

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

Parameter	Type	Description
`fullscreen`	`boolean`	Whether the window should go to simple fullscreen or not.

Returns

A promise indicating the success or failure of the operation.

setSize()

setSize(size): Promise<void>;

Defined in: packages/api/src/window.ts:1336

Resizes the window with a new inner size.

Parameters

Parameter	Type	Description
`size`	\| `PhysicalSize` \| `LogicalSize` \| `Size`	The logical or physical inner size.

Returns

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

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>;

Defined in: packages/api/src/window.ts:1394

Sets the window inner size constraints.

Parameters

Parameter	Type	Description
`constraints`	\| `WindowSizeConstraints` \| `null` \| `undefined`	The logical or physical inner size, or `null` to unset the constraint.

Returns

A promise indicating the success or failure of the operation.

Example

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

setSkipTaskbar()

setSkipTaskbar(skip): Promise<void>;

Defined in: packages/api/src/window.ts:1548

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

Platform-specific

macOS: Unsupported.

Parameters

Parameter	Type	Description
`skip`	`boolean`	true to hide window icon, false to show it.

Returns

A promise indicating the success or failure of the operation.

Example

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

setTheme()

setTheme(theme?): Promise<void>;

Defined in: packages/api/src/window.ts:1848

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

Parameter	Type
`theme?`	`Theme` \| `null`

Returns

Since

2.0.0

setTitle()

setTitle(title): Promise<void>;

Defined in: packages/api/src/window.ts:1055

Sets the window title.

Parameters

Parameter	Type	Description
`title`	`string`	The new title

Returns

A promise indicating the success or failure of the operation.

Example

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

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>;

Defined in: packages/api/src/window.ts:1831

Sets the title bar style. macOS only.

Parameters

Parameter	Type
`style`	`TitleBarStyle`

Returns

Since

2.0.0

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible): Promise<void>;

Defined in: packages/api/src/window.ts:1819

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

Platform-specific

Windows / iOS / Android: Unsupported.

Parameters

Parameter	Type
`visible`	`boolean`

Returns

Since

2.0.0

show()

show(): Promise<void>;

Defined in: packages/api/src/window.ts:1152

Sets the window visibility to true.

Returns

A promise indicating the success or failure of the operation.

Example

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

startDragging()

startDragging(): Promise<void>;

Defined in: packages/api/src/window.ts:1688

Starts dragging the window.

Returns

A promise indicating the success or failure of the operation.

Example

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

startResizeDragging()

startResizeDragging(direction): Promise<void>;

Defined in: packages/api/src/window.ts:1704

Starts resize-dragging the window.

Parameters

Parameter	Type
`direction`	`ResizeDirection`

Returns

A promise indicating the success or failure of the operation.

Example

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

theme()

theme(): Promise<Theme | null>;

Defined in: packages/api/src/window.ts:831

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

The window theme.

Example

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

title()

title(): Promise<string>;

Defined in: packages/api/src/window.ts:810

Gets the window’s current title.

Returns

Promise<string>

Example

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

toggleMaximize()

toggleMaximize(): Promise<void>;

Defined in: packages/api/src/window.ts:1104

Toggles the window maximized state.

Returns

A promise indicating the success or failure of the operation.

Example

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

unmaximize()

unmaximize(): Promise<void>;

Defined in: packages/api/src/window.ts:1088

Unmaximizes the window.

Returns

A promise indicating the success or failure of the operation.

Example

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

unminimize()

unminimize(): Promise<void>;

Defined in: packages/api/src/window.ts:1136

Unminimizes the window.

Returns