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

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

Hierarchy (View Summary)

Webview
Window
- WebviewWindow

Index

Constructors

constructor

new WebviewWindow(
label: string,
options?: Omit<WebviewOptions, "width" | "height" | "x" | "y"> & WindowOptions,
): WebviewWindow
Creates a new Window hosting a Webview.
Parameters
- 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.
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
});
```
Inherited from Window.constructor
- Defined in webviewWindow.ts:75

Properties

window

window: Window

The window hosting this webview.

label

label: string

The webview label. It is a unique identifier for the webview, can be used to reference it later.

listeners

listeners: Record<string, EventCallback<any>[]>

Local event listeners.

Methods

emit

emit<T>(event: string, payload?: T): Promise<void>
Emits an event to all targets.
Type Parameters
- T
Parameters
- event: string
  Event name. Must include only alphanumeric characters, -, /, : and _.
- Optionalpayload: 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 Window.emit
- Defined in webview.ts:324

emitTo

emitTo<T>(
    target: string | EventTarget,
    event: string,
    payload?: T,
): Promise<void>
Emits an event to all targets matching the given target.
Type Parameters
- T
Parameters
- target: string | EventTarget
  Label of the target Window/Webview/WebviewWindow or raw EventTarget object.
- event: string
  Event name. Must include only alphanumeric characters, -, /, : and _.
- Optionalpayload: 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 Window.emitTo
- Defined in webview.ts:352

position

position(): Promise<dpi.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.

Returns Promise<dpi.PhysicalPosition>
The webview's position.
Example
```
import { getCurrentWebview } from '@tauri-apps/api/webview';
const position = await getCurrentWebview().position();
```
Inherited from Webview.position
- Defined in webview.ts:397

size

size(): Promise<dpi.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.

Returns Promise<dpi.PhysicalSize>
The webview's size.
Example
```
import { getCurrentWebview } from '@tauri-apps/api/webview';
const size = await getCurrentWebview().size();
```
Inherited from Webview.size
- Defined in webview.ts:414

close

close(): Promise<void>
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();
```
Inherited from Window.close
- Defined in webview.ts:435

setSize

setSize(size: dpi.LogicalSize | dpi.PhysicalSize | Size): Promise<void>
Resizes the webview.
Parameters
- size: dpi.LogicalSize | dpi.PhysicalSize | Size
  The logical or physical size.
Returns Promise<void>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrent, LogicalSize } from '@tauri-apps/api/webview';
await getCurrentWebview().setSize(new LogicalSize(600, 500));
```
Inherited from Window.setSize
- Defined in webview.ts:452

setPosition

setPosition(
position: dpi.LogicalPosition | dpi.PhysicalPosition | Position,
): Promise<void>
Sets the webview position.
Parameters
- position: dpi.LogicalPosition | dpi.PhysicalPosition | Position
  The new position, in logical or physical pixels.
Returns Promise<void>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrent, LogicalPosition } from '@tauri-apps/api/webview';
await getCurrentWebview().setPosition(new LogicalPosition(600, 500));
```
Inherited from Window.setPosition
- Defined in webview.ts:470

setFocus

setFocus(): Promise<void>
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();
```
Inherited from Window.setFocus
- Defined in webview.ts:489

setAutoResize

setAutoResize(autoResize: boolean): Promise<void>
Sets whether the webview should automatically grow and shrink its size and position when the parent window resizes.
Parameters
- 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);
```
Inherited from Webview.setAutoResize
- Defined in webview.ts:505

hide

hide(): Promise<void>
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();
```
Inherited from Window.hide
- Defined in webview.ts:522

show

show(): Promise<void>
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();
```
Inherited from Window.show
- Defined in webview.ts:538

setZoom

setZoom(scaleFactor: number): Promise<void>
Set webview zoom level.
Parameters
- scaleFactor: number
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);
```
Inherited from Webview.setZoom
- Defined in webview.ts:554

reparent

reparent(window: string | Window | WebviewWindow): Promise<void>
Moves this webview to the given label.
Parameters
- window: string | Window | WebviewWindow
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');
```
Inherited from Webview.reparent
- Defined in webview.ts:571

clearAllBrowsingData

clearAllBrowsingData(): Promise<void>
Clears all browsing data for this webview.

