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:

import { getCurrentWindow } from "@crabnebula/taurify-api/window";
getCurrentWindow().listen("my-window-event", ({ event, payload }) => { });

References

Enumerations

EffectState

Window effect state macOS only

See

https://developer.apple.com/documentation/appkit/nsvisualeffectview/state

Enumeration Members

Active

Active: "active";

Make window effect state always active macOS only

FollowsWindowActiveState

FollowsWindowActiveState: "followsWindowActiveState";

Make window effect state follow the window’s active state macOS only

Inactive

Inactive: "inactive";

Make window effect state always inactive macOS only

ProgressBarStatus

Enumeration Members

Error

Error: "error";

Error state. Treated as Normal on linux

Indeterminate

Indeterminate: "indeterminate";

Indeterminate state. Treated as Normal on Linux and macOS

Paused

Paused: "paused";

Paused state. Treated as Normal on Linux

UserAttentionType

Attention type to request on a window.

Enumeration Members

Critical

Critical: 1;

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.

Informational

Informational: 2;

Platform-specific

macOS: Bounces the dock icon once.
Windows: Flashes the taskbar button until the application is in focus.

Classes

Parameter	Type
`event`	`Event`<`unknown`>

Property	Type	Description	Defined in
`event`	`EventName`	Event name
`id`	`number`	Event identifier used to unlisten

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

import { Window } from "@crabnebula/taurify-api/window"

const appWindow = new Window('theUniqueLabel');

appWindow.once('tauri://created', function () {
 // window successfully created
});
appWindow.once('tauri://error', function (e) {
 // an error happened creating the window
});

// emit an event to the backend
await appWindow.emit("some-event", "data");
// listen to an event from the backend
const unlisten = await appWindow.listen("event-name", e => {});
unlisten();

Extended by

WebviewWindow

Constructors

new Window()

new Window(label, options): Window

Creates a new Window.

Parameters

Parameter	Type	Description
`label`	`string`	The unique window label. Must be alphanumeric: `a-zA-Z-/:_`.
`options`	`WindowOptions`	-

Returns

Window

The Window instance to communicate with the window.

Example

import { Window } from '@crabnebula/taurify-api/window';
const appWindow = new Window('my-label');
appWindow.once('tauri://created', function () {
 // window successfully created
});
appWindow.once('tauri://error', function (e) {
 // an error happened creating the window
});

Properties

Property	Type	Description	Defined in
`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()

center(): Promise<void>

Centers the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

clearEffects()

clearEffects(): Promise<void>

Clear any applied effects if possible.

Returns

Promise<void>

close()

close(): Promise<void>

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

import { getCurrentWindow } from '@crabnebula/taurify-api/window';
await getCurrentWindow().close();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().destroy();

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 { getCurrentWindow } from '@crabnebula/taurify-api/window';
await getCurrentWindow().emit('window-loaded', { loggedIn: true, token: 'authToken' });

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 { getCurrentWindow } from '@crabnebula/taurify-api/window';
await getCurrentWindow().emit('main', 'window-loaded', { loggedIn: true, token: 'authToken' });

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().hide();

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

Promise<PhysicalPosition>

The window’s inner position.

Example

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

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

Promise<PhysicalSize>

The window’s inner size.

Example

import { getCurrentWindow } from '@crabnebula/taurify-api/window';
const size = await getCurrentWindow().innerSize();

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 '@crabnebula/taurify-api/window';
const closable = await getCurrentWindow().isClosable();

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 '@crabnebula/taurify-api/window';
const decorated = await getCurrentWindow().isDecorated();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setEnabled(false);

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 '@crabnebula/taurify-api/window';
const focused = await getCurrentWindow().isFocused();

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 '@crabnebula/taurify-api/window';
const fullscreen = await getCurrentWindow().isFullscreen();

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 '@crabnebula/taurify-api/window';
const maximizable = await getCurrentWindow().isMaximizable();

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 '@crabnebula/taurify-api/window';
const maximized = await getCurrentWindow().isMaximized();

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 '@crabnebula/taurify-api/window';
const minimizable = await getCurrentWindow().isMinimizable();

isMinimized()

isMinimized(): Promise<boolean>

Gets the window’s current minimized state.

Returns

Promise<boolean>

Example

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

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 '@crabnebula/taurify-api/window';
const resizable = await getCurrentWindow().isResizable();

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 '@crabnebula/taurify-api/window';
const visible = await getCurrentWindow().isVisible();

listen()

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

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

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 '@crabnebula/taurify-api/window';
const unlisten = await getCurrentWindow().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();

maximize()

maximize(): Promise<void>

Maximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

minimize()

minimize(): Promise<void>

Minimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

once()

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

Listen to an emitted event on this window only once.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`event`	`EventName`	Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`.
`handler`	`EventCallback`<`T`>	Event handler.

