window

Proporciona APIs para crear ventanas, comunicarse con otras ventanas y manipular la ventana actual.

Eventos de ventana

Los eventos se pueden escuchar usando Window.listen:

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

Referencias

Color

Re-exporta Color

DragDropEvent

Re-exporta DragDropEvent

LogicalPosition

Re-exporta LogicalPosition

LogicalSize

Re-exporta LogicalSize

PhysicalPosition

Re-exporta PhysicalPosition

PhysicalSize

Re-exporta PhysicalSize

Enumeraciones

BackgroundThrottlingPolicy

Política de limitación en segundo plano

Desde

2.0.0

Miembros de enumeraciones

Deshabilitado

Disabled: "disabled";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2133

Suspender

Suspend: "suspend";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2135

Limitar

Throttle: "throttle";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2134

---

Efecto

Efectos de ventana específicos de la plataforma

Desde

2.0.0

Miembros de enumeraciones

Acrylic

Acrylic: "acrylic";

Windows 10/11

Notas

Este efecto tiene un rendimiento deficiente al redimensionar/arrastrar la ventana en Windows 10 v1903+ y Windows 11 build 22000.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2272

AppearanceBased

AppearanceBased: "appearanceBased";

Un material por defecto adecuado para la effectiveAppearance de la vista. macOS 10.14-

Obsoleto

desde macOS 10.14. En su lugar, deberías elegir un material semántico adecuado.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2172

Blur

Blur: "blur";

Windows 7/10/11(22H1) Only

Notas

Este efecto tiene un rendimiento deficiente al redimensionar/arrastrar la ventana en Windows 11 build 22621.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2264

ContentBackground

ContentBackground: "contentBackground";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2244

Dark

Dark: "dark";

macOS 10.14-

Obsoleto

desde macOS 10.14. Usa un material semántico en su lugar.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2184

FullScreenUI

FullScreenUI: "fullScreenUI";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2236

HeaderView

HeaderView: "headerView";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2220

HudWindow

HudWindow: "hudWindow";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2232

Light

Light: "light";

macOS 10.14-

Obsoleto

desde macOS 10.14. Usa un material semántico en su lugar.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2178

MediumLight

MediumLight: "mediumLight";

macOS 10.14-

Obsoleto

desde macOS 10.14. Usa un material semántico en su lugar.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2190

Menú

Menu: "menu";

macOS 10.11+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2208

Mica

Mica: "mica";

Windows 11 Only

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2256

Popover

Popover: "popover";

macOS 10.11+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2212

Selection

Selection: "selection";

macOS 10.10+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2204

Sheet

Sheet: "sheet";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2224

Barra lateral

Sidebar: "sidebar";

macOS 10.11+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2216

Tabbed

Tabbed: "tabbed";

Efecto Tabbed que coincide con la preferencia de modo oscuro del sistema Solo Windows 11

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2276

TabbedDark

TabbedDark: "tabbedDark";

Efecto Tabbed con modo oscuro pero solo si el modo oscuro está habilitado en el sistema Solo Windows 11

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2280

TabbedLight

TabbedLight: "tabbedLight";

Efecto Tabbed con modo claro Solo Windows 11

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2284

Titlebar

Titlebar: "titlebar";

macOS 10.10+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2200

Tooltip

Tooltip: "tooltip";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2240

UltraDark

UltraDark: "ultraDark";

macOS 10.14-

Obsoleto

desde macOS 10.14. Usa un material semántico en su lugar.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2196

UnderPageBackground

UnderPageBackground: "underPageBackground";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2252

UnderWindowBackground

UnderWindowBackground: "underWindowBackground";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2248

WindowBackground

WindowBackground: "windowBackground";

macOS 10.14+

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2228

---

EffectState

Estado del efecto de ventana solo macOS

Ver

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

Desde

2.0.0

Miembros de enumeraciones

Activo

Active: "active";

Hace que el estado del efecto de la ventana esté siempre activo Solo macOS

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2302

FollowsWindowActiveState

FollowsWindowActiveState: "followsWindowActiveState";

Hace que el estado del efecto de la ventana siga el estado activo de la ventana Solo macOS

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2298

Inactivo

Inactive: "inactive";

Hace que el estado del efecto de la ventana esté siempre inactivo Solo macOS

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2306

---

ProgressBarStatus

Miembros de enumeraciones

Error

Error: "error";

Estado de error. Tratado como Normal en Linux

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L220

Indeterminado

Indeterminate: "indeterminate";

Estado indeterminado. Tratado como Normal en Linux y macOS

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L212

Ninguno

None: "none";

Ocultar barra de progreso.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L204

Normal

Normal: "normal";

Estado normal.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L208

Pausado

Paused: "paused";

Estado pausado. Tratado como Normal en Linux

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L216

---

ScrollBarStyle

El estilo de la barra de desplazamiento a usar en la webview.

Específico de la plataforma

Windows: A esta opción se le debe dar el mismo valor para todas las webviews.

Desde

2.8.0

Miembros de enumeraciones

Por defecto

Default: "default";

El estilo de la barra de desplazamiento por defecto para la webview.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2151

FluentOverlay

FluentOverlay: "fluentOverlay";

Barras de desplazamiento superpuestas de estilo Fluent UI. Solo Windows

Requiere la versión 125.0.2535.41 o superior del tiempo de ejecución de WebView2, no hace nada en versiones anteriores, consulta https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/?tabs=dotnetcsharp#10253541

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2158

---

UserAttentionType

Tipo de atención a solicitar en una ventana.