Returns Promise<void>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().clearAllBrowsingData();
```
Inherited from Webview.clearAllBrowsingData
- Defined in webview.ts:588

onDragDropEvent

onDragDropEvent(
handler: EventCallback<webview.DragDropEvent>,
): Promise<UnlistenFn>
Listen to a file drop event. The listener is triggered when the user hovers the selected files on the webview, drops the files or cancels the operation.
Parameters
- handler: EventCallback<webview.DragDropEvent>
Returns Promise<UnlistenFn>
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
```
import { 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');
 }
});

// you need to call unlisten if 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.
Inherited from Window.onDragDropEvent
- Defined in webview.ts:640

`Static`getByLabel

getByLabel(label: string): Promise<null | WebviewWindow>
Gets the Webview for the webview associated with the given label.
Parameters
- label: string
  The webview label.
Returns Promise<null | WebviewWindow>
The Webview instance to communicate with the webview or null if the webview doesn't exist.
Example
```
import { Webview } from '@tauri-apps/api/webviewWindow';
const mainWebview = Webview.getByLabel('main');
```
Inherited from Window.getByLabel
- Defined in webviewWindow.ts:112

`Static`getCurrent

getCurrent(): WebviewWindow
Get an instance of Webview for the current webview.

Returns WebviewWindow
Inherited from Window.getCurrent
- Defined in webviewWindow.ts:125

`Static`getAll

getAll(): Promise<WebviewWindow[]>
Gets a list of instances of Webview for all available webviews.

Returns Promise<WebviewWindow[]>
Inherited from Window.getAll
- Defined in webviewWindow.ts:132

listen

