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.

Classes

WebviewWindow

Sources: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L82, https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L85

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

Constructor

new WebviewWindow(label, options?): WebviewWindow;

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

Creates a new Window hosting a 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.

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

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`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L86
`listeners`	`Record`<`string`, `EventCallback`<`any`>[]>	Local event listeners.	`Webview`.`listeners`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L89
`window`	`Window`	The window hosting this webview.	`Webview`.`window`	Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L211

Methods

activityName()

activityName(): Promise<string>;

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

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.

Returns

Promise<string>

The activity name.

Example

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

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

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

Centers the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.center

clearAllBrowsingData()

clearAllBrowsingData(): Promise<void>;

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

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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

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

Clear any applied effects if possible.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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

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

Closes the webview.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Webview.close

destroy()

destroy(): Promise<void>;

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

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.destroy

emit()

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

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

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

Promise<void>

Example

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

Inherited from

Webview.emit

emitTo()

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

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

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

Promise<void>

Example

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

Inherited from

Webview.emitTo

hide()

hide(): Promise<void>;

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

Hide the webview.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Webview.hide

innerPosition()

innerPosition(): Promise<PhysicalPosition>;

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

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

Returns

Promise<PhysicalPosition>

The window’s inner position.

Example

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

Inherited from

Window.innerPosition

innerSize()

innerSize(): Promise<PhysicalSize>;

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

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

Inherited from

Window.innerSize

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>;

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

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

Returns

Promise<boolean>

Whether the window is visible or not.

Example

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

Inherited from

Window.isAlwaysOnTop

isClosable()

isClosable(): Promise<boolean>;

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

Gets the window’s native close button state.

Platform-specific

iOS / Android: Unsupported.

Returns

Promise<boolean>

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

Example

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

Inherited from

Window.isClosable

isDecorated()

isDecorated(): Promise<boolean>;

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

Gets the window’s current decorated state.

Returns

Promise<boolean>

Whether the window is decorated or not.

Example

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

Inherited from

Window.isDecorated

isEnabled()

isEnabled(): Promise<boolean>;

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

Whether the window is enabled or disabled.

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

Returns

Promise<boolean>

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

Example

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

Since

2.0.0

Inherited from

Window.isEnabled

isFocused()

isFocused(): Promise<boolean>;

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

Gets the window’s current focus state.

Returns

Promise<boolean>

Whether the window is focused or not.

Example

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

Inherited from

Window.isFocused

isFullscreen()

isFullscreen(): Promise<boolean>;

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

Gets the window’s current fullscreen state.

Returns

Promise<boolean>

Whether the window is in fullscreen mode or not.

Example

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

Inherited from

Window.isFullscreen

isMaximizable()

isMaximizable(): Promise<boolean>;

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

Gets the window’s native maximize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Returns

Promise<boolean>

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

Example

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

Inherited from

Window.isMaximizable

isMaximized()

isMaximized(): Promise<boolean>;

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

Gets the window’s current maximized state.

Returns

Promise<boolean>

Whether the window is maximized or not.

Example

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

Inherited from

Window.isMaximized

isMinimizable()

isMinimizable(): Promise<boolean>;

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

Gets the window’s native minimize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Returns

Promise<boolean>

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

Example

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

Inherited from

Window.isMinimizable

isMinimized()

isMinimized(): Promise<boolean>;

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

Gets the window’s current minimized state.

Returns

Promise<boolean>

Example

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

Inherited from

Window.isMinimized

isResizable()

isResizable(): Promise<boolean>;

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

Gets the window’s current resizable state.

Returns

Promise<boolean>

Whether the window is resizable or not.

Example

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

Inherited from

Window.isResizable

isVisible()

isVisible(): Promise<boolean>;

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

Gets the window’s current visible state.

Returns

Promise<boolean>

Whether the window is visible or not.

Example

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

Inherited from

Window.isVisible

listen()

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

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

Listen to an emitted event on this webview 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

Promise<UnlistenFn>

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

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

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

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

Maximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.maximize

minimize()

minimize(): Promise<void>;

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

Minimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.minimize

once()

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

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

Listen to an emitted event on this webview 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

Promise<UnlistenFn>

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

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

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): Promise<UnlistenFn>;

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

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

Parameters

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

Returns

Promise<UnlistenFn>

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

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

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): Promise<UnlistenFn>;

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

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

Promise<UnlistenFn>

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

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.

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): Promise<UnlistenFn>;

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

Listen to window focus change.

Parameters

Parameter	Type
`handler`	`EventCallback`<`boolean`>

Returns

Promise<UnlistenFn>

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

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

Remarks

Inherited from

Window.onFocusChanged

onMoved()

onMoved(handler): Promise<UnlistenFn>;

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

Listen to window move.

Parameters

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

Returns

Promise<UnlistenFn>

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

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

Remarks

Inherited from

Window.onMoved

onResized()

onResized(handler): Promise<UnlistenFn>;

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

Listen to window resize.

Parameters

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

Returns

Promise<UnlistenFn>

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

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

Remarks

Inherited from

Window.onResized

onScaleChanged()

onScaleChanged(handler): Promise<UnlistenFn>;

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

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

Promise<UnlistenFn>

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

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

Remarks

Inherited from

Window.onScaleChanged

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>;

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

Listen to the system theme change.

Parameters

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

Returns

Promise<UnlistenFn>

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

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

Remarks

Inherited from

Window.onThemeChanged

outerPosition()

outerPosition(): Promise<PhysicalPosition>;

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

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

Returns

Promise<PhysicalPosition>

The window’s outer position.

Example

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

Inherited from

Window.outerPosition

outerSize()

outerSize(): Promise<PhysicalSize>;

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

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

Inherited from

Window.outerSize

position()

position(): Promise<PhysicalPosition>;

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

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

Returns

Promise<PhysicalPosition>

The webview’s position, in physical pixels.

Example

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

Remarks

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

Inherited from

Webview.position

reparent()

reparent(window): Promise<void>;

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

Moves this webview to the window with the given label.

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.

Example

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

Remarks

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

Inherited from

Webview.reparent

requestUserAttention()

requestUserAttention(requestType): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.requestUserAttention

scaleFactor()

scaleFactor(): Promise<number>;

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

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

Inherited from

Window.scaleFactor

sceneIdentifier()

sceneIdentifier(): Promise<string>;

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

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.

Returns

Promise<string>

The scene identifier.

Example

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

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): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setAlwaysOnBottom

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setAlwaysOnTop

setAutoResize()

setAutoResize(autoResize): Promise<void>;

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

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

Parameters

Parameter	Type
`autoResize`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Webview.setAutoResize

setBackgroundColor()

setBackgroundColor(color): Promise<void>;

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

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.

Parameters

Parameter	Type	Description
`color`	`Color`	The new background color.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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?): Promise<void>;

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

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

Platform-specific

Windows: Unsupported. Use Window.setOverlayIcon instead.

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.

Example

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

Remarks

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

Inherited from

Window.setBadgeCount

setBadgeLabel()

setBadgeLabel(label?): Promise<void>;

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

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.

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.

Example

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

Remarks

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

Inherited from

Window.setBadgeLabel

setClosable()

setClosable(closable): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setClosable

setContentProtected()

setContentProtected(protected_): Promise<void>;

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

Prevents the window contents from being captured by other apps.

Parameters

Parameter	Type
`protected_`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setContentProtected

setCursorGrab()

setCursorGrab(grab): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setCursorGrab

setCursorIcon()

setCursorIcon(icon): Promise<void>;

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

Modifies the cursor icon of the window.

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setCursorIcon

setCursorPosition()

setCursorPosition(position): Promise<void>;

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

Changes the position of the cursor in window coordinates.

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.

Example

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

Remarks

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

Inherited from

Window.setCursorPosition

setCursorVisible()

setCursorVisible(visible): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setCursorVisible

setDecorations()

setDecorations(decorations): Promise<void>;

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

Whether the window should have borders and bars.

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.

Example

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

Remarks

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

Inherited from

Window.setDecorations

setEffects()

setEffects(effects): Promise<void>;

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

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.

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.

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

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): Promise<void>;

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

Enable or disable the window.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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

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

Bring the webview to front and focus.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Webview.setFocus

setFocusable()

setFocusable(focusable): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setFocusable

setFullscreen()

setFullscreen(fullscreen): Promise<void>;

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

Sets the window fullscreen state.

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.

Example

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

Remarks

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

Inherited from

Window.setFullscreen

setFullscreenOnMonitor()

setFullscreenOnMonitor(position): Promise<void>;

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

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

Does nothing if no monitor contains the 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.

Example

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

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): Promise<void>;

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

Sets the window icon.

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.

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

Remarks

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

Inherited from

Window.setIcon

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>;

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

Changes the cursor events behavior.

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.

Example

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

Remarks

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

Inherited from

Window.setIgnoreCursorEvents

setMaximizable()

setMaximizable(maximizable): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setMaximizable

setMaxSize()

setMaxSize(size): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setMaxSize

setMinimizable()

setMinimizable(minimizable): Promise<void>;

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

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

Platform-specific

Linux / iOS / Android: Unsupported.

Parameters

Parameter	Type
`minimizable`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setMinimizable

setMinSize()

setMinSize(size): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setMinSize

setOverlayIcon()

setOverlayIcon(icon?): Promise<void>;

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

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?`	`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.

Example

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

Remarks

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

Inherited from

Window.setOverlayIcon

setPosition()

setPosition(position): Promise<void>;

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

Sets the webview position.

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.

Example

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

Remarks

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

Inherited from

Webview.setPosition

setProgressBar()

setProgressBar(state): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setProgressBar

setResizable()

setResizable(resizable): Promise<void>;

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

Updates the window resizable flag.

Parameters

Parameter	Type
`resizable`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setResizable

setShadow()

setShadow(enable): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setShadow

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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): Promise<void>;

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

Resizes the webview.

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.

Example

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

Remarks

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

Inherited from

Webview.setSize

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>;

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

Sets the window inner size constraints.

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.

Example

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

Remarks

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

Inherited from

Window.setSizeConstraints

setSkipTaskbar()

setSkipTaskbar(skip): Promise<void>;

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

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

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setSkipTaskbar

setTheme()

setTheme(theme?): Promise<void>;

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

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.

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.

Example

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

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): Promise<void>;

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

Sets the window title.

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.setTitle

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>;

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

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.

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.

Example

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

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): Promise<void>;

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

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

Platform-specific

Windows / iOS / Android: Unsupported.

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.

Example

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

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): Promise<void>;

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

Set webview zoom level.

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.

Example

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

Remarks

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

Inherited from

Webview.setZoom

show()

show(): Promise<void>;

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

Show the webview.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Webview.show

size()

size(): Promise<PhysicalSize>;

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

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

Returns

Promise<PhysicalSize>

The webview’s size, in physical pixels.

Example

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

Remarks

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

Inherited from

Webview.size

startDragging()

startDragging(): Promise<void>;

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

Starts dragging the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.startDragging

startResizeDragging()

startResizeDragging(direction): Promise<void>;

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

Starts resize-dragging the window.

Parameters

Parameter	Type
`direction`	`ResizeDirection`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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

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

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

Inherited from

Window.theme

title()

title(): Promise<string>;

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

Gets the window’s current title.

Returns

Promise<string>

Example

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

Inherited from

Window.title

toggleMaximize()

toggleMaximize(): Promise<void>;

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

Toggles the window maximized state.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.toggleMaximize

unmaximize()

unmaximize(): Promise<void>;

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

Unmaximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.unmaximize

unminimize()

unminimize(): Promise<void>;

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

Unminimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Remarks

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

Inherited from

Window.unminimize

getAll()

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

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

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

Returns

Promise<WebviewWindow[]>

Inherited from

Webview.getAll

getByLabel()

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

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

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

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.

Example

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

Inherited from

Webview.getByLabel

getCurrent()

static getCurrent(): WebviewWindow;

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

Get an instance of Webview for the current webview.

Returns

WebviewWindow

Inherited from

Webview.getCurrent

Functions

getAllWebviewWindows()

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

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

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;

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

Get an instance of Webview for the current webview window.

Returns

WebviewWindow

Since

2.0.0

References

Color

Re-exports Color

DragDropEvent

Re-exports DragDropEvent

Support on Open Collective Sponsor on GitHub

webviewWindow

Remarks

Classes

WebviewWindow

Requires the unstable Cargo feature

Example

Since

Extends

Constructors

Constructor

Parameters

Returns

Example

Remarks

Inherited from

Properties

Methods

activityName()

Returns

Example

Remarks

Since

Inherited from

center()

Returns

Example

Remarks

Inherited from

clearAllBrowsingData()

Returns

Example

Remarks

Inherited from

clearEffects()

Returns

Example

Remarks

Since

Inherited from

close()

Returns

Example

Remarks

Inherited from

destroy()

Returns

Example

Remarks

Inherited from

emit()

Type Parameters

Parameters

Returns

Example

Inherited from

emitTo()

Type Parameters

Parameters

Returns

Example

Inherited from

hide()

Returns

Example

Remarks

Inherited from

innerPosition()

Returns

Example

Inherited from

innerSize()

Returns

Example

Inherited from

isAlwaysOnTop()

Returns

Example

Inherited from

isClosable()

Returns

Requires the `unstable` Cargo feature