@tauri-apps/api/webviewWindow

Create and manipulate windows that host a single webview.

WebviewWindow is the type you want for ordinary multi-window apps: it mixes together the Window and Webview APIs, so one object exposes both the window methods (setTitle, maximize, close, …) and the webview ones (setZoom, clearAllBrowsingData, …).

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';

const settings = new WebviewWindow('settings', {
  url: '/settings',
  title: 'Settings'
});
settings.once('tauri://created', () => console.log('window created'));
settings.once('tauri://error', (e) => console.error(e));

Unlike child webviews, this does not require the unstable Cargo feature.

This package is also accessible with window.__TAURI__.webviewWindow when app.withGlobalTauri in tauri.conf.json is set to true.

Remarks

Creating a webview window requires the core:webview:allow-create-webview-window permission, which is not included in core:webview:default. The methods inherited from Window and Webview each document their own permission.

Functions

getAllWebviewWindows()

function getAllWebviewWindows(): Promise<WebviewWindow[]>;

Defined in: packages/api/src/webviewWindow.ts:69

Gets a list of instances of Webview for all available webview windows.

Returns

Promise<WebviewWindow[]>

Remarks

Uses the core:window:allow-get-all-windows permission, which is part of core:window:default.

Since

2.0.0

---

getCurrentWebviewWindow()

function getCurrentWebviewWindow(): WebviewWindow;

Defined in: packages/api/src/webviewWindow.ts:55

Get an instance of Webview for the current webview window.

Returns

WebviewWindow

Since

2.0.0

Classes

WebviewWindow

Defined in: packages/api/src/webviewWindow.ts:82

Create new webview or get a handle to an existing one.

Webviews 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 _.

Requires the unstable Cargo feature

Creating a webview with new Webview(...) adds a child webview to an existing window, which is an unstable API gated behind the unstable feature of the tauri crate:

[dependencies]
tauri = { version = "2", features = ["unstable"] }

Without it the call rejects with an “unstable feature not supported” error. Getting a handle to an existing webview (Webview.getByLabel, getCurrentWebview, getAllWebviews) and every method on this class work without the feature. To create a window that hosts a single webview, use WebviewWindow instead, which is stable.

Example

import { Window } from "@tauri-apps/api/window"
import { Webview } from "@tauri-apps/api/webview"

const appWindow = new Window('uniqueLabel');

appWindow.once('tauri://created', async function () {
  // `new Webview` Should be called after the window is successfully created,
  // or webview may not be attached to the window since window is not created yet.

  // loading embedded asset:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'path/to/page.html',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });
  // alternatively, load a remote URL:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'https://github.com/tauri-apps/tauri',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });

  webview.once('tauri://created', function () {
    // webview successfully created
  });
  webview.once('tauri://error', function (e) {
    // an error happened creating the webview
  });

  // emit an event to the backend
  await webview.emit("some-event", "data");
  // listen to an event from the backend
  const unlisten = await webview.listen("event-name", e => { });
  unlisten();
});

Since

2.0.0

Extends

• Webview.Window

Constructors

new WebviewWindow()

new WebviewWindow(label: string, options?: Omit<WebviewOptions, "x" | "y" | "width" | "height"> & WindowOptions): WebviewWindow;

Defined in: packages/api/src/webviewWindow.ts:115

Creates a new Window hosting a Webview.

Example

import { WebviewWindow } from '@tauri-apps/api/webviewWindow'
const webview = new WebviewWindow('my-label', {
  url: 'https://github.com/tauri-apps/tauri'
});
webview.once('tauri://created', function () {
 // webview successfully created
});
webview.once('tauri://error', function (e) {
 // an error happened creating the webview
});

Parameters

Parameter	Type	Description
label	string	The unique webview label. Must be alphanumeric: a-zA-Z-/:_.
options	Omit<WebviewOptions, "x" | "y" | "width" | "height"> & WindowOptions	The window and webview configuration, see WindowOptions and WebviewOptions.

Returns

WebviewWindow

The WebviewWindow instance to communicate with the window and webview.

Remarks

Requires the core:webview:allow-create-webview-window permission (not included in core:webview:default).

Inherited from

Webview.constructor