listen<T>(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>
Listen to an emitted event on this webivew window.
Type Parameters
- T
Parameters
- 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.
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();
```
Inherited from Window.listen
- Defined in webviewWindow.ts:155

once

once<T>(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>
Listen to an emitted event on this webview window only once.
Type Parameters
- T
Parameters
- 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.
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();
```
Inherited from Window.once
- Defined in webviewWindow.ts:190

setBackgroundColor

setBackgroundColor(color: webview.Color): Promise<void>
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
- color: webview.Color
Returns Promise<void>
A promise indicating the success or failure of the operation.

Since
2.1.0
Inherited from Window.setBackgroundColor
- Defined in webviewWindow.ts:222

scaleFactor

scaleFactor(): Promise<number>
The scale factor that can be used to map physical pixels to logical pixels.

Returns Promise<number>
The window's monitor scale factor.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const factor = await getCurrentWindow().scaleFactor();
```
Inherited from Window.scaleFactor
- Defined in window.ts:521

innerPosition

innerPosition(): Promise<dpi.PhysicalPosition>
The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop.

Returns Promise<dpi.PhysicalPosition>
The window's inner position.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const position = await getCurrentWindow().innerPosition();
```
Inherited from Window.innerPosition
- Defined in window.ts:537

outerPosition

outerPosition(): Promise<dpi.PhysicalPosition>
The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

Returns Promise<dpi.PhysicalPosition>
The window's outer position.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const position = await getCurrentWindow().outerPosition();
```
Inherited from Window.outerPosition
- Defined in window.ts:553

innerSize

innerSize(): Promise<dpi.PhysicalSize>
The physical size of the window's client area. The client area is the content of the window, excluding the title bar and borders.

Returns Promise<dpi.PhysicalSize>
The window's inner size.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const size = await getCurrentWindow().innerSize();
```
Inherited from Window.innerSize
- Defined in window.ts:570

outerSize

outerSize(): Promise<dpi.PhysicalSize>
The physical size of the entire window. These dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead.

Returns Promise<dpi.PhysicalSize>
The window's outer size.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const size = await getCurrentWindow().outerSize();
```
Inherited from Window.outerSize
- Defined in window.ts:590

isFullscreen

isFullscreen(): Promise<boolean>
Gets the window's current fullscreen state.

Returns Promise<boolean>
Whether the window is in fullscreen mode or not.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const fullscreen = await getCurrentWindow().isFullscreen();
```
Inherited from Window.isFullscreen
- Defined in window.ts:609

isMinimized

isMinimized(): Promise<boolean>
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
- Defined in window.ts:623

isMaximized

isMaximized(): Promise<boolean>
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
- Defined in window.ts:639

isFocused

isFocused(): Promise<boolean>
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
- Defined in window.ts:655

isDecorated

isDecorated(): Promise<boolean>
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
- Defined in window.ts:671

isResizable

isResizable(): Promise<boolean>
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
- Defined in window.ts:687

isMaximizable

isMaximizable(): Promise<boolean>
Gets the window's native maximize button state.

Platform-specific
- Linux / iOS / Android: Unsupported.
Returns Promise<boolean>
Whether the window's native maximize button is enabled or not.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const maximizable = await getCurrentWindow().isMaximizable();
```
Inherited from Window.isMaximizable
- Defined in window.ts:708

isMinimizable

isMinimizable(): Promise<boolean>
Gets the window's native minimize button state.

Platform-specific
- Linux / iOS / Android: Unsupported.
Returns Promise<boolean>
Whether the window's native minimize button is enabled or not.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const minimizable = await getCurrentWindow().isMinimizable();
```
Inherited from Window.isMinimizable
- Defined in window.ts:729

isClosable

isClosable(): Promise<boolean>
Gets the window's native close button state.

Platform-specific
- iOS / Android: Unsupported.
Returns Promise<boolean>
Whether the window's native close button is enabled or not.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const closable = await getCurrentWindow().isClosable();
```
Inherited from Window.isClosable
- Defined in window.ts:750

isVisible

isVisible(): Promise<boolean>
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
- Defined in window.ts:766

title

title(): Promise<string>
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
- Defined in window.ts:780

theme

theme(): Promise<null | Theme>
Gets the window's current theme.

Platform-specific
- macOS: Theme was introduced on macOS 10.14. Returns light on macOS 10.13 and below.
Returns Promise<null | Theme>
The window theme.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
const theme = await getCurrentWindow().theme();
```
Inherited from Window.theme
- Defined in window.ts:801

isAlwaysOnTop

isAlwaysOnTop(): Promise<boolean>
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
- Defined in window.ts:817

center

center(): Promise<void>
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();
```
Inherited from Window.center
- Defined in window.ts:835

requestUserAttention

requestUserAttention(requestType: null | UserAttentionType): Promise<void>
Requests user attention to the window, this has no effect if the application is already focused. How requesting for user attention manifests is platform dependent, see UserAttentionType for details.

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

Platform-specific
- macOS: null has no effect.
- Linux: Urgency levels have the same effect.
Parameters
- requestType: null | UserAttentionType
Returns Promise<void>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().requestUserAttention();
```
Inherited from Window.requestUserAttention
- Defined in window.ts:861

setResizable

setResizable(resizable: boolean): Promise<void>
Updates the window resizable flag.
Parameters
- 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);
```
Inherited from Window.setResizable
- Defined in window.ts:889

setEnabled

setEnabled(enabled: boolean): Promise<void>
Enable or disable the window.
Parameters
- 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);
```
Since
2.0.0
Inherited from Window.setEnabled
- Defined in window.ts:908

isEnabled

isEnabled(): Promise<boolean>
Whether the window is enabled or disabled.

Returns Promise<boolean>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setEnabled(false);
```
Since
2.0.0
Inherited from Window.isEnabled
- Defined in window.ts:927

setMaximizable

setMaximizable(maximizable: boolean): Promise<void>
Sets whether the window's native maximize button is enabled or not. If resizable is set to false, this setting is ignored.

Platform-specific
- macOS: Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode.
- Linux / iOS / Android: Unsupported.
Parameters
- 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);
```
Inherited from Window.setMaximizable
- Defined in window.ts:950

setMinimizable

setMinimizable(minimizable: boolean): Promise<void>
Sets whether the window's native minimize button is enabled or not.

Platform-specific
- Linux / iOS / Android: Unsupported.
Parameters
- 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);
```
Inherited from Window.setMinimizable
- Defined in window.ts:972

setClosable

setClosable(closable: boolean): Promise<void>
Sets whether the window's native close button is enabled or not.

Platform-specific
- Linux: GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible
- iOS / Android: Unsupported.
Parameters
- 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);
```
Inherited from Window.setClosable
- Defined in window.ts:995

setTitle