Desde

1.0.0

Miembros de enumeraciones

Crítico

Critical: 1;

Específico de la plataforma

• macOS: Hace rebotar el icono del dock hasta que la aplicación tenga el foco.
• Windows: Hace parpadear tanto la ventana como el botón de la barra de tareas hasta que la aplicación tenga el foco.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L129

Informativo

Informational: 2;

Específico de la plataforma

• macOS: Hace rebotar el icono del dock una vez.
• Windows: Hace parpadear el botón de la barra de tareas hasta que la aplicación tenga el foco.

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L135

Clases

CloseRequestedEvent

Constructores

new CloseRequestedEvent()

new CloseRequestedEvent(event): CloseRequestedEvent

Parámetros

Parámetro	Tipo
event	Event<unknown>

Devuelve

CloseRequestedEvent

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L145

Propiedades

Propiedad	Tipo	Descripción	Definido en
event	EventName	Nombre del evento	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L140
id	number	Identificador de evento usado para dejar de escuchar (unlisten)	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L142

Métodos

isPreventDefault()

isPreventDefault(): boolean

Devuelve

boolean

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L154

preventDefault()

preventDefault(): void

Devuelve

void

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L150

---

Window

Crear una nueva ventana u obtener un identificador (handle) para una existente.

Las ventanas se identifican mediante una etiqueta, un identificador único que se puede usar para hacer referencia a ella más adelante. Solo puede contener caracteres alfanuméricos a-zA-Z más los siguientes caracteres especiales -, /, : y _.

Ejemplo

import { Window } from "@tauri-apps/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();

Desde

2.0.0

Extendido por

• WebviewWindow

Constructores

new Window()

new Window(label, options): Window

Crea una nueva Window.

Parámetros

Parámetro	Tipo	Descripción
label	string	La etiqueta única de la ventana. Debe ser alfanumérica: a-zA-Z-/:_.
options	WindowOptions	-

Devuelve

Window

La instancia de Window para comunicarse con la ventana.

Ejemplo

import { Window } from '@tauri-apps/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
});

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L328

Propiedades

Propiedad	Tipo	Descripción	Definido en
label	string	La etiqueta de la ventana. Es un identificador único para la ventana y se puede usar para hacer referencia a ella más adelante.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L306
listeners	Registro (Record)<string, EventCallback<any>[]>	Oyentes de eventos (event listeners) locales.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L309

Métodos

activityName()

activityName(): Promise<string>

Devuelve

Promise<string>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L853

center()

center(): Promise<void>

Centra la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L877

clearEffects()

clearEffects(): Promise<void>

Borra cualquier efecto aplicado si es posible.

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1265

close()

close(): Promise<void>

Cierra la ventana.

Ten en cuenta que esto emite un evento closeRequested para que puedas interceptarlo. Para forzar el cierre de la ventana, usa Window.destroy.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1186

destroy()

destroy(): Promise<void>

Destruye la ventana. Se comporta como Window.close pero fuerza el cierre de la ventana en lugar de emitir un evento closeRequested.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1202

emit()

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

Emite un evento a todos los objetivos (targets).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	string	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
payload?	T	Carga útil (payload) del evento.

Devuelve

Promise<void>

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L479

emitTo()

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

Emite un evento a todos los objetivos (targets) que coincidan con el objetivo dado.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
target	string | EventTarget	Etiqueta (label) de la Window/Webview/WebviewWindow de destino o un objeto EventTarget sin procesar.
event	string	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
payload?	T	Carga útil (payload) del evento.

Devuelve

Promise<void>

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L506

hide()

hide(): Promise<void>

Establece la visibilidad de la ventana en false.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1168

innerPosition()

innerPosition(): Promise<PhysicalPosition>

La posición de la esquina superior izquierda del área de cliente de la ventana con respecto a la esquina superior izquierda del escritorio.

Devuelve

Promise<PhysicalPosition>

La posición interior de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L567

innerSize()

innerSize(): Promise<PhysicalSize>

El tamaño físico del área de cliente de la ventana. El área de cliente es el contenido de la ventana, excluyendo la barra de título y los bordes.

Devuelve

Promise<PhysicalSize>

El tamaño interior de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L600

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>

Si la ventana está configurada para estar siempre encima de otras ventanas o no.

Devuelve

Promise<boolean>

Si la ventana es visible o no.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/api/window';
const alwaysOnTop = await getCurrentWindow().isAlwaysOnTop();

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L847

isClosable()

isClosable(): Promise<boolean>

Obtiene el estado del botón nativo de cierre de la ventana.

Específico de la plataforma

• iOS / Android: No soportado.

Devuelve

Promise<boolean>

Si el botón de cierre nativo de la ventana está habilitado o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L780

isDecorated()

isDecorated(): Promise<boolean>

Obtiene el estado actual de decoración de la ventana.

Devuelve

Promise<boolean>

Si la ventana tiene decoraciones o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L701

isEnabled()

isEnabled(): Promise<boolean>

Si la ventana está habilitada o deshabilitada.

Devuelve

Promise<boolean>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L969

isFocused()

isFocused(): Promise<boolean>

Obtiene el estado de foco actual de la ventana.

Devuelve

Promise<boolean>

Si la ventana tiene el foco o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L685

isFullscreen()

isFullscreen(): Promise<boolean>

Obtiene el estado actual de pantalla completa de la ventana.

Devuelve

Promise<boolean>

Si la ventana está en modo de pantalla completa o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L639

isMaximizable()