Properties

Property	Type	Description	Inherited from	Defined in
label	string	The webview label. It is a unique identifier for the webview, can be used to reference it later.	Webview.label	packages/api/src/webviewWindow.ts:86
listeners	Record<string, EventCallback<any>[]>	Local event listeners.	Webview.listeners	packages/api/src/webviewWindow.ts:89
window	Window	The window hosting this webview.	Webview.window	packages/api/src/webview.ts:211

Methods

activityName()

activityName(): Promise<string>;

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

The name of the Android activity hosting this window.

On Android each window is backed by its own activity. Use this to tell windows apart from native code, or to match a window with the activity declared in your AndroidManifest.xml.

Platform-specific

• Android: Supported.
• Windows / Linux / macOS / iOS: Unsupported, the call rejects because the command is not registered.

See the mobile multiwindow guide.

Example

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

Returns

Promise<string>

The activity name.

Remarks

Uses the core:window:allow-activity-name permission, which is part of core:window:default.

Since

2.11.0

Inherited from

Window.activityName

center()

center(): Promise<void>;

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

Centers the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-center permission (not included in core:window:default).

Inherited from

Window.center

clearAllBrowsingData()

clearAllBrowsingData(): Promise<void>;

Defined in: packages/api/src/webview.ts:699

Clears all browsing data for this webview: cookies, localStorage, IndexedDB, caches and any other data the webview stores for the loaded origins.

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().clearAllBrowsingData();

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-clear-all-browsing-data permission (not included in core:webview:default).

Inherited from

Webview.clearAllBrowsingData

clearEffects()

clearEffects(): Promise<void>;

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

Clear any applied effects if possible.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-effects permission (not included in core:window:default), the same one used by Window.setEffects.

Since

2.0.0

Inherited from

Window.clearEffects

close()

close(): Promise<void>;

Defined in: packages/api/src/webview.ts:513

Closes the webview.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-webview-close permission (not included in core:webview:default).

Inherited from

Webview.close

destroy()

destroy(): Promise<void>;

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

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

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-destroy permission (not included in core:window:default).

Inherited from

Window.destroy

emit()

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

Defined in: packages/api/src/webview.ts:393

Emits an event to all targets.

Example

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

Type Parameters

Type Parameter
T

Parameters

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

Returns

Promise<void>

Inherited from

Webview.emit

emitTo()

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

Defined in: packages/api/src/webview.ts:421

Emits an event to all targets matching the given target.

Example

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

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

Promise<void>

Inherited from

Webview.emitTo

hide()

hide(): Promise<void>;

Defined in: packages/api/src/webview.ts:618

Hide the webview.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-webview-hide permission (not included in core:webview:default).

Inherited from

Webview.hide

innerPosition()

innerPosition(): Promise<PhysicalPosition>;

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

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

Example

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

Returns

Promise<PhysicalPosition>

The window’s inner position.

Inherited from

Window.innerPosition

innerSize()

innerSize(): Promise<PhysicalSize>;

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

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

Example

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

Returns

Promise<PhysicalSize>

The window’s inner size.

Inherited from

Window.innerSize

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>;

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

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

Example

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

Returns

Promise<boolean>

Whether the window is visible or not.

Inherited from

Window.isAlwaysOnTop

isClosable()

isClosable(): Promise<boolean>;

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

Gets the window’s native close button state.

Platform-specific

• iOS / Android: Unsupported.

Example

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

Returns

Promise<boolean>

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

Inherited from

Window.isClosable

isDecorated()

isDecorated(): Promise<boolean>;

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

Gets the window’s current decorated state.

Example

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

Returns

Promise<boolean>

Whether the window is decorated or not.

Inherited from

Window.isDecorated

isEnabled()

isEnabled(): Promise<boolean>;

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

Whether the window is enabled or disabled.

A disabled window ignores all user input; see Window.setEnabled.

Example

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

Returns

Promise<boolean>

true when the window accepts user input, false when it is disabled.

Since

2.0.0

Inherited from

Window.isEnabled

isFocused()

isFocused(): Promise<boolean>;

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

Gets the window’s current focus state.

Example

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

Returns

Promise<boolean>

