webviewWindow

Classes

WebviewWindow

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

Example

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

const appWindow = new Window('uniqueLabel');

// loading embedded asset:
const webview = new Webview(appWindow, 'theUniqueLabel', {
  url: 'path/to/page.html',
});
// alternatively, load a remote URL:
const webview = new Webview(appWindow, 'theUniqueLabel', {
  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
});

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

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`, `"width"` \| `"height"` \| `"x"` \| `"y"` > & `WindowOptions`	-

Returns

WebviewWindow

The WebviewWindow instance to communicate with the window and webview.

Inherited from

Window.constructor

Source: webviewWindow.ts:74

Properties

Property	Type	Description
`label`	`string`	The webview label. It is a unique identifier for the webview, can be used to reference it later.
`listeners`	`Record`< `string`, `EventCallback`< `any` >[] >	Local event listeners.
`window`	`Window`	The window hosting this webview.

Methods

center()

center(): Promise< void >

Centers the window.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.center

Source: window.ts:801

clearEffects()

clearEffects(): Promise< void >

Clear any applied effects if possible.

Returns

Promise< void >

Inherited from

Window.clearEffects

Source: window.ts:1152

close()

close(): Promise< void >

Closes the webview.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.close

Source: webview.ts:396

destroy()

destroy(): Promise< void >

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

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.destroy

Source: window.ts:1089

emit()

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

Emits an event to all targets.

Example

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

Parameters

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

Returns

Promise< void >

Inherited from

Window.emit

Source: webview.ts:285

emitTo()

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

Emits an event to all targets matching the given target.

Example

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

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`?	`unknown`	Event payload.

Returns

Promise< void >

Inherited from

Window.emitTo

Source: webview.ts:313

hide()

hide(): Promise< void >

Sets the window visibility to false.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.hide

Source: window.ts:1055

innerPosition()

innerPosition(): Promise< PhysicalPosition >

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

Example

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

Returns

Promise< PhysicalPosition >

The window’s inner position.

Inherited from

Window.innerPosition

Source: window.ts:519

innerSize()

innerSize(): Promise< PhysicalSize >

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

Example

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

Returns

Promise< PhysicalSize >

The window’s inner size.

Inherited from

Window.innerSize

Source: window.ts:552

isClosable()

isClosable(): Promise< boolean >

Gets the window’s native close button state.

Platform-specific

iOS / Android: Unsupported.

Example

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

Returns

Promise< boolean >

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

Inherited from

Window.isClosable

Source: window.ts:732

isDecorated()

isDecorated(): Promise< boolean >

Gets the window’s current decorated state.

Example

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

Returns

Promise< boolean >

Whether the window is decorated or not.

Inherited from

Window.isDecorated

Source: window.ts:653

isFocused()

isFocused(): Promise< boolean >

Gets the window’s current focus state.

Example

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

Returns

Promise< boolean >

Whether the window is focused or not.

Inherited from

Window.isFocused

Source: window.ts:637

isFullscreen()

isFullscreen(): Promise< boolean >

Gets the window’s current fullscreen state.

Example

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

Returns

Promise< boolean >

Whether the window is in fullscreen mode or not.

Inherited from

Window.isFullscreen

Source: window.ts:591

isMaximizable()

isMaximizable(): Promise< boolean >

Gets the window’s native maximize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Example

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

Returns

Promise< boolean >

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

Inherited from

Window.isMaximizable

Source: window.ts:690

isMaximized()

isMaximized(): Promise< boolean >

Gets the window’s current maximized state.

Example

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

Returns

Promise< boolean >

Whether the window is maximized or not.

Inherited from

Window.isMaximized

Source: window.ts:621

isMinimizable()

isMinimizable(): Promise< boolean >

Gets the window’s native minimize button state.

Platform-specific

Linux / iOS / Android: Unsupported.

Example

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

Returns

Promise< boolean >

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

Inherited from

Window.isMinimizable

Source: window.ts:711

isMinimized()

isMinimized(): Promise< boolean >

Gets the window’s current minimized state.

Example

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

Returns

Promise< boolean >

Inherited from

Window.isMinimized

Source: window.ts:605

isResizable()

isResizable(): Promise< boolean >

Gets the window’s current resizable state.

Example

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

Returns

Promise< boolean >

Whether the window is resizable or not.

Inherited from

Window.isResizable

Source: window.ts:669

isVisible()

isVisible(): Promise< boolean >

Gets the window’s current visible state.

Example

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

Returns

Promise< boolean >

Whether the window is visible or not.

Inherited from

Window.isVisible

Source: window.ts:748

listen()

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

Listen to an emitted event on this webivew window.

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Type parameters

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. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