isMaximizable(): Promise<boolean>

Obtiene el estado del botón nativo de maximizar de la ventana.

Específico de la plataforma

• Linux / iOS / Android: No soportado.

Devuelve

Promise<boolean>

Si el botón nativo de maximizar de la ventana está habilitado o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L738

isMaximized()

isMaximized(): Promise<boolean>

Obtiene el estado actual de maximizado de la ventana.

Devuelve

Promise<boolean>

Si la ventana está maximizada o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L669

isMinimizable()

isMinimizable(): Promise<boolean>

Obtiene el estado del botón nativo de minimizar de la ventana.

Específico de la plataforma

• Linux / iOS / Android: No soportado.

Devuelve

Promise<boolean>

Si el botón nativo de minimizar de la ventana está habilitado o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L759

isMinimized()

isMinimized(): Promise<boolean>

Obtiene el estado actual de minimizado de la ventana.

Devuelve

Promise<boolean>

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L653

isResizable()

isResizable(): Promise<boolean>

Obtiene el estado actual de redimensionable de la ventana.

Devuelve

Promise<boolean>

Si la ventana es redimensionable o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L717

isVisible()

isVisible(): Promise<boolean>

Obtiene el estado de visibilidad actual de la ventana.

Devuelve

Promise<boolean>

Si la ventana es visible o no.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L796

listen()

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

Escucha un evento emitido en esta ventana.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	EventName	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
handler	EventCallback<T>	Manejador de eventos (event handler).

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/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();

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L417

maximize()

maximize(): Promise<void>

Maximiza la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1072

minimize()

minimize(): Promise<void>

Minimiza la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1120

onCloseRequested()

onCloseRequested(handler): Promise<UnlistenFn>

Escucha la solicitud de cierre de ventana. Emitido cuando el usuario solicita cerrar la ventana.

Parámetros

Parámetro	Tipo
handler	(event) => void | Promise<void>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1927

onDragDropEvent()

onDragDropEvent(handler): Promise<UnlistenFn>

Escucha un evento de arrastrar y soltar archivo. El oyente (listener) se activa cuando el usuario pasa los archivos seleccionados sobre el webview, suelta los archivos o cancela la operación.

Parámetros

Parámetro	Tipo
handler	EventCallback<DragDropEvent>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1965

onFocusChanged()

onFocusChanged(handler): Promise<UnlistenFn>

Escucha el cambio de foco de la ventana.

Parámetros

Parámetro	Tipo
handler	EventCallback<boolean>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2043

onMoved()

onMoved(handler): Promise<UnlistenFn>

Escucha el movimiento de la ventana.

Parámetros

Parámetro	Tipo
handler	EventCallback<PhysicalPosition>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1898

onResized()

onResized(handler): Promise<UnlistenFn>

Escucha la redimensión de la ventana.

Parámetros

Parámetro	Tipo
handler	EventCallback<PhysicalSize>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1874

onScaleChanged()

onScaleChanged(handler): Promise<UnlistenFn>

Escucha el cambio de escala de la ventana. Emitido cuando el factor de escala de la ventana ha cambiado. Las siguientes acciones del usuario pueden causar cambios de DPI:

• Cambiar la resolución de la pantalla.
• Cambiar el factor de escala de la pantalla (p. ej. en el Panel de Control en Windows).
• Mover la ventana a una pantalla con un factor de escala diferente.

Parámetros

Parámetro	Tipo
handler	EventCallback<ScaleFactorChanged>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2083

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>

Escucha el cambio de tema del sistema.

Parámetros

Parámetro	Tipo
handler	EventCallback<Theme>

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

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

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2109

once()

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

Escucha un evento emitido en esta ventana solo una vez.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	EventName	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
handler	EventCallback<T>	Manejador de eventos (event handler).

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/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();

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L452

outerPosition()

outerPosition(): Promise<PhysicalPosition>

La posición de la esquina superior izquierda de la ventana con respecto a la esquina superior izquierda del escritorio.

Devuelve

Promise<PhysicalPosition>

La posición exterior de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L583

outerSize()

outerSize(): Promise<PhysicalSize>

El tamaño físico de toda la ventana. Estas dimensiones incluyen la barra de título y los bordes. Si no deseas eso (y generalmente no lo deseas), usa inner_size en su lugar.

Devuelve

Promise<PhysicalSize>

El tamaño exterior de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L620

requestUserAttention()

requestUserAttention(requestType): Promise<void>

Solicita la atención del usuario hacia la ventana, esto no tiene efecto si la aplicación ya tiene el foco. Cómo se manifiesta la solicitud de atención del usuario depende de la plataforma, consulta UserAttentionType para obtener detalles.

Proporcionar null desmarcará la solicitud de atención del usuario. Desmarcar la solicitud de atención del usuario puede no ser realizado automáticamente por el WM cuando la ventana recibe entrada.

Específico de la plataforma

• macOS: null no tiene efecto.
• Linux: Los niveles de urgencia tienen el mismo efecto.

Parámetros

Parámetro	Tipo
requestType	null | UserAttentionType

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L903

scaleFactor()

scaleFactor(): Promise<number>

El factor de escala que se puede usar para mapear píxeles físicos a píxeles lógicos.

Devuelve

Promise<number>

El factor de escala del monitor de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L551

sceneIdentifier()

sceneIdentifier(): Promise<string>

Devuelve

Promise<string>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L859

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise<void>

Si la ventana siempre debe estar por debajo de otras ventanas.

Parámetros

