webviewWindow

Referencias

Color

Re-exporta Color

DragDropEvent

Re-exporta DragDropEvent

Clases

WebviewWindow

Crea un nuevo webview u obtiene una referencia (handle) a uno existente.

Los webviews se identifican mediante una etiqueta (label), un identificador único que se puede usar para referenciarlo más tarde. Solo puede contener caracteres alfanuméricos a-zA-Z además de los siguientes caracteres especiales -, /, : y _.

Ejemplo

import { Window } from "@tauri-apps/api/window"
import { Webview } from "@tauri-apps/api/webview"

const appWindow = new Window('uniqueLabel');

appWindow.once('tauri://created', async function () {
  // `new Webview` Should be called after the window is successfully created,
  // or webview may not be attached to the window since window is not created yet.

  // loading embedded asset:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'path/to/page.html',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });
  // alternatively, load a remote URL:
  const webview = new Webview(appWindow, 'theUniqueLabel', {
    url: 'https://github.com/tauri-apps/tauri',

    // create a webview with specific logical position and size
    x: 0,
    y: 0,
    width: 800,
    height: 600,
  });

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

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

Desde

2.0.0

Extiende

• Webview.Window

Constructores

new WebviewWindow()

new WebviewWindow(label, options): WebviewWindow

Crea una nueva Window que aloja un Webview.

Parámetros

Parámetro	Tipo	Descripción
label	string	La etiqueta (label) única del webview. Debe ser alfanumérica: a-zA-Z-/:_.
options	Omit<WebviewOptions, "x" | "y" | "width" | "height"> & WindowOptions	-

Devuelve

WebviewWindow

La instancia de WebviewWindow para comunicarse con la ventana y el webview.

Ejemplo

import { WebviewWindow } from '@tauri-apps/api/webviewWindow'
const webview = new WebviewWindow('my-label', {
  url: 'https://github.com/tauri-apps/tauri'
});
webview.once('tauri://created', function () {
 // webview successfully created
});
webview.once('tauri://error', function (e) {
 // an error happened creating the webview
});

Heredado de

Window.constructor

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

Propiedades

Propiedad	Tipo	Descripción	Heredado de	Definido en
label	string	La etiqueta (label) del webview. Es un identificador único para el webview y se puede usar para referenciarlo más tarde.	Window.etiqueta (label)	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L51
listeners	Registro (Record)<string, EventCallback<any>[]>	Oyentes de eventos (event listeners) locales.	Window.oyentes (listeners)	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webviewWindow.ts#L54
window	Window	La ventana que aloja este webview.	Webview.window	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L157

Métodos

activityName()

activityName(): Promise<string>

Devuelve

Promise<string>

Heredado de

Window.activityName

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();

Heredado de

Window.center

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

clearAllBrowsingData()

clearAllBrowsingData(): Promise<void>

Borra todos los datos de navegación de este webview.

Devuelve

Promise<void>

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

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().clearAllBrowsingData();

Heredado de

Webview.clearAllBrowsingData

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

clearEffects()

clearEffects(): Promise<void>

Borra cualquier efecto aplicado si es posible.

Devuelve

Promise<void>

Heredado de

Window.clearEffects

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

close()

close(): Promise<void>

Cierra el webview.

Devuelve

Promise<void>

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

Ejemplo

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

Heredado de

Window.close

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

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();

Heredado de

Window.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 { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().emit('webview-loaded', { loggedIn: true, token: 'authToken' });

Heredado de

Window.emit

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

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 { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().emitTo('main', 'webview-loaded', { loggedIn: true, token: 'authToken' });

Heredado de

Window.emitTo

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

hide()

hide(): Promise<void>

Oculta el webview.

Devuelve

Promise<void>

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

Ejemplo

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

Heredado de

Window.hide

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

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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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

Heredado de

Window.isEnabled

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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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 webview.

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 { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().listen<string>('state-changed', (event) => {
  console.log(`Got error: ${payload}`);
});

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

Heredado de

Window.listen

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

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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.onCloseRequested

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 { getCurrentWebview } from "@tauri-apps/api/webview";
const unlisten = await getCurrentWebview().onDragDropEvent((event) => {
 if (event.payload.type === 'over') {
   console.log('User hovering', event.payload.position);
 } else if (event.payload.type === 'drop') {
   console.log('User dropped', event.payload.paths);
 } else {
   console.log('File drop cancelled');
 }
});

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

Cuando el panel del depurador está abierto, la posición de soltado de este evento puede ser imprecisa debido a una limitación conocida. Para obtener la posición de soltado correcta, desacopla el depurador.

Heredado de

Window.onDragDropEvent

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

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();

Heredado de

Window.onFocusChanged

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();

Heredado de

Window.onMoved

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();

Heredado de

Window.onResized

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();

Heredado de

Window.onScaleChanged

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();

Heredado de

Window.onThemeChanged

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 webview 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 { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const unlisten = await WebviewWindow.getCurrent().once<null>('initialized', (event) => {
  console.log(`Webview initialized!`);
});

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

Heredado de

Window.once

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

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();

Heredado de

Window.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();

Heredado de

Window.outerSize

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

position()

position(): Promise<PhysicalPosition>

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

Devuelve

Promise<PhysicalPosition>

La posición del webview.

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
const position = await getCurrentWebview().position();

Heredado de

Webview.position

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

reparent()

reparent(window): Promise<void>

Mueve este webview a la etiqueta dada.

Parámetros

Parámetro	Tipo
window	string | Window | WebviewWindow

Devuelve

Promise<void>

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

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().reparent('other-window');

Heredado de

Webview.reparent

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

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();

Heredado de

Window.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();

Heredado de

Window.scaleFactor

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

sceneIdentifier()

sceneIdentifier(): Promise<string>

Devuelve

Promise<string>

Heredado de

Window.sceneIdentifier

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

Heredado de

Window.setAlwaysOnBottom

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

Heredado de

Window.setAlwaysOnTop

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

setAutoResize()

setAutoResize(autoResize): Promise<void>

Establece si el webview debe aumentar y reducir automáticamente su tamaño y posición cuando se redimensione la ventana padre.

Parámetros

Parámetro	Tipo
autoResize	boolean

Devuelve

Promise<void>

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

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setAutoResize(true);

Heredado de

Webview.setAutoResize

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

setBackgroundColor()

setBackgroundColor(color): Promise<void>

Establece el color de fondo de la ventana y de la webview.

Específico de la plataforma:

• Android / iOS: No soportado para la capa de la ventana.
• macOS / iOS: No implementado para la capa de webview.
• Windows:
  • el canal alfa se ignora para la capa de la ventana.
  • En Windows 7, el canal alfa se ignora para la capa de webview.
  • En Windows 8 y más reciente, si el canal alfa no es 0, se ignorará.

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

Heredado de

Window.setBackgroundColor

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

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

Heredado de

Window.setBadgeCount

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

Heredado de

Window.setBadgeLabel

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

Heredado de

Window.setClosable

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

Heredado de

Window.setContentProtected

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

Heredado de

Window.setCursorGrab

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

Heredado de

Window.setCursorIcon

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

Heredado de

Window.setCursorPosition

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

Heredado de

Window.setCursorVisible

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

Heredado de

Window.setDecorations

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>

Heredado de

Window.setEffects

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

Heredado de

Window.setEnabled

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

setFocus()

setFocus(): Promise<void>

Trae el webview 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 { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setFocus();

Heredado de

Window.setFocus

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

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

Heredado de

Window.setFocusable

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

Heredado de

Window.setFullscreen

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"] }

Heredado de

Window.setIcon

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

Heredado de

Window.setIgnoreCursorEvents

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

Heredado de

Window.setMaxSize

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

Heredado de

Window.setMaximizable

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

Heredado de

Window.setMinSize

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

Heredado de

Window.setMinimizable

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

Heredado de

Window.setOverlayIcon

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

setPosition()

setPosition(position): Promise<void>

Establece la posición del webview.

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 { getCurrent, LogicalPosition } from '@tauri-apps/api/webview';
await getCurrentWebview().setPosition(new LogicalPosition(600, 500));

Heredado de

Window.setPosition

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

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,
});

Heredado de

Window.setProgressBar

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

Heredado de

Window.setResizable

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

Heredado de

Window.setShadow

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.

Heredado de

Window.setSimpleFullscreen

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

setSize()

setSize(size): Promise<void>

Redimensiona el webview.

Parámetros

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

Devuelve

Promise<void>

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

Ejemplo

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

Heredado de

Window.setSize

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

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 });

Heredado de

Window.setSizeConstraints

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

Heredado de

Window.setSkipTaskbar

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

Heredado de

Window.setTheme

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

Heredado de

Window.setTitle

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

Heredado de

Window.setTitleBarStyle

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

Heredado de

Window.setVisibleOnAllWorkspaces

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

setZoom()

setZoom(scaleFactor): Promise<void>

Establece el nivel de zoom del webview.

Parámetros

Parámetro	Tipo
scaleFactor	number

Devuelve

Promise<void>

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

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
await getCurrentWebview().setZoom(1.5);

Heredado de

Webview.setZoom

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

show()

show(): Promise<void>

Muestra el webview.

Devuelve

Promise<void>

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

Ejemplo

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

Heredado de

Window.show

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

size()

size(): Promise<PhysicalSize>

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

Devuelve

Promise<PhysicalSize>

El tamaño del webview.

Ejemplo

import { getCurrentWebview } from '@tauri-apps/api/webview';
const size = await getCurrentWebview().size();

Heredado de

Webview.size

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

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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.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();

Heredado de

Window.unminimize

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

getAll()

static getAll(): Promise<WebviewWindow[]>

Obtiene una lista de instancias de Webview para todos los webviews disponibles.

Devuelve

Promise<WebviewWindow[]>

Heredado de

Window.getAll

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

getByLabel()

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

Obtiene el Webview para el webview asociado con la etiqueta dada.

Parámetros

Parámetro	Tipo	Descripción
label	string	La etiqueta del webview.

Devuelve

Promise<null | WebviewWindow>

La instancia de Webview para comunicarse con el webview o null si el webview no existe.

Ejemplo

import { WebviewWindow } from '@tauri-apps/api/webviewWindow';
const mainWebview = WebviewWindow.getByLabel('main');

Heredado de

Window.getByLabel

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

getCurrent()

static getCurrent(): WebviewWindow

Obtiene una instancia de Webview para el webview actual.

Devuelve

WebviewWindow

Heredado de

Window.getCurrent

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

Funciones

getAllWebviewWindows()

function getAllWebviewWindows(): Promise<WebviewWindow[]>

Obtiene una lista de instancias de Webview para todas las ventanas webview disponibles.

Devuelve

Promise<WebviewWindow[]>

Desde

2.0.0

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

---

getCurrentWebviewWindow()

function getCurrentWebviewWindow(): WebviewWindow

Obtiene una instancia de Webview para la ventana webview actual.

Devuelve

WebviewWindow

Desde

2.0.0

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