setTitle(title: string): Promise<void>
Sets the window title.
Parameters
- 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');
```
Inherited from Window.setTitle
- Defined in window.ts:1013

maximize

maximize(): Promise<void>
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();
```
Inherited from Window.maximize
- Defined in window.ts:1030

unmaximize

unmaximize(): Promise<void>
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();
```
Inherited from Window.unmaximize
- Defined in window.ts:1046

toggleMaximize

toggleMaximize(): Promise<void>
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();
```
Inherited from Window.toggleMaximize
- Defined in window.ts:1062

minimize

minimize(): Promise<void>
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();
```
Inherited from Window.minimize
- Defined in window.ts:1078

unminimize

unminimize(): Promise<void>
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();
```
Inherited from Window.unminimize
- Defined in window.ts:1094

destroy

destroy(): Promise<void>
Destroys the window. Behaves like Window.close but forces the window close instead of emitting a closeRequested event.

Returns Promise<void>
A promise indicating the success or failure of the operation.
Example
```
import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().destroy();
```
Inherited from Window.destroy
- Defined in window.ts:1160

setDecorations

setDecorations(decorations: boolean): Promise<void>
Whether the window should have borders and bars.
Parameters
- 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);
```
Inherited from Window.setDecorations
- Defined in window.ts:1177

setShadow

setShadow(enable: boolean): 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 undecorated window have a 1px white border, and on Windows 11, it will have a rounded corners.
- Linux: Unsupported.
Parameters
- 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);
```
Inherited from Window.setShadow
- Defined in window.ts:1203

setEffects

setEffects(effects: Effects): Promise<void>
Set window effects.
Parameters
- effects: Effects
Returns Promise<void>
Inherited from Window.setEffects
- Defined in window.ts:1213

clearEffects

clearEffects(): Promise<void>
Clear any applied effects if possible.

Returns Promise<void>
Inherited from Window.clearEffects
- Defined in window.ts:1223

setAlwaysOnTop

setAlwaysOnTop(alwaysOnTop: boolean): Promise<void>
Whether the window should always be on top of other windows.
Parameters
- 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);
```
Inherited from Window.setAlwaysOnTop
- Defined in window.ts:1241

setAlwaysOnBottom

setAlwaysOnBottom(alwaysOnBottom: boolean): Promise<void>
Whether the window should always be below other windows.
Parameters
- 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);
```
Inherited from Window.setAlwaysOnBottom
- Defined in window.ts:1259

setContentProtected

setContentProtected(protected_: boolean): Promise<void>
Prevents the window contents from being captured by other apps.
Parameters
- 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);
```
Inherited from Window.setContentProtected
- Defined in window.ts:1276

setMinSize

setMinSize(
size: undefined | null | dpi.LogicalSize | dpi.PhysicalSize | Size,
): Promise<void>
Sets the window minimum inner size. If the size argument is not provided, the constraint is unset.
Parameters
- size: undefined | null | dpi.LogicalSize | dpi.PhysicalSize | Size
  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));
```
Inherited from Window.setMinSize
- Defined in window.ts:1312

setMaxSize

setMaxSize(
size: undefined | null | dpi.LogicalSize | dpi.PhysicalSize | Size,
): Promise<void>
Sets the window maximum inner size. If the size argument is undefined, the constraint is unset.
Parameters
- size: undefined | null | dpi.LogicalSize | dpi.PhysicalSize | Size
  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));
```
Inherited from Window.setMaxSize
- Defined in window.ts:1332

setSizeConstraints

setSizeConstraints(
constraints: undefined | null | WindowSizeConstraints,
): Promise<void>
Sets the window inner size constraints.
Parameters
- constraints: undefined | null | WindowSizeConstraints
  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 } from '@tauri-apps/api/window';
await getCurrentWindow().setSizeConstraints({ minWidth: 300 });
```
Inherited from Window.setSizeConstraints
- Defined in window.ts:1352

setFullscreen

setFullscreen(fullscreen: boolean): Promise<void>
Sets the window fullscreen state.
Parameters
- 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);
```
Inherited from Window.setFullscreen
- Defined in window.ts:1401

setIcon

setIcon(
    icon:
        | string
        | number[]
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Image,
): Promise<void>
Sets the window icon.
Parameters
- icon: string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image
  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"] }
```
Inherited from Window.setIcon
- Defined in window.ts:1442