Parámetro	Tipo	Descripción
alwaysOnBottom	boolean	Si la ventana debe estar siempre debajo de otras ventanas o no.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1301

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>

Si la ventana siempre debe estar por encima de otras ventanas.

Parámetros

Parámetro	Tipo	Descripción
alwaysOnTop	boolean	Si la ventana debe estar siempre encima de otras ventanas o no.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1283

setBackgroundColor()

setBackgroundColor(color): Promise<void>

Establece el color de fondo de la ventana.

Específico de la plataforma:

• Windows: el canal alfa es ignorado.
• iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
color	Color

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Desde

2.1.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1635

setBadgeCount()

setBadgeCount(count?): Promise<void>

Establece el recuento de notificaciones (badge count). Es para toda la app y no específico de esta ventana.

Específico de la plataforma

• Windows: No soportado. Usa @{linkcode Window.setOverlayIcon} en su lugar.

Parámetros

Parámetro	Tipo	Descripción
count?	number	El recuento de notificaciones (badge count). Usa undefined para eliminar el badge.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1727

setBadgeLabel()

setBadgeLabel(label?): Promise<void>

Establece la etiqueta de notificación (badge label) solo macOS.

Parámetros

Parámetro	Tipo	Descripción
label?	string	La etiqueta de notificación (badge label). Usa undefined para eliminar el badge.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1746

setClosable()

setClosable(closable): Promise<void>

Establece si el botón nativo de cierre de la ventana está habilitado o no.

Específico de la plataforma

• Linux: GTK+ hará todo lo posible por convencer al gestor de ventanas de no mostrar un botón de cierre. Dependiendo del sistema, esta función puede no tener ningún efecto cuando se llama en una ventana que ya es visible
• iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
closable	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1037

setContentProtected()

setContentProtected(protected_): Promise<void>

Evita que el contenido de la ventana sea capturado por otras aplicaciones.

Parámetros

Parámetro	Tipo
protected_	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1318

setCursorGrab()

setCursorGrab(grab): Promise<void>

Captura el cursor, evitando que salga de la ventana.

No hay garantía de que el cursor se oculte. Deberías ocultarlo tú mismo si así lo deseas.

Específico de la plataforma

• Linux: No soportado.
• macOS: Esto bloquea el cursor en una ubicación fija, lo cual resulta visualmente extraño.

Parámetros

Parámetro	Tipo	Descripción
grab	boolean	true para capturar el icono del cursor, false para liberarlo.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1574

setCursorIcon()

setCursorIcon(icon): Promise<void>

Modifica el icono del cursor de la ventana.

Parámetros

Parámetro	Tipo	Descripción
icon	CursorIcon	El nuevo icono del cursor.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setCursorIcon('help');

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1616

setCursorPosition()

setCursorPosition(position): Promise<void>

Cambia la posición del cursor en coordenadas de la ventana.

Parámetros

Parámetro	Tipo	Descripción
position	LogicalPosition | PhysicalPosition | Position	La nueva posición del cursor.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1650

setCursorVisible()

setCursorVisible(visible): Promise<void>

Modifica la visibilidad del cursor.

Específico de la plataforma

• Windows: El cursor solo se oculta dentro de los límites de la ventana.
• macOS: El cursor se oculta mientras la ventana tenga el foco de entrada, incluso si el cursor está fuera de la ventana.

Parámetros

Parámetro	Tipo	Descripción
visible	boolean	Si es false, esto ocultará el cursor. Si es true, esto mostrará el cursor.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1598

setDecorations()

setDecorations(decorations): Promise<void>

Si la ventana debe tener bordes y barras.

Parámetros

Parámetro	Tipo	Descripción
decorations	boolean	Si la ventana debe tener bordes y barras.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1219

setEffects()

setEffects(effects): Promise<void>

Establece los efectos de la ventana.

Parámetros

Parámetro	Tipo
effects	Effects

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1255

setEnabled()

setEnabled(enabled): Promise<void>

Habilita o deshabilita la ventana.

Parámetros

Parámetro	Tipo
enabled	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L950

setFocus()

setFocus(): Promise<void>

Trae la ventana al frente y le da el foco.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1476

setFocusable()

setFocusable(focusable): Promise<void>

Establece si la ventana puede recibir el foco.

Específico de la plataforma

• macOS: Si la ventana ya tiene el foco, no es posible desfocalizarla después de llamar a set_focusable(false). En este caso, podrías considerar llamar a Window.setFocus pero moverá la ventana al fondo, es decir, al final en términos de orden z.

Parámetros

Parámetro	Tipo	Descripción
focusable	boolean	Si la ventana puede recibir el foco.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1499

setFullscreen()

setFullscreen(fullscreen): Promise<void>

Establece el estado de pantalla completa de la ventana.

Parámetros

Parámetro	Tipo	Descripción
fullscreen	boolean	Si la ventana debe pasar a pantalla completa o no.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1443

setIcon()

setIcon(icon): Promise<void>

Establece el icono de la ventana.

Parámetros

Parámetro	Tipo	Descripción
icon	| string | Uint8Array | number[] | ArrayBuffer | Image	Bytes del icono o ruta al archivo de icono.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Ten en cuenta que es posible que necesites las características (features) de Cargo image-ico o image-png para usar esta API. Para habilitarla, cambia tu archivo Cargo.toml:

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1524

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>

Cambia el comportamiento de los eventos del cursor.

Parámetros

Parámetro	Tipo	Descripción
ignore	boolean	true para ignorar los eventos del cursor; false para procesarlos de forma habitual.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1671