Returns

Promise<UnlistenFn>

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

Example

import { getCurrentWindow } from '@crabnebula/taurify-api/window';
const unlisten = await getCurrentWindow().once<null>('initialized', (event) => {
  console.log(`Window initialized!`);
});

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

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

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 "@crabnebula/taurify-api/window";
import { confirm } from '@crabnebula/taurify-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();

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

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 "@crabnebula/taurify-api/webview";
const unlisten = await getCurrentWindow().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();

onFocusChanged()

onFocusChanged(handler): Promise<UnlistenFn>

Listen to window focus change.

Parameters

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

Returns

Promise<UnlistenFn>

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

Example

import { getCurrentWindow } from "@crabnebula/taurify-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();

onMoved()

onMoved(handler): Promise<UnlistenFn>

Listen to window move.

Parameters

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

Returns

Promise<UnlistenFn>

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

Example

import { getCurrentWindow } from "@crabnebula/taurify-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();

onResized()

onResized(handler): Promise<UnlistenFn>

Listen to window resize.

Parameters

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

Returns

Promise<UnlistenFn>

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

Example

import { getCurrentWindow } from "@crabnebula/taurify-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();

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

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 "@crabnebula/taurify-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();

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>

Listen to the system theme change.

Parameters

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

Returns

Promise<UnlistenFn>

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

Example

import { getCurrentWindow } from "@crabnebula/taurify-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();

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

Promise<PhysicalPosition>

The window’s outer position.

Example

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

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

Promise<PhysicalSize>

The window’s outer size.

Example

import { getCurrentWindow } from '@crabnebula/taurify-api/window';
const size = await getCurrentWindow().outerSize();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().requestUserAttention();

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 '@crabnebula/taurify-api/window';
const factor = await getCurrentWindow().scaleFactor();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setAlwaysOnBottom(true);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setAlwaysOnTop(true);

setBackgroundColor()

setBackgroundColor(color): Promise<void>

Sets the window background color.

Platform-specific:

Windows: alpha channel is ignored.
iOS / Android: Unsupported.

Parameters

Parameter	Type
`color`	`Color`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

setBadgeCount()

setBadgeCount(count?): 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

Parameter	Type	Description
`count`?	`number`	The badge count. Use `undefined` to remove the badge.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

setBadgeLabel()

setBadgeLabel(label?): Promise<void>

Sets the badge label macOS only.

Parameters

Parameter	Type	Description
`label`?	`string`	The badge label. Use `undefined` to remove the badge.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setClosable(false);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setContentProtected(true);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setCursorGrab(true);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setCursorIcon('help');

setCursorPosition()

setCursorPosition(position): Promise<void>

Changes the position of the cursor in window coordinates.

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setCursorVisible(false);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setDecorations(false);

setEffects()

setEffects(effects): Promise<void>

Set window effects.

Parameters

Parameter	Type
`effects`	`Effects`

Returns

Promise<void>

setEnabled()

setEnabled(enabled): Promise<void>

Enable or disable the window.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

setFocus()

setFocus(): Promise<void>

Bring the window to front and focus.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow } from '@crabnebula/taurify-api/window';
await getCurrentWindow().setFocus();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setFullscreen(true);