setSkipTaskbar

setSkipTaskbar(skip: boolean): Promise<void>
Whether the window icon should be hidden from the taskbar or not.

Platform-specific
- macOS: Unsupported.
Parameters
- 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);
```
Inherited from Window.setSkipTaskbar
- Defined in window.ts:1466

setCursorGrab

setCursorGrab(grab: boolean): Promise<void>
Grabs the cursor, preventing it from leaving the window.

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

Platform-specific
- Linux: Unsupported.
- macOS: This locks the cursor in a fixed location, which looks visually awkward.
Parameters
- 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);
```
Inherited from Window.setCursorGrab
- Defined in window.ts:1492

setCursorVisible

setCursorVisible(visible: boolean): Promise<void>
Modifies the cursor's visibility.

Platform-specific
- Windows: The cursor is only hidden within the confines of the window.
- macOS: The cursor is hidden as long as the window has input focus, even if the cursor is outside of the window.
Parameters
- 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);
```
Inherited from Window.setCursorVisible
- Defined in window.ts:1516

setCursorIcon

setCursorIcon(icon: CursorIcon): Promise<void>
Modifies the cursor icon of the window.
Parameters
- 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');
```
Inherited from Window.setCursorIcon
- Defined in window.ts:1534

setCursorPosition

setCursorPosition(
position: dpi.LogicalPosition | dpi.PhysicalPosition | Position,
): Promise<void>
Changes the position of the cursor in window coordinates.
Parameters
- position: dpi.LogicalPosition | dpi.PhysicalPosition | 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));
```
Inherited from Window.setCursorPosition
- Defined in window.ts:1568

setIgnoreCursorEvents

setIgnoreCursorEvents(ignore: boolean): Promise<void>
Changes the cursor events behavior.
Parameters
- 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);
```
Inherited from Window.setIgnoreCursorEvents
- Defined in window.ts:1589

startDragging

startDragging(): Promise<void>
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();
```
Inherited from Window.startDragging
- Defined in window.ts:1606

startResizeDragging

startResizeDragging(direction: ResizeDirection): Promise<void>
Starts resize-dragging the window.
Parameters
- 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();
```
Inherited from Window.startResizeDragging
- Defined in window.ts:1622

setBadgeCount

setBadgeCount(count?: number): Promise<void>
Sets the badge count. It is app wide and not specific to this window.

Platform-specific
- Windows: Unsupported. Use @{linkcode Window.setOverlayIcon} instead.
Parameters
- Optionalcount: 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);
```
Inherited from Window.setBadgeCount
- Defined in window.ts:1645

setBadgeLabel

setBadgeLabel(label?: string): Promise<void>
Sets the badge cont macOS only.
Parameters
- Optionallabel: 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");
```
Inherited from Window.setBadgeLabel
- Defined in window.ts:1664

setOverlayIcon

setOverlayIcon(
    icon?:
        | string
        | number[]
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Image,
): Promise<void>
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
- Optionalicon: string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image
  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");
```
Inherited from Window.setOverlayIcon
- Defined in window.ts:1693

setProgressBar

setProgressBar(state: ProgressBarState): Promise<void>
Sets the taskbar progress state.

Platform-specific
- Linux / macOS: Progress bar is app-wide and not specific to this window.
- Linux: Only supported desktop environments with libunity (e.g. GNOME).
Parameters
- 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,
});
```
Inherited from Window.setProgressBar
- Defined in window.ts:1721

setVisibleOnAllWorkspaces

setVisibleOnAllWorkspaces(visible: boolean): Promise<void>
Sets whether the window should be visible on all workspaces or virtual desktops.

Platform-specific
- Windows / iOS / Android: Unsupported.
Parameters
- visible: boolean
Returns Promise<void>
Since
2.0.0
Inherited from Window.setVisibleOnAllWorkspaces
- Defined in window.ts:1737

setTitleBarStyle

setTitleBarStyle(style: TitleBarStyle): Promise<void>
Sets the title bar style. macOS only.
Parameters
- style: TitleBarStyle
Returns Promise<void>
Since
2.0.0
Inherited from Window.setTitleBarStyle
- Defined in window.ts:1749

setTheme

setTheme(theme?: null | Theme): Promise<void>
Set window theme, pass in null or undefined to follow system theme

