window
Provides APIs to create windows, communicate with other windows and manipulate the current window.
Window events
Events can be listened to using Window.listen:
References
LogicalPosition
Re-exports LogicalPosition
LogicalSize
Re-exports LogicalSize
PhysicalPosition
Re-exports PhysicalPosition
PhysicalSize
Re-exports PhysicalSize
Enumerations
Effect
Platform-specific window effects
Since
2.0.0
Enumeration Members
Acrylic
Windows 10/11
Notes
This effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2004
AppearanceBased
A default material appropriate for the view’s effectiveAppearance. macOS 10.14-
Deprecated
since macOS 10.14. You should instead choose an appropriate semantic material.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1904
Blur
Windows 7/10/11(22H1) Only
Notes
This effect has bad performance when resizing/dragging the window on Windows 11 build 22621.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1996
ContentBackground
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1976
Dark
macOS 10.14-
Deprecated
since macOS 10.14. Use a semantic material instead.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1916
FullScreenUI
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1968
HeaderView
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1952
HudWindow
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1964
Light
macOS 10.14-
Deprecated
since macOS 10.14. Use a semantic material instead.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1910
MediumLight
macOS 10.14-
Deprecated
since macOS 10.14. Use a semantic material instead.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1922
Menu
macOS 10.11+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1940
Mica
Windows 11 Only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1988
Popover
macOS 10.11+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1944
Selection
macOS 10.10+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1936
Sheet
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1956
Sidebar
macOS 10.11+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1948
Tabbed
Tabbed effect that matches the system dark perefence Windows 11 Only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2008
TabbedDark
Tabbed effect with dark mode but only if dark mode is enabled on the system Windows 11 Only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2012
TabbedLight
Tabbed effect with light mode Windows 11 Only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2016
Titlebar
macOS 10.10+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1932
Tooltip
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1972
UltraDark
macOS 10.14-
Deprecated
since macOS 10.14. Use a semantic material instead.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1928
UnderPageBackground
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1984
UnderWindowBackground
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1980
WindowBackground
macOS 10.14+
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1960
EffectState
Window effect state macOS only
See
https://developer.apple.com/documentation/appkit/nsvisualeffectview/state
Since
2.0.0
Enumeration Members
Active
Make window effect state always active macOS only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2034
FollowsWindowActiveState
Make window effect state follow the window’s active state macOS only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2030
Inactive
Make window effect state always inactive macOS only
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2038
ProgressBarStatus
Enumeration Members
Error
Error state. Treated as Normal on linux
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L184
Indeterminate
Indeterminate state. Treated as Normal on Linux and macOS
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L176
None
Hide progress bar.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L168
Normal
Normal state.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L172
Paused
Paused state. Treated as Normal on Linux
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L180
UserAttentionType
Attention type to request on a window.
Since
1.0.0
Enumeration Members
Critical
Platform-specific
- macOS: Bounces the dock icon until the application is in focus.
- Windows: Flashes both the window and the taskbar button until the application is in focus.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L93
Informational
Platform-specific
- macOS: Bounces the dock icon once.
- Windows: Flashes the taskbar button until the application is in focus.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L99
Classes
CloseRequestedEvent
Constructors
new CloseRequestedEvent()
Parameters
Parameter | Type |
---|---|
event | Event <null > |
Returns
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L109
Properties
Property | Modifier | Type | Default value | Description |
---|---|---|---|---|
_preventDefault | private | boolean | false | - |
event | public | EventName | undefined | Event name |
id | public | number | undefined | Event identifier used to unlisten |
Methods
isPreventDefault()
Returns
boolean
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L118
preventDefault()
Returns
void
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L114
Window
Create new window or get a handle to an existing one.
Windows 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
Since
2.0.0
Extended by
Constructors
new Window()
Creates a new Window.
Parameters
Parameter | Type | Description |
---|---|---|
label | string | The unique window label. Must be alphanumeric: a-zA-Z-/:_ . |
options | WindowOptions | - |
Returns
The Window instance to communicate with the window.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L283
Properties
Property | Type | Description |
---|---|---|
label | string | The window label. It is a unique identifier for the window, can be used to reference it later. |
listeners | Record <string , EventCallback <any >[]> | Local event listeners. |
Methods
center()
Centers the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L801
clearEffects()
Clear any applied effects if possible.
Returns
Promise
<void
>
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1152
close()
Closes the window.
Note this emits a closeRequested event so you can intercept it. To force window close, use Window.destroy.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1073
destroy()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1089
emit()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L431
emitTo()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L458
hide()
Sets the window visibility to false.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1055
innerPosition()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L519
innerSize()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L552
isClosable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L732
isDecorated()
Gets the window’s current decorated state.
Returns
Promise
<boolean
>
Whether the window is decorated or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L653
isFocused()
Gets the window’s current focus state.
Returns
Promise
<boolean
>
Whether the window is focused or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L637
isFullscreen()
Gets the window’s current fullscreen state.
Returns
Promise
<boolean
>
Whether the window is in fullscreen mode or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L591
isMaximizable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L690
isMaximized()
Gets the window’s current maximized state.
Returns
Promise
<boolean
>
Whether the window is maximized or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L621
isMinimizable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L711
isMinimized()
Gets the window’s current minimized state.
Returns
Promise
<boolean
>
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L605
isResizable()
Gets the window’s current resizable state.
Returns
Promise
<boolean
>
Whether the window is resizable or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L669
isVisible()
Gets the window’s current visible state.
Returns
Promise
<boolean
>
Whether the window is visible or not.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L748
listen()
Listen to an emitted event on this 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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L372
maximize()
Maximizes the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L959
minimize()
Minimizes the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1007
onCloseRequested()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1700
onDragDropEvent()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1739
onFocusChanged()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1815
onMoved()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1670
onResized()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1646
onScaleChanged()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1855
onThemeChanged()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1881
once()
Listen to an emitted event on this window only once.
Type parameters
Type parameter |
---|
T |
Parameters
Parameter | Type | Description |
---|---|---|
event | string | 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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L407
outerPosition()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L535
outerSize()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L572
requestUserAttention()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L827
scaleFactor()
The scale factor that can be used to map physical pixels to logical pixels.
Returns
Promise
<number
>
The window’s monitor scale factor.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L503
setAlwaysOnBottom()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1188
setAlwaysOnTop()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1170
setClosable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L924
setContentProtected()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1205
setCursorGrab()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1449
setCursorIcon()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1491
setCursorPosition()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1509
setCursorVisible()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1473
setDecorations()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1106
setEffects()
Set window effects.
Parameters
Parameter | Type |
---|---|
effects | Effects |
Returns
Promise
<void
>
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1142
setFocus()
Bring the window to front and focus.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1375
setFullscreen()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1358
setIcon()
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
Note that you need the image-ico
or image-png
Cargo features to use this API.
To enable it, change your Cargo.toml file:
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1399
setIgnoreCursorEvents()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1545
setMaxSize()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1288
setMaximizable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L879
setMinSize()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1253
setMinimizable()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L901
setPosition()
Sets the window outer 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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1323
setProgressBar()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1604
setResizable()
Updates the window resizable flag.
Parameters
Parameter | Type |
---|---|
resizable | boolean |
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L855
setShadow()
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.
Parameters
Parameter | Type |
---|---|
enable | boolean |
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1132
setSize()
Resizes the window with a new inner size.
Parameters
Parameter | Type | Description |
---|---|---|
size | LogicalSize | PhysicalSize | The logical or physical inner size. |
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1223
setSkipTaskbar()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1423
setTitle()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L942
setVisibleOnAllWorkspaces()
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1620
show()
Sets the window visibility to true.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1039
startDragging()
Starts dragging the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1562
startResizeDragging()
Starts resize-dragging the window.
Parameters
Parameter | Type |
---|---|
direction | ResizeDirection |
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1578
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
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L783
title()
Gets the window’s current title.
Returns
Promise
<string
>
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L762
toggleMaximize()
Toggles the window maximized state.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L991
unmaximize()
Unmaximizes the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L975
unminimize()
Unminimizes the window.
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1023
getAll()
Gets a list of instances of Window
for all available windows.
Returns
Window
[]
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L330
getByLabel()
Gets the Window associated with the given label.
Parameters
Parameter | Type | Description |
---|---|---|
label | string | The window label. |
Returns
null
| Window
The Window instance to communicate with the window or null if the window doesn’t exist.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L316
getCurrent()
Get an instance of Window
for the current window.
Returns
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L323
getFocusedWindow()
Gets the focused window.
Returns
The Window instance or undefined
if there is not any focused window.
Example
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L344
Interfaces
DragDropPayload
Properties
Property | Type |
---|---|
paths | string [] |
position | PhysicalPosition |
Effects
The window effects configuration object
Since
2.0.0
Properties
Property | Type | Description |
---|---|---|
color? | Color | Window effect color. Affects Effect.Blur and Effect.Acrylic only on Windows 10 v1903+. Doesn’t have any effect on Windows 7 or Windows 11. |
effects | Effect [] | List of Window effects to apply to the Window. Conflicting effects will apply the first one and ignore the rest. |
radius? | number | Window effect corner radius macOS Only |
state? | EffectState | Window effect state macOS Only |
Monitor
Allows you to retrieve information about a given monitor.
Since
1.0.0
Properties
Property | Type | Description |
---|---|---|
name | null | string | Human-readable name of the monitor |
position | PhysicalPosition | the Top-left corner position of the monitor relative to the larger full screen area. |
scaleFactor | number | The scale factor that can be used to map physical pixels to logical pixels. |
size | PhysicalSize | The monitor’s resolution. |
ProgressBarState
Properties
Property | Type | Description |
---|---|---|
progress? | number | The progress bar progress. This can be a value ranging from 0 to 100 |
status? | ProgressBarStatus | The progress bar status. |
ScaleFactorChanged
The payload for the scaleChange
event.
Since
1.0.2
Properties
Property | Type | Description |
---|---|---|
scaleFactor | number | The new window scale factor. |
size | PhysicalSize | The new window size |
WindowOptions
Configuration for the window to create.
Since
1.0.0
Properties
Property | Type | Description |
---|---|---|
alwaysOnBottom? | boolean | Whether the window should always be below other windows. |
alwaysOnTop? | boolean | Whether the window should always be on top of other windows or not. |
center? | boolean | Show window in the center of the screen.. |
closable? | boolean | Whether the window’s native close button is enabled or not. Defaults to true . |
contentProtected? | boolean | Prevents the window contents from being captured by other apps. |
decorations? | boolean | Whether the window should have borders and bars or not. |
focus? | boolean | Whether the window will be initially focused or not. |
fullscreen? | boolean | Whether the window is in fullscreen mode or not. |
height? | number | The initial height. |
hiddenTitle? | boolean | If true , sets the window title to be hidden on macOS. |
maxHeight? | number | The maximum height. Only applies if maxWidth is also set. |
maxWidth? | number | The maximum width. Only applies if maxHeight is also set. |
maximizable? | boolean | Whether the window’s native maximize button is enabled or not. Defaults to true . |
maximized? | boolean | Whether the window should be maximized upon creation or not. |
minHeight? | number | The minimum height. Only applies if minWidth is also set. |
minWidth? | number | The minimum width. Only applies if minHeight is also set. |
minimizable? | boolean | Whether the window’s native minimize button is enabled or not. Defaults to true . |
parent? | string | Window | WebviewWindow | Sets a parent to the window to be created. Can be either a Platform-specific
|
resizable? | boolean | Whether the window is resizable or not. |
shadow? | boolean | Whether or not the window has shadow. Platform-specific
Since 2.0.0 |
skipTaskbar? | boolean | Whether or not the window icon should be added to the taskbar. |
tabbingIdentifier? | string | Defines the window tabbing identifier on macOS. Windows with the same tabbing identifier will be grouped together. If the tabbing identifier is not set, automatic tabbing will be disabled. |
theme? | Theme | The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+. |
title? | string | Window title. |
titleBarStyle? | TitleBarStyle | The style of the macOS title bar. |
transparent? | boolean | Whether the window is transparent or not. Note that on macOS this requires the macos-private-api feature flag, enabled under tauri.conf.json > app > macOSPrivateApi . WARNING: Using private APIs on macOS prevents your application from being accepted to the App Store . |
visible? | boolean | Whether the window should be immediately visible upon creation or not. |
visibleOnAllWorkspaces? | boolean | Whether the window should be visible on all workspaces or virtual desktops. Platform-specific
Since 2.0.0 |
width? | number | The initial width. |
x? | number | The initial vertical position. Only applies if y is also set. |
y? | number | The initial horizontal position. Only applies if x is also set. |
Type Aliases
Color
an array RGBA colors. Each value has minimum of 0 and maximum of 255.
Since
2.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L1891
CursorIcon
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L123
DragDropEvent
The drag and drop event types.
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/webview.ts#L46
Theme
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L57
TitleBarStyle
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L58
Functions
availableMonitors()
Returns the list of all the monitors available on the system.
Returns
Example
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2270
currentMonitor()
Returns the monitor on which the window currently resides.
Returns null
if current monitor can’t be detected.
Returns
Example
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2220
cursorPosition()
Get the cursor position relative to the top-left hand corner of the desktop.
Note that the top-left hand corner of the desktop is not necessarily the same as the screen. If the user uses a desktop with multiple monitors, the top-left hand corner of the desktop is the top-left hand corner of the main monitor on Windows and macOS or the top-left of the leftmost monitor on X11.
The coordinates can be negative if the top-left hand corner of the window is outside of the visible screen region.
Returns
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2286
getAll()
Gets a list of instances of Window
for all available windows.
Returns
Window
[]
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L215
getCurrent()
Get an instance of Window
for the current window.
Returns
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L203
monitorFromPoint()
Returns the monitor that contains the given point. Returns null
if can’t find any.
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
Example
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2253
primaryMonitor()
Returns the primary monitor of the system.
Returns null
if it can’t identify any monitor as a primary one.
Returns
Example
Since
1.0.0
Source: https://github.com/tauri-apps/tauri/blob/dev/tooling/api/src/window.ts#L2237
© 2024 Tauri Contributors. CC-BY / MIT