webviewWindow
此内容尚不支持你的语言。
References
DragDropEvent
Re-exports DragDropEvent
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 backendawait webview.emit("some-event", "data");// listen to an event from the backendconst unlisten = await webview.listen("event-name", e => {});unlisten();
Since
2.0.0
Extends
Constructors
new WebviewWindow()
new WebviewWindow(label, options): WebviewWindow
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 , "width" | "height" | "x" | "y" > & WindowOptions | - |
Returns
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L75
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. | Window .label | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L51 |
listeners | Record <string , EventCallback <any >[]> | Local event listeners. | Window .listeners | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L54 |
window | Window | The window hosting this webview. | Webview .window | Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L132 |
Methods
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L812
clearEffects()
clearEffects(): Promise<void>
Clear any applied effects if possible.
Returns
Promise
<void
>
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1163
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L399
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1100
emit()
emit(event, payload?): Promise<void>
Emits an event to all targets.
Parameters
Parameter | Type | Description |
---|---|---|
event | string | Event name. Must include only alphanumeric characters, - , / , : and _ . |
payload ? | unknown | Event payload. |
Returns
Promise
<void
>
Example
import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().emit('webview-loaded', { loggedIn: true, token: 'authToken' });
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L288
emitTo()
emitTo( target, event,payload?): Promise<void>
Emits an event to all targets matching the given target.
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
>
Example
import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().emitTo('main', 'webview-loaded', { loggedIn: true, token: 'authToken' });
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L316
hide()
hide(): Promise<void>
Sets the window visibility to false.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().hide();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1066
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.
Returns
The window’s inner position.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';const position = await getCurrentWindow().innerPosition();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L530
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.
Returns
The window’s inner size.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';const size = await getCurrentWindow().innerSize();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L563
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L743
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L664
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L648
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L602
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L701
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L632
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L722
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L616
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L680
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L759
listen()
listen<T>(event, handler): Promise<UnlistenFn>
Listen to an emitted event on this webivew window.
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type | Description |
---|---|---|
event | EventName | Event name. Must include only alphanumeric characters, - , / , : and _ . |
handler | EventCallback <T > | Event handler. |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { 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 unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L155
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L970
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1018
onCloseRequested()
onCloseRequested(handler): Promise<UnlistenFn>
Listen to window close requested. Emitted when the user requests to closes the window.
Parameters
Parameter | Type |
---|---|
handler | (event ) => void | Promise <void > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";import { confirm } from '@tauri-apps/api/dialog';const unlisten = await getCurrentWindow().onCloseRequested(async (event) => { const confirmed = await confirm('Are you sure?'); if (!confirmed) { // user did not confirm closing the window; let's prevent it event.preventDefault(); }});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1751
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.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <DragDropEvent > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWebview } from "@tauri-apps/api/webview";const unlisten = await getCurrentWebview().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 unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L547
onFocusChanged()
onFocusChanged(handler): Promise<UnlistenFn>
Listen to window focus change.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <boolean > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";const unlisten = await getCurrentWindow().onFocusChanged(({ payload: focused }) => { console.log('Focus changed, window is focused? ' + focused);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1867
onMoved()
onMoved(handler): Promise<UnlistenFn>
Listen to window move.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <PhysicalPosition > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";const unlisten = await getCurrentWindow().onMoved(({ payload: position }) => { console.log('Window moved', position);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1722
onResized()
onResized(handler): Promise<UnlistenFn>
Listen to window resize.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <PhysicalSize > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";const unlisten = await getCurrentWindow().onResized(({ payload: size }) => { console.log('Window resized', size);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1698
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.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <ScaleFactorChanged > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";const unlisten = await getCurrentWindow().onScaleChanged(({ payload }) => { console.log('Scale changed', payload.scaleFactor, payload.size);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1907
onThemeChanged()
onThemeChanged(handler): Promise<UnlistenFn>
Listen to the system theme change.
Parameters
Parameter | Type |
---|---|
handler | EventCallback <Theme > |
Returns
A promise resolving to a function to unlisten to the event. Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted.
Example
import { getCurrentWindow } from "@tauri-apps/api/window";const unlisten = await getCurrentWindow().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 unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1933
once()
once<T>(event, handler): Promise<UnlistenFn>
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
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 unmountedunlisten();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L190
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.
Returns
The window’s outer position.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';const position = await getCurrentWindow().outerPosition();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L546
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.
Returns
The window’s outer size.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';const size = await getCurrentWindow().outerSize();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L583
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.
Returns
The webview’s position.
Example
import { getCurrentWebview } from '@tauri-apps/api/webview';const position = await getCurrentWebview().position();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L361
reparent()
reparent(window): Promise<void>
Moves this webview to the given label.
Parameters
Parameter | Type |
---|---|
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L513
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.
Parameters
Parameter | Type |
---|---|
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L838
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L514
setAlwaysOnBottom()
setAlwaysOnBottom(alwaysOnBottom): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1199
setAlwaysOnTop()
setAlwaysOnTop(alwaysOnTop): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1181
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.
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L935
setContentProtected()
setContentProtected(protected_): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1216
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.
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1489
setCursorIcon()
setCursorIcon(icon): Promise<void>
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');
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1531
setCursorPosition()
setCursorPosition(position): Promise<void>
Changes the position of the cursor in window coordinates.
Parameters
Parameter | Type | Description |
---|---|---|
position | LogicalPosition | PhysicalPosition | 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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1549
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.
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1513
setDecorations()
setDecorations(decorations): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1117
setEffects()
setEffects(effects): Promise<void>
Set window effects.
Parameters
Parameter | Type |
---|---|
effects | Effects |
Returns
Promise
<void
>
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1153
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L480
setFullscreen()
setFullscreen(fullscreen): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1398
setIcon()
setIcon(icon): Promise<void>
Sets the window icon.
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.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().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"] }
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1439
setIgnoreCursorEvents()
setIgnoreCursorEvents(ignore): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1585
setMaxSize()
setMaxSize(size): Promise<void>
Sets the window maximum inner size. If the size
argument is undefined, the constraint is unset.
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.
Example
import { getCurrentWindow, LogicalSize } from '@tauri-apps/api/window';await getCurrentWindow().setMaxSize(new LogicalSize(600, 500));
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1299
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.
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L890
setMinSize()
setMinSize(size): Promise<void>
Sets the window minimum inner size. If the size
argument is not provided, the constraint is unset.
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.
Example
import { getCurrentWindow, PhysicalSize } from '@tauri-apps/api/window';await getCurrentWindow().setMinSize(new PhysicalSize(600, 500));
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1264
setMinimizable()
setMinimizable(minimizable): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L912
setPosition()
setPosition(position): Promise<void>
Sets the webview position.
Parameters
Parameter | Type | Description |
---|---|---|
position | LogicalPosition | PhysicalPosition | 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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L446
setProgressBar()
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).
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,});
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1644
setResizable()
setResizable(resizable): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L866
setShadow()
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 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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1143
setSize()
setSize(size): Promise<void>
Resizes the webview.
Parameters
Parameter | Type | Description |
---|---|---|
size | LogicalSize | PhysicalSize | 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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L416
setSizeConstraints()
setSizeConstraints(constraints): Promise<void>
Sets the window inner size constraints.
Parameters
Parameter | Type | Description |
---|---|---|
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1334
setSkipTaskbar()
setSkipTaskbar(skip): Promise<void>
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);
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1463
setTitle()
setTitle(title): Promise<void>
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');
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L953
setTitleBarStyle()
setTitleBarStyle(style): Promise<void>
Sets the title bar style. macOS only.
Parameters
Parameter | Type |
---|---|
style | TitleBarStyle |
Returns
Promise
<void
>
Since
2.0.0
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1672
setVisibleOnAllWorkspaces()
setVisibleOnAllWorkspaces(visible): Promise<void>
Sets whether the window should be visible on all workspaces or virtual desktops.
Platform-specific
- Windows / iOS / Android: Unsupported.
Parameters
Parameter | Type |
---|---|
visible | boolean |
Returns
Promise
<void
>
Since
2.0.0
Inherited from
Window
.setVisibleOnAllWorkspaces
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1660
setZoom()
setZoom(scaleFactor): Promise<void>
Set webview zoom level.
Parameters
Parameter | Type |
---|---|
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L496
show()
show(): Promise<void>
Sets the window visibility to true.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';await getCurrentWindow().show();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1050
size()
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.
Returns
The webview’s size.
Example
import { getCurrentWebview } from '@tauri-apps/api/webview';const size = await getCurrentWebview().size();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L378
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1602
startResizeDragging()
startResizeDragging(direction): Promise<void>
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();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1618
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
The window theme.
Example
import { getCurrentWindow } from '@tauri-apps/api/window';const theme = await getCurrentWindow().theme();
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L794
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L773
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1002
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L986
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1034
getAll()
static getAll(): Promise<WebviewWindow[]>
Gets a list of instances of Webview
for all available webviews.
Returns
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L132
getByLabel()
static getByLabel(label): Promise<null | WebviewWindow>
Gets the Webview for the webview associated with the given label.
Parameters
Parameter | Type | Description |
---|---|---|
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
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L112
getCurrent()
static getCurrent(): WebviewWindow
Get an instance of Webview
for the current webview.
Returns
Inherited from
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L125
Functions
getAllWebviewWindows()
function getAllWebviewWindows(): Promise<WebviewWindow[]>
Gets a list of instances of Webview
for all available webview windows.
Returns
Since
2.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L34
getCurrentWebviewWindow()
function getCurrentWebviewWindow(): WebviewWindow
Get an instance of Webview
for the current webview window.
Returns
Since
2.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L23
© 2024 Tauri Contributors. CC-BY / MIT