Platform-specific
- Linux / macOS: Theme is app-wide and not specific to this window.
- iOS / Android: Unsupported.
Parameters
- Optionaltheme: null | Theme
Returns Promise<void>
Since
2.0.0
Inherited from Window.setTheme
- Defined in window.ts:1766

onResized

onResized(handler: EventCallback<dpi.PhysicalSize>): Promise<UnlistenFn>
Listen to window resize.
Parameters
- handler: EventCallback<dpi.PhysicalSize>
Returns Promise<UnlistenFn>
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onResized(({ payload: size }) => {
 console.log('Window resized', size);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onResized
- Defined in window.ts:1792

onMoved

onMoved(handler: EventCallback<dpi.PhysicalPosition>): Promise<UnlistenFn>
Listen to window move.
Parameters
- handler: EventCallback<dpi.PhysicalPosition>
Returns Promise<UnlistenFn>
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onMoved(({ payload: position }) => {
 console.log('Window moved', position);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onMoved
- Defined in window.ts:1816

onCloseRequested

onCloseRequested(
handler: (event: CloseRequestedEvent) => void | Promise<void>,
): Promise<UnlistenFn>
Listen to window close requested. Emitted when the user requests to closes the window.
Parameters
- handler: (event: CloseRequestedEvent) => void | Promise<void>
Returns Promise<UnlistenFn>
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
import { confirm } from '@tauri-apps/api/dialog';
const unlisten = await getCurrentWindow().onCloseRequested(async (event) => {
  const confirmed = await confirm('Are you sure?');
  if (!confirmed) {
    // user did not confirm closing the window; let's prevent it
    event.preventDefault();
  }
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onCloseRequested
- Defined in window.ts:1845

onFocusChanged

onFocusChanged(handler: EventCallback<boolean>): Promise<UnlistenFn>
Listen to window focus change.
Parameters
- 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.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onFocusChanged(({ payload: focused }) => {
 console.log('Focus changed, window is focused? ' + focused);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onFocusChanged
- Defined in window.ts:1961

onScaleChanged

onScaleChanged(handler: EventCallback<ScaleFactorChanged>): Promise<UnlistenFn>
Listen to window scale change. Emitted when the window's scale factor has changed. The following user actions can cause DPI changes:
- Changing the display's resolution.
- Changing the display's scale factor (e.g. in Control Panel on Windows).
- Moving the window to a display with a different scale factor.
Parameters
- 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.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onScaleChanged(({ payload }) => {
 console.log('Scale changed', payload.scaleFactor, payload.size);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onScaleChanged
- Defined in window.ts:2001

onThemeChanged

onThemeChanged(handler: EventCallback<Theme>): Promise<UnlistenFn>
Listen to the system theme change.
Parameters
- 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.
Example
```
import { getCurrentWindow } from "@tauri-apps/api/window";
const unlisten = await getCurrentWindow().onThemeChanged(({ payload: theme }) => {
 console.log('New theme: ' + theme);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();
```
Inherited from Window.onThemeChanged
- Defined in window.ts:2027

Class WebviewWindow

Example

Since

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebviewWindow

Example

Properties

window

label

listeners

Methods

emit

Type Parameters

Parameters

Returns Promise<void>

Example

emitTo

Type Parameters

Parameters

Returns Promise<void>

Example

position

Returns Promise<dpi.PhysicalPosition>

Example

size

Returns Promise<dpi.PhysicalSize>

Example

close

Returns Promise<void>

Example

setSize

Parameters

Returns Promise<void>

Example

setPosition

Parameters

Returns Promise<void>

Example

setFocus

Returns Promise<void>

Example

setAutoResize

Parameters

Returns Promise<void>

Example

hide

Returns Promise<void>

Example

show

Returns Promise<void>

Example

setZoom

Parameters

Returns Promise<void>

Example

reparent

Parameters

Returns Promise<void>

Example

clearAllBrowsingData

Returns Promise<void>

Example

onDragDropEvent

Parameters

Returns Promise<UnlistenFn>

Example

StaticgetByLabel

Parameters

Returns Promise<null | WebviewWindow>

Example

StaticgetCurrent

Returns WebviewWindow

StaticgetAll

`Static`getByLabel

`Static`getCurrent

`Static`getAll