setIcon()

setIcon(icon): Promise<void>

Sets the window icon.

Parameters

Parameter	Type	Description
`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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setIcon('/tauri/awesome.png');

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setIgnoreCursorEvents(true);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setMaximizable(false);

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` \| `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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setMaxSize(new LogicalSize(600, 500));

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setMinimizable(false);

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` \| `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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setMinSize(new PhysicalSize(600, 500));

setOverlayIcon()

setOverlayIcon(icon?): Promise<void>

Sets the overlay icon. Windows only The overlay icon can be set for every window.

Parameters

Parameter	Type	Description
`icon`?	\| `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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setOverlayIcon("/tauri/awesome.png");

setPosition()

setPosition(position): Promise<void>

Sets the window outer position.

Parameters

Parameter	Type	Description
`position`	`LogicalPosition` \| `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 { getCurrentWindow, LogicalPosition } from '@crabnebula/taurify-api/window';
await getCurrentWindow().setPosition(new LogicalPosition(600, 500));

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setProgressBar({
  status: ProgressBarStatus.Normal,
  progress: 50,
});

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setResizable(false);

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setShadow(false);

setSize()

setSize(size): Promise<void>

Resizes the window with a new inner size.

Parameters

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

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

import { getCurrentWindow, LogicalSize } from '@crabnebula/taurify-api/window';
await getCurrentWindow().setSize(new LogicalSize(600, 500));

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setSizeConstraints({ minWidth: 300 });

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setSkipTaskbar(true);

setTheme()

setTheme(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

Parameter	Type
`theme`?	`null` \| `Theme`

Returns

Promise<void>

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().setTitle('Tauri');

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>

Sets the title bar style. macOS only.

Parameters

Parameter	Type
`style`	`TitleBarStyle`

Returns

Promise<void>

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>

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().show();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().startDragging();

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().startResizeDragging();

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 '@crabnebula/taurify-api/window';
const theme = await getCurrentWindow().theme();

title()

title(): Promise<string>

Gets the window’s current title.

Returns

Promise<string>

Example

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

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 '@crabnebula/taurify-api/window';
await getCurrentWindow().toggleMaximize();

unmaximize()

unmaximize(): Promise<void>

Unmaximizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

unminimize()

unminimize(): Promise<void>

Unminimizes the window.

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

getAll()

static getAll(): Promise<Window[]>

Gets a list of instances of Window for all available windows.

Returns

Promise<Window[]>

getByLabel()

static getByLabel(label): Promise<null | Window>

Gets the Window associated with the given label.

Parameters

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

Returns

Promise<null | Window>

The Window instance to communicate with the window or null if the window doesn’t exist.

Example

import { Window } from '@crabnebula/taurify-api/window';
const mainWindow = Window.getByLabel('main');

getCurrent()

static getCurrent(): Window

Get an instance of Window for the current window.

Returns

Window

getFocusedWindow()

static getFocusedWindow(): Promise<null | Window>

Gets the focused window.

Returns

Promise<null | Window>

The Window instance or undefined if there is not any focused window.

Example

import { Window } from '@crabnebula/taurify-api/window';
const focusedWindow = Window.getFocusedWindow();

Interfaces

Effects

The window effects configuration object

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.

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	Defined in
`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.

Properties

Property	Type	Description	Defined in
`scaleFactor`	`number`	The new window scale factor.
`size`	`PhysicalSize`	The new window size

WindowOptions