setMaxSize()

setMaxSize(size): Promise<void>

Establece el tamaño interior máximo de la ventana. Si el argumento size no se proporciona, la restricción se desmarca.

Parámetros

Parámetro	Tipo	Descripción
size	| undefined | null | LogicalSize | PhysicalSize | Size	El tamaño interior lógico o físico, o null para desmarcar la restricción.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1374

setMaximizable()

setMaximizable(maximizable): Promise<void>

Establece si el botón nativo de maximizar de la ventana está habilitado o no. Si resizable está configurado en false, esta configuración se ignora.

Específico de la plataforma

• macOS: Deshabilita el botón de “zoom” en la barra de título de la ventana, que también se usa para entrar en modo de pantalla completa.
• Linux / iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
maximizable	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L992

setMinSize()

setMinSize(size): Promise<void>

Establece el tamaño interior mínimo de la ventana. Si no se proporciona el argumento size, la restricción se desmarca.

Parámetros

Parámetro	Tipo	Descripción
size	| undefined | null | LogicalSize | PhysicalSize | Size	El tamaño interior lógico o físico, o null para desmarcar la restricción.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1354

setMinimizable()

setMinimizable(minimizable): Promise<void>

Establece si el botón nativo de minimizar de la ventana está habilitado o no.

Específico de la plataforma

• Linux / iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
minimizable	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1014

setOverlayIcon()

setOverlayIcon(icon?): Promise<void>

Establece el icono superpuesto (overlay icon). Solo Windows El icono superpuesto se puede configurar para cada ventana.

Ten en cuenta que es posible que necesites las características (features) de Cargo image-ico o image-png para usar esta API. Para habilitarla, cambia tu archivo Cargo.toml:

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

Parámetros

Parámetro	Tipo	Descripción
icon?	| string | Uint8Array | number[] | ArrayBuffer | Image	Bytes del icono o ruta al archivo de icono. Usa undefined para eliminar el icono superpuesto.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setOverlayIcon("/tauri/awesome.png");

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1775

setPosition()

setPosition(position): Promise<void>

Establece la posición exterior de la ventana.

Parámetros

Parámetro	Tipo	Descripción
position	LogicalPosition | PhysicalPosition | Position	La nueva posición, en píxeles lógicos o físicos.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1423

setProgressBar()

setProgressBar(state): Promise<void>

Establece el estado de progreso en la barra de tareas.

Específico de la plataforma

• Linux / macOS: La barra de progreso es para toda la app y no específica de esta ventana.
• Linux: Solo se admite en entornos de escritorio con libunity (p. ej. GNOME).

Parámetros

Parámetro	Tipo
state	ProgressBarState

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1803

setResizable()

setResizable(resizable): Promise<void>

Actualiza la flag de redimensionable de la ventana.

Parámetros

Parámetro	Tipo
resizable	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L931

setShadow()

setShadow(enable): Promise<void>

Si la ventana debe tener sombra o no.

Específico de la plataforma

• Windows:
  • false no tiene efecto en una ventana decorada, las sombras siempre están ACTIVADAS.
  • true hará que la ventana sin decoraciones tenga un borde blanco de 1px, y en Windows 11, tendrá esquinas redondeadas.
• Linux: No soportado.

Parámetros

Parámetro	Tipo
enable	boolean

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1245

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): Promise<void>

En macOS, alterna un modo de pantalla completa que no requiere un nuevo espacio de macOS. Devuelve un booleano que indica si la transición fue exitosa (esto no funcionará si la ventana ya estaba en pantalla completa nativa). Así es como solía funcionar la pantalla completa en macOS en versiones anteriores a Lion. Y permite al usuario tener una ventana en pantalla completa sin usar otro espacio ni tomar control de todo el monitor.

En otras plataformas, esto es lo mismo que Window.setFullscreen.

Parámetros

Parámetro	Tipo	Descripción
fullscreen	boolean	Si la ventana debe pasar a pantalla completa simple o no.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1459

setSize()

setSize(size): Promise<void>

Redimensiona la ventana con un nuevo tamaño interior.

Parámetros

Parámetro	Tipo	Descripción
size	LogicalSize | PhysicalSize | Size	El tamaño interior lógico o físico.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1336

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>

Establece las restricciones de tamaño interior de la ventana.

Parámetros

Parámetro	Tipo	Descripción
constraints	undefined | null | WindowSizeConstraints	El tamaño interior lógico o físico, o null para desmarcar la restricción.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { getCurrentWindow } from '@tauri-apps/api/window';
await getCurrentWindow().setSizeConstraints({ minWidth: 300 });

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1394

setSkipTaskbar()

setSkipTaskbar(skip): Promise<void>

Si el icono de la ventana debe ocultarse de la barra de tareas o no.

Específico de la plataforma

• macOS: No soportado.

Parámetros

Parámetro	Tipo	Descripción
skip	boolean	true para ocultar el icono de la ventana, false para mostrarlo.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1548

setTheme()

setTheme(theme?): Promise<void>

Establece el tema de la ventana, pasa null o undefined para seguir el tema del sistema

Específico de la plataforma

• Linux / macOS: El tema es para toda la app y no específico de esta ventana.
• iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
theme?	null | Theme

Devuelve

Promise<void>

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1848

setTitle()

setTitle(title): Promise<void>

Establece el título de la ventana.

Parámetros

Parámetro	Tipo	Descripción
title	string	El nuevo título

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1055

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>

Establece el estilo de la barra de título. Solo macOS.

Parámetros