Whether the window is focused or not.

Inherited from

Window.isFocused

isFullscreen()

isFullscreen(): Promise<boolean>;

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

Gets the window’s current fullscreen state.

Example

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

Returns

Promise<boolean>

Whether the window is in fullscreen mode or not.

Inherited from

Window.isFullscreen

isMaximizable()

isMaximizable(): Promise<boolean>;

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

Gets the window’s native maximize button state.

Platform-specific

• Linux / iOS / Android: Unsupported.

Example

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

Returns

Promise<boolean>

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

Inherited from

Window.isMaximizable

isMaximized()

isMaximized(): Promise<boolean>;

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

Gets the window’s current maximized state.

Example

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

Returns

Promise<boolean>

Whether the window is maximized or not.

Inherited from

Window.isMaximized

isMinimizable()

isMinimizable(): Promise<boolean>;

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

Gets the window’s native minimize button state.

Platform-specific

• Linux / iOS / Android: Unsupported.

Example

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

Returns

Promise<boolean>

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

Inherited from

Window.isMinimizable

isMinimized()

isMinimized(): Promise<boolean>;

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

Gets the window’s current minimized state.

Example

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

Returns

Promise<boolean>

Inherited from

Window.isMinimized

isResizable()

isResizable(): Promise<boolean>;

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

Gets the window’s current resizable state.

Example

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

Returns

Promise<boolean>

Whether the window is resizable or not.

Inherited from

Window.isResizable

isVisible()

isVisible(): Promise<boolean>;

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

Gets the window’s current visible state.

Example

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

Returns

Promise<boolean>

Whether the window is visible or not.

Inherited from

Window.isVisible

listen()

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

Defined in: packages/api/src/webviewWindow.ts:199

Listen to an emitted event on this webview window.