Inherited from

Window.listen

Source: webviewWindow.ts:154

maximize()

maximize(): Promise< void >

Maximizes the window.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.maximize

Source: window.ts:959

minimize()

minimize(): Promise< void >

Minimizes the window.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.minimize

Source: window.ts:1007

onCloseRequested()

onCloseRequested(handler): Promise< UnlistenFn >

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

Example

import { getCurrent } from '@tauri-apps/api/window';
import { confirm } from '@tauri-apps/api/dialog';
const unlisten = await getCurrent().onCloseRequested(async (event) => {
  const confirmed = await confirm('Are you sure?');
  if (!confirmed) {
    // user did not confirm closing the window; let's prevent it
    event.preventDefault();
  }
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onCloseRequested

Source: window.ts:1700

onDragDropEvent()

onDragDropEvent(handler): Promise< UnlistenFn >

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

Example

import { getCurrent } from '@tauri-apps/api/webview';
const unlisten = await getCurrent().onDragDropEvent((event) => {
  if (event.payload.type === 'hover') {
    console.log('User hovering', event.payload.paths);
  } else if (event.payload.type === 'drop') {
    console.log('User dropped', event.payload.paths);
  } else {
    console.log('File drop cancelled');
  }
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onDragDropEvent

Source: webview.ts:544

onFocusChanged()

onFocusChanged(handler): Promise< UnlistenFn >

Listen to window focus change.

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onFocusChanged

Source: window.ts:1815

onMoved()

onMoved(handler): Promise< UnlistenFn >

Listen to window move.

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onMoved

Source: window.ts:1670

onResized()

onResized(handler): Promise< UnlistenFn >

Listen to window resize.

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onResized

Source: window.ts:1646

onScaleChanged()

onScaleChanged(handler): Promise< UnlistenFn >

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

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

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onScaleChanged

Source: window.ts:1855

onThemeChanged()

onThemeChanged(handler): Promise< UnlistenFn >

Listen to the system theme change.

Example

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Parameters

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

Returns

Promise< UnlistenFn >

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

Inherited from

Window.onThemeChanged

Source: window.ts:1881

once()

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

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

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Type parameters

Parameter
`T`

Parameters

Parameter	Type	Description
`event`	`string`	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. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.

Inherited from

Window.once

Source: webviewWindow.ts:189

outerPosition()

outerPosition(): Promise< PhysicalPosition >

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

Example

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

Returns

Promise< PhysicalPosition >

The window’s outer position.

Inherited from

Window.outerPosition

Source: window.ts:535

outerSize()

outerSize(): Promise< PhysicalSize >

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

Example

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

Returns

Promise< PhysicalSize >

The window’s outer size.

Inherited from

Window.outerSize

Source: window.ts:572

position()

position(): Promise< PhysicalPosition >

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

Returns

Promise< PhysicalPosition >

The webview’s position.

Inherited from

Webview.position

Source: webview.ts:358

reparent()

reparent(window): Promise< void >

Moves this webview to the given label.

Example

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

Parameters

Parameter	Type
`window`	`string` \| `Window` \| `WebviewWindow`

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Webview.reparent

Source: webview.ts:510

requestUserAttention()

requestUserAttention(requestType): Promise< void >

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

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

Platform-specific

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

Example

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

Parameters

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.requestUserAttention

Source: window.ts:827

scaleFactor()

scaleFactor(): Promise< number >

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

Example

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

Returns

Promise< number >

The window’s monitor scale factor.

Inherited from

Window.scaleFactor

Source: window.ts:503

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise< void >

Whether the window should always be below other windows.

Example

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

Inherited from

Window.setAlwaysOnBottom

Source: window.ts:1188

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise< void >

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

Example

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

Inherited from

Window.setAlwaysOnTop

Source: window.ts:1170

setClosable()

setClosable(closable): Promise< void >

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

Platform-specific

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

Example

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

Parameters

Parameter	Type
`closable`	`boolean`

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setClosable

Source: window.ts:924

setContentProtected()

setContentProtected(protected_): Promise< void >

Prevents the window contents from being captured by other apps.

Example

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

Parameters

Parameter	Type
`protected_`	`boolean`

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setContentProtected

Source: window.ts:1205

setCursorGrab()

setCursorGrab(grab): Promise< void >

Grabs the cursor, preventing it from leaving the window.

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

Platform-specific

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

Example

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

Inherited from

Window.setCursorGrab

Source: window.ts:1449

setCursorIcon()

setCursorIcon(icon): Promise< void >

Modifies the cursor icon of the window.

Example

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

Inherited from

Window.setCursorIcon

Source: window.ts:1491

setCursorPosition()

setCursorPosition(position): Promise< void >

Changes the position of the cursor in window coordinates.

Example

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

Parameters

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setCursorPosition

Source: window.ts:1509

setCursorVisible()

setCursorVisible(visible): Promise< void >

Modifies the cursor’s visibility.

Platform-specific

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

Example

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

Inherited from

Window.setCursorVisible

Source: window.ts:1473

setDecorations()

setDecorations(decorations): Promise< void >

Whether the window should have borders and bars.

Example

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

Inherited from

Window.setDecorations

Source: window.ts:1106

setEffects()

setEffects(effects): Promise< void >

Set window effects.

Parameters

Parameter	Type
`effects`	`Effects`

Returns

Promise< void >

Inherited from

Window.setEffects

Source: window.ts:1142

setFocus()

setFocus(): Promise< void >

Bring the webview to front and focus.

Example

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setFocus

Source: webview.ts:477

setFullscreen()

setFullscreen(fullscreen): Promise< void >

Sets the window fullscreen state.

Example

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

Inherited from

Window.setFullscreen

Source: window.ts:1358

setIcon()

setIcon(icon): Promise< void >

Sets the window icon.

Example

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

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

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

Parameters

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

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setIcon

Source: window.ts:1399

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise< void >

Changes the cursor events behavior.

Example

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

Inherited from

Window.setIgnoreCursorEvents

Source: window.ts:1545

setMaxSize()

setMaxSize(size): Promise< void >

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

Example

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

Parameters

Parameter	Type	Description
`size`	`undefined` \| `null` \| `LogicalSize` \| `PhysicalSize`	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.

Inherited from

Window.setMaxSize

Source: window.ts:1288

setMaximizable()

setMaximizable(maximizable): Promise< void >

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

Platform-specific

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

Example

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

Parameters

Parameter	Type
`maximizable`	`boolean`

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Inherited from

Window.setMaximizable

Source: window.ts:879

setMinSize()

setMinSize(size): Promise< void >

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

Example

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

Parameters

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

setMinimizable(minimizable): Promise< void >

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

Platform-specific

Linux / iOS / Android: Unsupported.

Example

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

Parameters

Parameter	Type
`minimizable`	`boolean`

setPosition(position): Promise< void >

Sets the webview position.

Example

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

Parameters

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

setProgressBar(state): Promise< void >

Sets the taskbar progress state.

Platform-specific

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

Example

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

Parameters

Parameter	Type
`state`	`ProgressBarState`

setResizable(resizable): Promise< void >

Updates the window resizable flag.

Example

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

Parameters

Parameter	Type
`resizable`	`boolean`

setShadow(enable): Promise< void >

Whether or not the window should have shadow.

Platform-specific

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

Example

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

Parameters

Parameter	Type
`enable`	`boolean`

setSize(size): Promise< void >

Resizes the webview.

Example

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

Parameters

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

setSkipTaskbar(skip): Promise< void >

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

Platform-specific

macOS: Unsupported.

Example

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

Parameters

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

setTitle(title): Promise< void >

Sets the window title.

Example

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

Parameters

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

setVisibleOnAllWorkspaces(visible): Promise< void >

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

Platform-specific

Windows / iOS / Android: Unsupported.

Since

2.0.0

Parameters

Parameter	Type
`visible`	`boolean`

setZoom(scaleFactor): Promise< void >

Set webview zoom level.

Example

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

Parameters

Parameter	Type
`scaleFactor`	`number`

show(): Promise< void >

Sets the window visibility to true.

Example

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

size(): Promise< PhysicalSize >

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

startDragging(): Promise< void >

Starts dragging the window.

Example

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

startResizeDragging(direction): Promise< void >

Starts resize-dragging the window.

Example

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

Parameters

Parameter	Type
`direction`	`ResizeDirection`

theme(): Promise< null | Theme >

Gets the window’s current theme.

Platform-specific

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

Example

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

title(): Promise< string >

Gets the window’s current title.

Example

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

toggleMaximize(): Promise< void >

Toggles the window maximized state.

Example

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

unmaximize(): Promise< void >

Unmaximizes the window.

Example

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

unminimize(): Promise< void >

Unminimizes the window.

Example

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

static getAll(): WebviewWindow[]

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

static getByLabel(label): null | WebviewWindow

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

Example

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

Parameters

Parameter	Type	Description
`label`	`string`	The webview label.

static getCurrent(): WebviewWindow

Get an instance of Webview for the current webview.

getAll(): WebviewWindow[]

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

getCurrent(): WebviewWindow

Get an instance of Webview for the current webview window.

Since

2.0.0

Returns

WebviewWindow

Source: webviewWindow.ts:23