Parámetro	Tipo
style	TitleBarStyle

Devuelve

Promise<void>

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1831

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible): Promise<void>

Establece si la ventana debe ser visible en todos los espacios de trabajo o escritorios virtuales.

Específico de la plataforma

• Windows / iOS / Android: No soportado.

Parámetros

Parámetro	Tipo
visible	boolean

Devuelve

Promise<void>

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1819

show()

show(): Promise<void>

Establece la visibilidad de la ventana en true.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1152

startDragging()

startDragging(): Promise<void>

Inicia el arrastre de la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1688

startResizeDragging()

startResizeDragging(direction): Promise<void>

Inicia el arrastre para redimensionar la ventana.

Parámetros

Parámetro	Tipo
direction	ResizeDirection

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1704

theme()

theme(): Promise<null | Theme>

Obtiene el tema actual de la ventana.

Específico de la plataforma

• macOS: El tema se introdujo en macOS 10.14. Devuelve light en macOS 10.13 e inferiores.

Devuelve

Promise<null | Theme>

El tema de la ventana.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L831

title()

title(): Promise<string>

Obtiene el título actual de la ventana.

Devuelve

Promise<string>

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L810

toggleMaximize()

toggleMaximize(): Promise<void>

Alterna el estado maximizado de la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1104

unmaximize()

unmaximize(): Promise<void>

Desmaximiza la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1088

unminimize()

unminimize(): Promise<void>

Desminimiza la ventana.

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L1136

getAll()

static getAll(): Promise<Window[]>

Obtiene una lista de instancias de Window para todas las ventanas disponibles.

Devuelve

Promise<Window[]>

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L375

getByLabel()

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

Obtiene la Window asociada con la etiqueta dada.

Parámetros

Parámetro	Tipo	Descripción
label	string	La etiqueta de la ventana.

Devuelve

Promise<null | Window>

La instancia de Window para comunicarse con la ventana o null si la ventana no existe.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L361

getCurrent()

static getCurrent(): Window

Obtén una instancia de Window para la ventana actual.

Devuelve

Window

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L368

getFocusedWindow()

static getFocusedWindow(): Promise<null | Window>

Obtiene la ventana enfocada.

Devuelve

Promise<null | Window>

La instancia de Window o undefined si no hay ninguna ventana enfocada.

Ejemplo

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L389

Interfaces

Efectos

El objeto de configuración de efectos de ventana

Desde

2.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
color?	Color	Color del efecto de ventana. Afecta a Effect.Blur y Effect.Acrylic únicamente en Windows 10 v1903+. No tiene ningún efecto en Windows 7 o Windows 11.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2331
effects	Effect[]	Lista de efectos de Window para aplicar a la Window. Los efectos en conflicto aplicarán el primero e ignorarán el resto.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2318
radius?	number	Radio de las esquinas del efecto de ventana Solo macOS	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2326
state?	EffectState	Estado del efecto de ventana Solo macOS	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2322

---

Monitor

Te permite recuperar información sobre un monitor dado.

Desde

1.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
name	null | string	Nombre legible por humanos del monitor	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L49
position	PhysicalPosition	La posición de la esquina superior izquierda del monitor relativa al área de pantalla completa más grande, en píxeles físicos. Ten en cuenta que las opciones de creación de ventana como x, y, width y height esperan píxeles lógicos, por lo que primero convierte con Monitor.scaleFactor: import { currentMonitor } from '@tauri-apps/api/window'; import { WebviewWindow } from '@tauri-apps/api/webviewWindow'; const monitor = await currentMonitor(); if (monitor) { const position = monitor.position.toLogical(monitor.scaleFactor); const webview = new WebviewWindow('my-label', { x: position.x, y: position.y }); }	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L75
scaleFactor	number	El factor de escala que se puede usar para mapear píxeles físicos a píxeles lógicos, p. ej. monitor.position.toLogical(monitor.scaleFactor).	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L90
size	PhysicalSize	La resolución del monitor en píxeles físicos. Usa Monitor.scaleFactor para convertir a píxeles lógicos: const logicalSize = monitor.size.toLogical(monitor.scaleFactor);	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L58
workArea	object	El área de trabajo del monitor (el área del monitor excluyendo barras de tareas y docks) en píxeles físicos. Usa Monitor.scaleFactor para convertir a píxeles lógicos como se muestra en Monitor.position.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L82
workArea.position	PhysicalPosition	-	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L83
workArea.size	PhysicalSize	-	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L84

---

ProgressBarState

Propiedades

Propiedad	Tipo	Descripción	Definido en
progress?	number	El progreso de la barra de progreso. Puede ser un valor que vaya de 0 a 100	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L238
status?	ProgressBarStatus	El estado de la barra de progreso.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L234

---

ScaleFactorChanged

La carga útil para el evento scaleChange.

Desde

1.0.2

Propiedades

Propiedad	Tipo	Descripción	Definido en
scaleFactor	number	El nuevo factor de escala de la ventana.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L113
size	PhysicalSize	El nuevo tamaño de la ventana	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L115

---

WindowOptions

Configuración para la ventana a crear.

Desde

1.0.0

Propiedades