Example

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().listen<string>('state-changed', (event) => {
  console.log(`Got error: ${payload}`);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

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

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this webview window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Webview.listen

maximize()

maximize(): Promise<void>;

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

Maximizes the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-maximize permission (not included in core:window:default).

Inherited from

Window.maximize

minimize()

minimize(): Promise<void>;

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

Minimizes the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-minimize permission (not included in core:window:default).

Inherited from

Window.minimize

once()

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

Defined in: packages/api/src/webviewWindow.ts:237

Listen to an emitted event on this webview window only once.

Example

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().once<null>('initialized', (event) => {
  console.log(`Webview initialized!`);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

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

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener removes itself after the first event and is also removed automatically when this webview window is destroyed. Do call the returned function if the listener’s own scope ends before the event arrives.

Inherited from

Webview.once

onCloseRequested()

onCloseRequested(handler: (event: CloseRequestedEvent) =>
  | void
| Promise<void>): Promise<UnlistenFn>;

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

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

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
// `confirm` comes from the dialog plugin, which you have to add separately:
// `pnpm tauri add dialog`
import { confirm } from '@tauri-apps/plugin-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();
  }
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	(event: CloseRequestedEvent) => | void | Promise<void>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onCloseRequested

onDragDropEvent()

onDragDropEvent(handler: EventCallback<DragDropEvent>): Promise<UnlistenFn>;

Defined in: packages/api/src/webview.ts:769

Listen to a file drop event. The listener is triggered when the user hovers the selected files on the webview, drops the files or cancels the operation.

Example

import { getCurrentWebview } from "@tauri-apps/api/webview";
const unlisten = await getCurrentWebview().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');
 }
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

When the debugger panel is open, the drop position of this event may be inaccurate due to a known limitation. To retrieve the correct drop position, please detach the debugger.

Parameters

Parameter	Type
handler	EventCallback<DragDropEvent>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listeners are removed automatically when this webview is destroyed. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Webview.onDragDropEvent

onFocusChanged()

onFocusChanged(handler: EventCallback<boolean>): Promise<UnlistenFn>;

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

Listen to window focus change.

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onFocusChanged(({ payload: focused }) => {
 console.log('Focus changed, window is focused? ' + focused);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	EventCallback<boolean>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onFocusChanged

onMoved()

onMoved(handler: EventCallback<PhysicalPosition>): Promise<UnlistenFn>;

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

Listen to window move.

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onMoved(({ payload: position }) => {
 console.log('Window moved', position);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	EventCallback<PhysicalPosition>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onMoved

onResized()

onResized(handler: EventCallback<PhysicalSize>): Promise<UnlistenFn>;

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

Listen to window resize.

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onResized(({ payload: size }) => {
 console.log('Window resized', size);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	EventCallback<PhysicalSize>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onResized

onScaleChanged()

onScaleChanged(handler: EventCallback<ScaleFactorChanged>): Promise<UnlistenFn>;

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

Listen to window scale change. Emitted when the window’s scale factor has changed. The following user actions can cause DPI changes:

• Changing the display’s resolution.
• Changing the display’s scale factor (e.g. in Control Panel on Windows).
• Moving the window to a display with a different scale factor.

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onScaleChanged(({ payload }) => {
 console.log('Scale changed', payload.scaleFactor, payload.size);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	EventCallback<ScaleFactorChanged>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onScaleChanged

onThemeChanged()

onThemeChanged(handler: EventCallback<Theme>): Promise<UnlistenFn>;

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

Listen to the system theme change.

Example

import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onThemeChanged(({ payload: theme }) => {
 console.log('New theme: ' + theme);
});

// call unlisten when your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

Parameter	Type
handler	EventCallback<Theme>

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Remarks

The listener is removed automatically when this window is destroyed, so you do not need to unlisten just because the window is closing. Do call the returned function when the listener’s own scope ends, e.g. on page navigation or when a component unmounts.

Inherited from

Window.onThemeChanged

outerPosition()

outerPosition(): Promise<PhysicalPosition>;

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

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

Example

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

Returns

Promise<PhysicalPosition>

The window’s outer position.

Inherited from

Window.outerPosition

outerSize()

outerSize(): Promise<PhysicalSize>;

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

The physical size of the entire window. These dimensions include the title bar and borders. If you don’t want that (and you usually don’t), use inner_size instead.

Example

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

Returns

Promise<PhysicalSize>

The window’s outer size.

Inherited from

Window.outerSize

position()

position(): Promise<PhysicalPosition>;

Defined in: packages/api/src/webview.ts:469

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

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
const position = await getCurrentWebview().position();

Returns

Promise<PhysicalPosition>

The webview’s position, in physical pixels.

Remarks

Uses the core:webview:allow-webview-position permission, which is part of core:webview:default.

Inherited from

Webview.position

reparent()

reparent(window: string | Window | WebviewWindow): Promise<void>;

Defined in: packages/api/src/webview.ts:678

Moves this webview to the window with the given label.

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().reparent('other-window');

Parameters

Parameter	Type	Description
window	| string | Window | WebviewWindow	The target window, or its label.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-reparent permission (not included in core:webview:default).

Inherited from

Webview.reparent

requestUserAttention()

requestUserAttention(requestType: UserAttentionType | null): Promise<void>;

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

Requests user attention to the window, this has no effect if the application is already focused. How requesting for user attention manifests is platform dependent, see UserAttentionType for details.

Providing null will unset the request for user attention. Unsetting the request for user attention might not be done automatically by the WM when the window receives input.

Platform-specific

• macOS: null has no effect.
• Linux: Urgency levels have the same effect.

Example

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

Parameters

Parameter	Type
requestType	| UserAttentionType | null

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-request-user-attention permission (not included in core:window:default).

Inherited from

Window.requestUserAttention

scaleFactor()

scaleFactor(): Promise<number>;

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

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

Example

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

Returns

Promise<number>

The window’s monitor scale factor.

Inherited from

Window.scaleFactor

sceneIdentifier()

sceneIdentifier(): Promise<string>;

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

The identifier of the iOS scene hosting this window.

On iOS each window is backed by a UIScene. Use this to tell windows apart from native code, or to match a window with a scene configuration declared in your Info.plist.

Platform-specific

• iOS: Supported.
• Windows / Linux / macOS / Android: Unsupported, the call rejects because the command is not registered.

See the mobile multiwindow guide.

Example

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

Returns

Promise<string>

The scene identifier.

Remarks

Uses the core:window:allow-scene-identifier permission, which is part of core:window:default.

Since

2.11.0

Inherited from

Window.sceneIdentifier

setAlwaysOnBottom()

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

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

Whether the window should always be below other windows.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-always-on-bottom permission (not included in core:window:default).

Inherited from

Window.setAlwaysOnBottom

setAlwaysOnTop()

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

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

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

Example

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

Parameters

Parameter	Type	Description
alwaysOnTop	boolean	Whether 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.

Remarks

Requires the core:window:allow-set-always-on-top permission (not included in core:window:default).

Inherited from

Window.setAlwaysOnTop

setAutoResize()

setAutoResize(autoResize: boolean): Promise<void>;

Defined in: packages/api/src/webview.ts:598

Sets whether the webview should automatically grow and shrink its size and position when the parent window resizes.

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setAutoResize(true);

Parameters

Parameter	Type
autoResize	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-set-webview-auto-resize permission (not included in core:webview:default).

Inherited from

Webview.setAutoResize

setBackgroundColor()

setBackgroundColor(color: Color): Promise<void>;

Defined in: packages/api/src/webviewWindow.ts:280

Set the window and webview background color.

Platform-specific

• Android / iOS: Unsupported for the window layer.
• macOS / iOS: Not implemented for the webview layer.
• Windows:
  • alpha channel is ignored for the window layer.
  • On Windows 7, alpha channel is ignored for the webview layer.
  • On Windows 8 and newer, if alpha channel is not 0, it will be ignored.

Example

import { getCurrentWebviewWindow } from '@tauri-apps/api/webviewWindow';
await getCurrentWebviewWindow().setBackgroundColor('#2f2f2f');

Parameters

Parameter	Type	Description
color	Color	The new background color.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires both the core:window:allow-set-background-color and core:webview:allow-set-webview-background-color permissions, neither of which is included in the respective default permission set.

Since

2.1.0

Inherited from

Webview.setBackgroundColor

setBadgeCount()

setBadgeCount(count?: number): Promise<void>;

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

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

Platform-specific

• Windows: Unsupported. Use Window.setOverlayIcon instead.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-badge-count permission (not included in core:window:default).

Inherited from

Window.setBadgeCount

setBadgeLabel()

setBadgeLabel(label?: string): Promise<void>;

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

Sets the badge label shown on the app’s dock icon. macOS only

Unlike Window.setBadgeCount, which takes a number, this shows arbitrary short text. It is app-wide and not specific to this window.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-badge-label permission (not included in core:window:default).

Inherited from

Window.setBadgeLabel

setClosable()

setClosable(closable: boolean): Promise<void>;

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

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

Platform-specific

• Linux: GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible
• iOS / Android: Unsupported.

Example

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

Parameters

Parameter	Type
closable	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-closable permission (not included in core:window:default).

Inherited from

Window.setClosable

setContentProtected()

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

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

Prevents the window contents from being captured by other apps.

Example

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

Parameters

Parameter	Type
protected_	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-content-protected permission (not included in core:window:default).

Inherited from

Window.setContentProtected

setCursorGrab()

setCursorGrab(grab: boolean): Promise<void>;

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

Grabs the cursor, preventing it from leaving the window.

There’s no guarantee that the cursor will be hidden. You should hide it by yourself if you want so.

Platform-specific

• Linux: Unsupported.
• macOS: This locks the cursor in a fixed location, which looks visually awkward.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-cursor-grab permission (not included in core:window:default).

Inherited from

Window.setCursorGrab

setCursorIcon()

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

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

Modifies the cursor icon of the window.

Example

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

Parameters

Parameter	Type	Description
icon	CursorIcon	The new cursor icon.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-cursor-icon permission (not included in core:window:default).

Inherited from

Window.setCursorIcon

setCursorPosition()

setCursorPosition(position: PhysicalPosition | LogicalPosition | Position): Promise<void>;

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

Changes the position of the cursor in window coordinates.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-cursor-position permission (not included in core:window:default).

Inherited from

Window.setCursorPosition

setCursorVisible()

setCursorVisible(visible: boolean): Promise<void>;

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

Modifies the cursor’s visibility.

Platform-specific

• Windows: The cursor is only hidden within the confines of the window.
• macOS: The cursor is hidden as long as the window has input focus, even if the cursor is outside of the window.

Example

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

Parameters

Parameter	Type	Description
visible	boolean	If 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.

Remarks

Requires the core:window:allow-set-cursor-visible permission (not included in core:window:default).

Inherited from

Window.setCursorVisible

setDecorations()

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

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

Whether the window should have borders and bars.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-decorations permission (not included in core:window:default).

Inherited from

Window.setDecorations

setEffects()

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

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

Applies platform-specific window effects such as Mica, Acrylic, Blur or the macOS vibrancy materials.

Requires the window to be transparent, so create it with transparent: true (or set transparent in tauri.conf.json). Give the page a transparent or translucent background as well, otherwise the effect is hidden behind your own background color.

Conflicting effects are resolved by applying the first supported one and ignoring the rest, so you can list a Windows and a macOS effect together.

Platform-specific

• Windows: If the window uses decorations or shadows, you may need this workaround.
• Linux: Unsupported.

Example

import { getCurrentWindow, Effect, EffectState } from '@tauri-apps/api/window';

await getCurrentWindow().setEffects({
  effects: [Effect.Mica, Effect.Acrylic, Effect.UnderWindowBackground],
  state: EffectState.Active,
  radius: 8
});

Parameters

Parameter	Type	Description
effects	Effects	The effects to apply, see Effects.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-effects permission (not included in core:window:default).

Since

2.0.0

Inherited from

Window.setEffects

setEnabled()

setEnabled(enabled: boolean): Promise<void>;

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

Enable or disable the window.

Example

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

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-enabled permission (not included in core:window:default).

Since

2.0.0

Inherited from

Window.setEnabled

setFocus()

setFocus(): Promise<void>;

Defined in: packages/api/src/webview.ts:579

Bring the webview to front and focus.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-set-webview-focus permission (not included in core:webview:default).

Inherited from

Webview.setFocus

setFocusable()

setFocusable(focusable: boolean): Promise<void>;

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

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.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-focusable permission (not included in core:window:default).

Inherited from

Window.setFocusable

setFullscreen()

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

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

Sets the window fullscreen state.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-fullscreen permission (not included in core:window:default).

Inherited from

Window.setFullscreen

setFullscreenOnMonitor()

setFullscreenOnMonitor(position: PhysicalPosition): Promise<void>;

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

Sets the window as fullscreen on the monitor that contains the given physical position.

Does nothing if no monitor contains the position.

Example

import { getCurrentWindow, availableMonitors } from '@tauri-apps/api/window';
const monitors = await availableMonitors();
if (monitors.length > 1) {
  await getCurrentWindow().setFullscreenOnMonitor(monitors[1].position);
}

Parameters

Parameter	Type	Description
position	PhysicalPosition	A physical position inside the target monitor, such as Monitor.position.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-fullscreen-on-monitor permission (not included in core:window:default).

Since

2.12.0

Inherited from

Window.setFullscreenOnMonitor

setIcon()

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

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

Sets the window icon.

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

Parameters

Parameter	Type	Description
icon	JsImage	Icon bytes or path to the icon file.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-icon permission (not included in core:window:default).

Inherited from

Window.setIcon

setIgnoreCursorEvents()

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

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

Changes the cursor events behavior.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-ignore-cursor-events permission (not included in core:window:default).

Inherited from

Window.setIgnoreCursorEvents

setMaximizable()

setMaximizable(maximizable: boolean): Promise<void>;

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

Sets whether the window’s native maximize button is enabled or not. If resizable is set to false, this setting is ignored.

Platform-specific

• macOS: Disables the “zoom” button in the window titlebar, which is also used to enter fullscreen mode.
• Linux / iOS / Android: Unsupported.

Example

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

Parameters

Parameter	Type
maximizable	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-maximizable permission (not included in core:window:default).

Inherited from

Window.setMaximizable

setMaxSize()

setMaxSize(size: PhysicalSize | LogicalSize | Size | null | undefined): Promise<void>;

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

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

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-max-size permission (not included in core:window:default).

Inherited from

Window.setMaxSize

setMinimizable()

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

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

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

Platform-specific

• Linux / iOS / Android: Unsupported.

Example

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

Parameters

Parameter	Type
minimizable	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-minimizable permission (not included in core:window:default).

Inherited from

Window.setMinimizable

setMinSize()

setMinSize(size: PhysicalSize | LogicalSize | Size | null | undefined): Promise<void>;

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

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

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-min-size permission (not included in core:window:default).

Inherited from

Window.setMinSize

setOverlayIcon()

setOverlayIcon(icon?: JsImage): Promise<void>;

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

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

Example

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

Parameters

Parameter	Type	Description
icon?	JsImage	Icon bytes or path to the icon file. Use undefined to remove the overlay icon.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-overlay-icon permission (not included in core:window:default).

Inherited from

Window.setOverlayIcon

setPosition()

setPosition(position: PhysicalPosition | LogicalPosition | Position): Promise<void>;

Defined in: packages/api/src/webview.ts:557

Sets the webview position.

Example

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

Parameters

Parameter	Type	Description
position	| PhysicalPosition | LogicalPosition | Position	The new position, in logical or physical pixels, relative to the top-left corner of the hosting window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-set-webview-position permission (not included in core:webview:default).

Inherited from

Webview.setPosition

setProgressBar()

setProgressBar(state: ProgressBarState): Promise<void>;

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

Sets the taskbar progress state.

Platform-specific

• Linux / macOS: Progress bar is app-wide and not specific to this window.
• Linux: Only supported desktop environments with libunity (e.g. GNOME).

Example

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

Parameters

Parameter	Type
state	ProgressBarState

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-progress-bar permission (not included in core:window:default).

Inherited from

Window.setProgressBar

setResizable()

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

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

Updates the window resizable flag.

Example

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

Parameters

Parameter	Type
resizable	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-resizable permission (not included in core:window:default).

Inherited from

Window.setResizable

setShadow()

setShadow(enable: boolean): Promise<void>;

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

Whether or not the window should have shadow.

Platform-specific

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

Example

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

Parameters

Parameter	Type
enable	boolean

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-shadow permission (not included in core:window:default).

Inherited from

Window.setShadow

setSimpleFullscreen()

setSimpleFullscreen(fullscreen: boolean): Promise<void>;

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

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.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-simple-fullscreen permission (not included in core:window:default).

Since

2.8.0

Inherited from

Window.setSimpleFullscreen

setSize()

setSize(size: PhysicalSize | LogicalSize | Size): Promise<void>;

Defined in: packages/api/src/webview.ts:534

Resizes the webview.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-set-webview-size permission (not included in core:webview:default).

Inherited from

Webview.setSize

setSizeConstraints()

setSizeConstraints(constraints: WindowSizeConstraints | null | undefined): Promise<void>;

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

Sets the window inner size constraints.

Example

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

Parameters

Parameter	Type	Description
constraints	| WindowSizeConstraints | null | undefined	The inner size constraints in logical pixels, or null to unset every constraint. Each field is optional and independent, so { minWidth: 300 } constrains only the width.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-size-constraints permission (not included in core:window:default).

Inherited from

Window.setSizeConstraints

setSkipTaskbar()

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

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

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

Platform-specific

• macOS: Unsupported.

Example

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

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-skip-taskbar permission (not included in core:window:default).

Inherited from

Window.setSkipTaskbar

setTheme()

setTheme(theme?: Theme | null): Promise<void>;

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

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.

Use Window.theme to read the effective theme and Window.onThemeChanged to react to changes.

Example

import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setTheme('dark');
// follow the system theme again
await getCurrentWindow().setTheme(null);

Parameters

Parameter	Type	Description
theme?	Theme | null	The theme to apply, or null/undefined to follow the system theme.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-theme permission (not included in core:window:default).

Since

2.0.0

Inherited from

Window.setTheme

setTitle()

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

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

Sets the window title.

Example

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

Parameters

Parameter	Type	Description
title	string	The new title

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-title permission (not included in core:window:default).

Inherited from

Window.setTitle

setTitleBarStyle()

setTitleBarStyle(style: TitleBarStyle): Promise<void>;

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

Sets the title bar style. macOS only.

Use transparent or overlay to build a custom title bar: with overlay the page extends under the title bar and only the traffic lights remain, so leave room for them in your layout and pair it with Window.startDragging on a draggable region.

Example

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

Parameters

Parameter	Type	Description
style	TitleBarStyle	The new title bar style, see TitleBarStyle.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-title-bar-style permission (not included in core:window:default).

Since

2.0.0

Inherited from

Window.setTitleBarStyle

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible: boolean): Promise<void>;

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

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

Platform-specific

• Windows / iOS / Android: Unsupported.

Example

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

Parameters

Parameter	Type	Description
visible	boolean	Whether the window should follow the user across workspaces.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-set-visible-on-all-workspaces permission (not included in core:window:default).

Since

2.0.0

Inherited from

Window.setVisibleOnAllWorkspaces

setZoom()

setZoom(scaleFactor: number): Promise<void>;

Defined in: packages/api/src/webview.ts:657

Set webview zoom level.

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setZoom(1.5);

Parameters

Parameter	Type	Description
scaleFactor	number	The zoom level, where 1 is 100%.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-set-webview-zoom permission (not included in core:webview:default).

Inherited from

Webview.setZoom

show()

show(): Promise<void>;

Defined in: packages/api/src/webview.ts:637

Show the webview.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:webview:allow-webview-show permission (not included in core:webview:default).

Inherited from

Webview.show

size()

size(): Promise<PhysicalSize>;

Defined in: packages/api/src/webview.ts:489

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

Example

import { getCurrentWebview } from '@tauri-apps/api/webview';
const size = await getCurrentWebview().size();

Returns

Promise<PhysicalSize>

The webview’s size, in physical pixels.

Remarks

Uses the core:webview:allow-webview-size permission, which is part of core:webview:default.

Inherited from

Webview.size

startDragging()

startDragging(): Promise<void>;

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

Starts dragging the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-start-dragging permission (not included in core:window:default).

Inherited from

Window.startDragging

startResizeDragging()

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

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

Starts resize-dragging the window.

Example

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

Parameters

Parameter	Type
direction	ResizeDirection

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-start-resize-dragging permission (not included in core:window:default).

Inherited from

Window.startResizeDragging

theme()

theme(): Promise<Theme | null>;

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

Gets the window’s current theme.

Platform-specific

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

Example

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

Returns

Promise<Theme | null>

The window theme.

Inherited from

Window.theme

title()

title(): Promise<string>;

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

Gets the window’s current title.

Example

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

Returns

Promise<string>

Inherited from

Window.title

toggleMaximize()

toggleMaximize(): Promise<void>;

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

Toggles the window maximized state.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-toggle-maximize permission (not included in core:window:default).

Inherited from

Window.toggleMaximize

unmaximize()

unmaximize(): Promise<void>;

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

Unmaximizes the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-unmaximize permission (not included in core:window:default).

Inherited from

Window.unmaximize

unminimize()

unminimize(): Promise<void>;

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

Unminimizes the window.

Example

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Remarks

Requires the core:window:allow-unminimize permission (not included in core:window:default).

Inherited from

Window.unminimize

getAll()

static getAll(): Promise<WebviewWindow[]>;

Defined in: packages/api/src/webviewWindow.ts:172

Gets a list of instances of Webview for all available webviews.

Returns

Promise<WebviewWindow[]>

Inherited from

Webview.getAll

getByLabel()

static getByLabel(label: string): Promise<
  | WebviewWindow
| null>;

Defined in: packages/api/src/webviewWindow.ts:152

Gets the Webview for the webview associated with the given label.

Example

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const mainWebview = WebviewWindow.getByLabel('main');

Parameters

Parameter	Type	Description
label	string	The webview label.

Returns

Promise< | WebviewWindow | null>

The Webview instance to communicate with the webview or null if the webview doesn’t exist.

Inherited from

Webview.getByLabel

getCurrent()

static getCurrent(): WebviewWindow;

Defined in: packages/api/src/webviewWindow.ts:165

Get an instance of Webview for the current webview.

Returns

WebviewWindow

Inherited from

Webview.getCurrent

References

Color

Re-exports Color

---

DragDropEvent

Re-exports DragDropEvent