Configuration for the window to create.

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.
`backgroundColor?`	`Color`	Set the window background color. #### Platform-specific: - Android / iOS: Unsupported. - Windows: alpha channel is ignored. Since 2.1.0
`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.
`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.
`maxWidth?`	`number`	The maximum width. Only applies if `maxHeight` is also set.
`minHeight?`	`number`	The minimum height. Only applies if `minWidth` is also set.
`minimizable?`	`boolean`	Whether the window’s native minimize button is enabled or not. Defaults to `true`.
`minWidth?`	`number`	The minimum width. Only applies if `minHeight` is also set.
`parent?`	`string` \| `Window` \| `WebviewWindow`	Sets a parent to the window to be created. Can be either a `Window` or a label of the window. #### Platform-specific - Windows: This sets the passed parent as an owner window to the window to be created. From MSDN owned windows docs: - An owned window is always above its owner in the z-order. - The system automatically destroys an owned window when its owner is destroyed. - An owned window is hidden when its owner is minimized. - Linux: This makes the new window transient for parent, see https://docs.gtk.org/gtk3/method.Window.set_transient_for.html - macOS: This adds the window as a child of parent, see https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc
`resizable?`	`boolean`	Whether the window is resizable or not.
`shadow?`	`boolean`	Whether or not the window has 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.
`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 - Windows / iOS / Android: Unsupported.
`width?`	`number`	The initial width.
`windowEffects?`	`Effects`	Window effects. Requires the window to be transparent. #### Platform-specific: - Windows: If using decorations or shadows, you may want to try this workaround https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891 - Linux: Unsupported
`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.

WindowSizeConstraints

Properties

Property	Type	Defined in
`maxHeight?`	`number`
`maxWidth?`	`number`
`minHeight?`	`number`
`minWidth?`	`number`

Type Aliases

Color

type Color: [number, number, number] | [number, number, number, number] | object | string;

An RGBA color. Each value has minimum of 0 and maximum of 255.

It can be either a string #ffffff, an array of 3 or 4 elements or an object.

CursorIcon

type CursorIcon:
  | "default"
  | "crosshair"
  | "hand"
  | "arrow"
  | "move"
  | "text"
  | "wait"
  | "help"
  | "progress"
  | "notAllowed"
  | "contextMenu"
  | "cell"
  | "verticalText"
  | "alias"
  | "copy"
  | "noDrop"
  | "grab"
  | "grabbing"
  | "allScroll"
  | "zoomIn"
  | "zoomOut"
  | "eResize"
  | "nResize"
  | "neResize"
  | "nwResize"
  | "sResize"
  | "seResize"
  | "swResize"
  | "wResize"
  | "ewResize"
  | "nsResize"
  | "neswResize"
  | "nwseResize"
  | "colResize"
  | "rowResize";

DragDropEvent

type DragDropEvent: object | object | object | object;

The drag and drop event types.

Theme

type Theme: "light" | "dark";

TitleBarStyle

type TitleBarStyle: "visible" | "transparent" | "overlay";

Functions

availableMonitors()

function availableMonitors(): Promise<Monitor[]>

Returns the list of all the monitors available on the system.

Returns

Promise<Monitor[]>

Example

import { availableMonitors } from '@crabnebula/taurify-api/window';
const monitors = availableMonitors();

currentMonitor()

function currentMonitor(): Promise<Monitor | null>

Returns the monitor on which the window currently resides. Returns null if current monitor can’t be detected.

Returns

Promise<Monitor | null>

Example

import { currentMonitor } from '@crabnebula/taurify-api/window';
const monitor = currentMonitor();

cursorPosition()

function cursorPosition(): Promise<PhysicalPosition>

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

Promise<PhysicalPosition>

getAllWindows()

function getAllWindows(): Promise<Window[]>

Gets a list of instances of Window for all available windows.

Returns

Promise<Window[]>

getCurrentWindow()

function getCurrentWindow(): Window

Get an instance of Window for the current window.

Returns

Window

monitorFromPoint()

function monitorFromPoint(x, y): Promise<Monitor | null>

Returns the monitor that contains the given point. Returns null if can’t find any.

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

Promise<Monitor | null>

Example

import { monitorFromPoint } from '@crabnebula/taurify-api/window';
const monitor = monitorFromPoint();

primaryMonitor()

function primaryMonitor(): Promise<Monitor | null>

Returns the primary monitor of the system. Returns null if it can’t identify any monitor as a primary one.

Returns

Promise<Monitor | null>

Example

import { primaryMonitor } from '@crabnebula/taurify-api/window';
const monitor = primaryMonitor();