Propiedad	Tipo	Descripción	Definido en
activityName?	string	El nombre de la actividad de Android a crear para esta ventana.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2568
allowLinkPreview?	boolean	En macOS e iOS hay una vista previa de enlaces al mantener presionados los enlaces, esto está habilitado por defecto. consulta https://docs.rs/objc2-web-kit/latest/objc2_web_kit/struct.WKWebView.html#method.allowsLinkPreview	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2542
alwaysOnBottom?	boolean	Si la ventana siempre debe estar por debajo de otras ventanas.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2408
alwaysOnTop?	boolean	Si la ventana debe estar siempre encima de otras ventanas o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2406
backgroundColor?	Color	Establece el color de fondo de la ventana. Específico de la plataforma: - Android / iOS: No soportado. - Windows: el canal alfa es ignorado. Desde 2.1.0	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2519
backgroundThrottling?	BackgroundThrottlingPolicy	Cambia el comportamiento por defecto de limitación en segundo plano. ## Específico de la plataforma - Linux / Windows / Android: No soportado. Alternativas como una transacción WebLock pendiente podrían ser suficientes. - iOS: Soportado desde la versión 17.0+. - macOS: Soportado desde la versión 14.0+. consulta https://github.com/tauri-apps/tauri/issues/5250#issuecomment-2569380578 Desde 2.3.0	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2533
center?	boolean	Muestra la ventana en el centro de la pantalla.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2349
closable?	boolean	Si el botón de cierre nativo de la ventana está habilitado o no. Por defecto es true.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2474
contentProtected?	boolean	Evita que el contenido de la ventana sea capturado por otras aplicaciones.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2410
createdByActivityName?	string	El nombre de la actividad de Android que está creando esta ventana webview. Esto es importante para determinar a qué pila pertenecerá la actividad.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2574
decorations?	boolean	Si la ventana debe tener bordes y barras o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2404
disableInputAccessoryView?	boolean	Permite desactivar la vista accesoria de entrada (input accessory view) en iOS. La vista accesoria es la vista que aparece sobre el teclado cuando se enfoca un elemento de entrada de texto. Generalmente muestra una vista con botones "Hecho", "Siguiente".	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2549
focus?	boolean	Si la ventana estará enfocada inicialmente o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2388
focusable?	boolean	Si la ventana puede enfocarse o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2390
fullscreen?	boolean	Si la ventana está en modo de pantalla completa o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2386
height?	number	La altura inicial en píxeles lógicos.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2357
hiddenTitle?	boolean	Si es true, establece que el título de la ventana se oculte en macOS.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2455
javascriptDisabled?	boolean	Si debemos deshabilitar la ejecución de código JavaScript en la webview o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2537
maxHeight?	number	La altura máxima en píxeles lógicos. Solo se aplica si maxWidth también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2365
maxWidth?	number	El ancho máximo en píxeles lógicos. Solo se aplica si maxHeight también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2363
maximizable?	boolean	Si el botón nativo de maximizar de la ventana está habilitado o no. Por defecto es true.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2466
maximized?	boolean	Si la ventana debe maximizarse al crearse o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2400
minHeight?	number	La altura mínima en píxeles lógicos. Solo se aplica si minWidth también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2361
minWidth?	number	El ancho mínimo en píxeles lógicos. Solo se aplica si minHeight también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2359
minimizable?	boolean	Si el botón nativo de minimizar de la ventana está habilitado o no. Por defecto es true.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2470
noRedirectionBitmap?	boolean	Esto establece WS_EX_NOREDIRECTIONBITMAP. Esto puede evitar el destello blanco que puede aparecer antes de que se renderice el contenido de la webview al usar una ventana transparente. Solo Windows.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2419
parent?	string | Window | WebviewWindow	Establece un padre para la ventana que se va a crear. Puede ser un Window o una etiqueta de la ventana. Específico de la plataforma - Windows: Esto establece el padre pasado como ventana propietaria para la ventana a crear. Según la documentación de ventanas propietarias de MSDN: - Una ventana propietaria siempre está por encima de su propietario en el orden Z. - El sistema destruye automáticamente una ventana propietaria cuando se destruye a su propietario. - Una ventana propietaria se oculta cuando su propietario se minimiza. - Linux: Esto hace que la nueva ventana sea transitoria para el padre, consulta https://docs.gtk.org/gtk3/method.Window.set_transient_for.html - macOS: Esto agrega la ventana como un hijo del padre, consulta https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2488
preventOverflow?	boolean | PreventOverflowMargin	Evita que la ventana desborde el área de trabajo (p. ej. tamaño del monitor - tamaño de la barra de tareas) al crearse, lo que significa que el tamaño de la ventana estará limitado a tamaño del monitor - tamaño de la barra de tareas. Puede configurarse en true o en un objeto PreventOverflowMargin para establecer un margen adicional que debe considerarse para determinar el área de trabajo (en este caso el tamaño de la ventana estará limitado a tamaño del monitor - tamaño de la barra de tareas - margen). NOTA: La comprobación de desbordamiento solo se realiza al crear la ventana, los cambios de tamaño aún pueden desbordar. Específico de la plataforma - iOS / Android: No soportado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2380
requestedBySceneIdentifier?	string	Establece el identificador de la UIScene que está solicitando la creación de esta nueva escena, estableciendo una relación entre las dos escenas. Por defecto, el sistema usa la escena en primer plano.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2581
resizable?	boolean	Si la ventana es redimensionable o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2382
scrollBarStyle?	ScrollBarStyle	Especifica el estilo nativo de la barra de desplazamiento que se utilizará con el webview. Los estilos CSS que modifican la barra de desplazamiento se aplican sobre la apariencia nativa configurada aquí. Por defecto es default, que es el valor predeterminado del navegador. ## Específico de la plataforma - Windows: - fluentOverlay requiere la versión 125.0.2535.41 o superior del Runtime de WebView2, y no hace nada en versiones anteriores. - Esta opción debe recibir el mismo valor para todos los webviews. - Linux / Android / iOS / macOS: No soportado. Solo soporta Default y no realiza ninguna operación.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2564
shadow?	boolean	Si la ventana tiene sombra o no. Específico de la plataforma - Windows: - false no tiene efecto en ventanas con decoraciones, las sombras siempre están ACTIVADAS. - true hará que las ventanas sin decoraciones tengan un borde blanco de 1px, y en Windows 11, tendrán esquinas redondeadas. - Linux: No soportado. Desde 2.0.0	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2433
skipTaskbar?	boolean	Si se debe agregar o no el icono de la ventana a la barra de tareas.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2412
tabbingIdentifier?	string	Define el identificador de pestañas de la ventana en macOS. Las ventanas con el mismo identificador de pestañas se agruparán. Si el identificador de pestañas no está configurado, las pestañas automáticas estarán deshabilitadas.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2462
theme?	Theme	El tema inicial de la ventana. Por defecto toma el tema del sistema. Solo implementado en Windows y macOS 10.14+.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2439
title?	string	Título de la ventana.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2384
titleBarStyle?	TitleBarStyle	El estilo de la barra de título de macOS.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2443
trafficLightPosition?	LogicalPosition	La posición de los controles de la ventana en macOS. Requiere titleBarStyle: 'overlay' y decorations: true. Desde 2.4.0	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2451
transparent?	boolean	Si la ventana es transparente o no. Ten en cuenta que en macOS esto requiere el flag de característica macos-private-api, habilitado en tauri.conf.json > app > macOSPrivateApi. ADVERTENCIA: El uso de APIs privadas en macOS evita que tu aplicación sea aceptada en la App Store. En Windows, usar noRedirectionBitmap puede ayudar a evitar un destello blanco al crear una ventana transparente.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2398
visible?	boolean	Si la ventana debe ser visible inmediatamente al crearse o no.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2402
visibleOnAllWorkspaces?	boolean	Si la ventana debe ser visible en todos los espacios de trabajo o escritorios virtuales. Específico de la plataforma - Windows / iOS / Android: No soportado. Desde 2.0.0	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2497
width?	number	El ancho inicial en píxeles lógicos.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2355
windowEffects?	Effects	Efectos de ventana. Requiere que la ventana sea transparente. Específico de la plataforma: - Windows: Si usas decoraciones o sombras, podrías probar esta alternativa https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891 - Linux: No soportado	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2508
x?	number	La posición vertical inicial en píxeles lógicos. Solo se aplica si y también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2351
y?	number	La posición horizontal inicial en píxeles lógicos. Solo se aplica si x también está configurado.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2353

---

WindowSizeConstraints

Propiedades

Propiedad	Tipo	Definido en
maxHeight?	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L227
maxWidth?	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L226
minHeight?	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L225
minWidth?	number	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L224

Alias de tipos

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";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L159

---

Theme

type Theme: "light" | "dark";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L93

---

TitleBarStyle

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

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L94

Funciones

availableMonitors()

function availableMonitors(): Promise<Monitor[]>

Devuelve la lista de todos los monitores disponibles en el sistema.

Devuelve

Promise<Monitor[]>

Ejemplo

import { availableMonitors } from '@tauri-apps/api/window';
const monitors = await availableMonitors();

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2660

---

currentMonitor()

function currentMonitor(): Promise<Monitor | null>

Devuelve el monitor en el que reside actualmente la ventana. Devuelve null si no se puede detectar el monitor actual.

Devuelve

Promise<Monitor | null>

Ejemplo

import { currentMonitor } from '@tauri-apps/api/window';
const monitor = await currentMonitor();

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2610

---

cursorPosition()

function cursorPosition(): Promise<PhysicalPosition>

Obtiene la posición del cursor relativa a la esquina superior izquierda del escritorio.

Ten en cuenta que la esquina superior izquierda del escritorio no es necesariamente la misma que la de la pantalla. Si el usuario usa un escritorio con múltiples monitores, la esquina superior izquierda del escritorio es la esquina superior izquierda del monitor principal en Windows y macOS o la parte superior izquierda del monitor más a la izquierda en X11.

Las coordenadas pueden ser negativas si la esquina superior izquierda de la ventana está fuera de la región visible de la pantalla.

Devuelve

Promise<PhysicalPosition>

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2676

---

getAllWindows()

function getAllWindows(): Promise<Window[]>

Obtiene una lista de instancias de Window para todas las ventanas disponibles.

Devuelve

Promise<Window[]>

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L258

---

getCurrentWindow()

function getCurrentWindow(): Window

Obtén una instancia de Window para la ventana actual.

Devuelve

Window

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L246

---

monitorFromPoint()

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

Devuelve el monitor que contiene el punto dado. Devuelve null si no puede encontrar ninguno.

Parámetros

Parámetro	Tipo
x	number
y	number

Devuelve

Promise<Monitor | null>

Ejemplo

import { monitorFromPoint } from '@tauri-apps/api/window';
const monitor = await monitorFromPoint(100.0, 200.0);

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2643

---

primaryMonitor()

function primaryMonitor(): Promise<Monitor | null>

Devuelve el monitor principal del sistema. Devuelve null si no puede identificar ningún monitor como principal.

Devuelve

Promise<Monitor | null>

Ejemplo

import { primaryMonitor } from '@tauri-apps/api/window';
const monitor = await primaryMonitor();

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2627