webview
Proporciona APIs para crear webviews, comunicarse con otros webviews y manipular el webview actual.
Eventos de Webview
Sección titulada “Eventos de Webview”Los eventos se pueden escuchar usando Webview.listen:
import { getCurrentWebview } from "@tauri-apps/api/webview";getCurrentWebview().listen("my-webview-event", ({ event, payload }) => { });Webview
Sección titulada “Webview”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
Sección titulada «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();});2.0.0
Extendido por
Sección titulada «Extendido por»Constructores
Sección titulada «Constructores»new Webview()
Sección titulada “new Webview()”new Webview( window, label, options): WebviewCrea un nuevo Webview.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Descripción |
|---|---|---|
window |
Window |
la ventana a la que se añadirá este webview. |
label |
string |
La etiqueta (label) única del webview. Debe ser alfanumérica: a-zA-Z-/:_. |
options |
WebviewOptions |
- |
Devuelve
Sección titulada «Devuelve»La instancia de Webview para comunicarse con el webview.
Ejemplo
Sección titulada «Ejemplo»import { Window } from '@tauri-apps/api/window'import { Webview } from '@tauri-apps/api/webview'const appWindow = new Window('my-label')
appWindow.once('tauri://created', async function() { const webview = new Webview(appWindow, 'my-label', { 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 });});Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L194
Propiedades
Sección titulada «Propiedades»| Propiedad | Tipo | Descripción | 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. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L155 |
listeners |
Registro (Record)<string, EventCallback<any>[]> |
Oyentes de eventos (event listeners) locales. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L160 |
window |
Window |
La ventana que aloja este webview. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L157 |
Métodos
Sección titulada «Métodos»clearAllBrowsingData()
Sección titulada “clearAllBrowsingData()”clearAllBrowsingData(): Promise<void>Borra todos los datos de navegación de este webview.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().clearAllBrowsingData();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L589
close()
Sección titulada «close()»close(): Promise<void>Cierra el webview.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().close();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L436
emit<T>(event, payload?): Promise<void>Emite un evento a todos los objetivos (targets).
Parámetros de tipo
Sección titulada «Parámetros de tipo»| Parámetro de tipo |
|---|
T |
Parámetros
Sección titulada «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
Sección titulada «Devuelve»Promise<void>
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().emit('webview-loaded', { loggedIn: true, token: 'authToken' });Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L325
emitTo()
Sección titulada “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
Sección titulada «Parámetros de tipo»| Parámetro de tipo |
|---|
T |
Parámetros
Sección titulada «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
Sección titulada «Devuelve»Promise<void>
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().emitTo('main', 'webview-loaded', { loggedIn: true, token: 'authToken' });Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L353
hide(): Promise<void>Oculta el webview.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().hide();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L523
listen()
Sección titulada “listen()”listen<T>(event, handler): Promise<UnlistenFn>Escucha un evento emitido en este webview.
Parámetros de tipo
Sección titulada «Parámetros de tipo»| Parámetro de tipo |
|---|
T |
Parámetros
Sección titulada «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
Sección titulada «Devuelve»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
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';const unlisten = await getCurrentWebview().listen<string>('state-changed', (event) => { console.log(`Got error: ${payload}`);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L262
onDragDropEvent()
Sección titulada “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
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
handler |
EventCallback<DragDropEvent> |
Devuelve
Sección titulada «Devuelve»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
Sección titulada «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 unmountedunlisten();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.
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L641
once<T>(event, handler): Promise<UnlistenFn>Escucha un evento emitido en este webview solo una vez.
Parámetros de tipo
Sección titulada «Parámetros de tipo»| Parámetro de tipo |
|---|
T |
Parámetros
Sección titulada «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
Sección titulada «Devuelve»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
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';const unlisten = await getCurrent().once<null>('initialized', (event) => { console.log(`Webview initialized!`);});
// you need to call unlisten if your handler goes out of scope e.g. the component is unmountedunlisten();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L297
position()
Sección titulada “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
Sección titulada «Devuelve»La posición del webview.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';const position = await getCurrentWebview().position();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L398
reparent()
Sección titulada “reparent()”reparent(window): Promise<void>Mueve este webview a la etiqueta dada.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
window |
string | Window | WebviewWindow |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().reparent('other-window');Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L572
setAutoResize()
Sección titulada “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
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
autoResize |
boolean |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().setAutoResize(true);Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L506
setBackgroundColor()
Sección titulada “setBackgroundColor()”setBackgroundColor(color): Promise<void>Especifica el color de fondo del webview.
Específico de la plataforma:
- macOS / iOS: No implementado.
- Windows:
- En Windows 7, no se admite la transparencia y el valor alfa será ignorado.
- En Windows superior a 7: los colores traslúcidos no están soportados por lo que cualquier valor alfa distinto de
0será reemplazado por255
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
color |
null | Color |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
2.1.0
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L607
setFocus()
Sección titulada “setFocus()”setFocus(): Promise<void>Trae el webview al frente y le da el foco.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().setFocus();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L490
setPosition()
Sección titulada “setPosition()”setPosition(position): Promise<void>Establece la posición del webview.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Descripción |
|---|---|---|
position |
LogicalPosition | PhysicalPosition | Position |
La nueva posición, en píxeles lógicos o físicos. |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrent, LogicalPosition } from '@tauri-apps/api/webview';await getCurrentWebview().setPosition(new LogicalPosition(600, 500));Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L471
setSize()
Sección titulada “setSize()”setSize(size): Promise<void>Redimensiona el webview.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Descripción |
|---|---|---|
size |
LogicalSize | PhysicalSize | Size |
El tamaño lógico o físico. |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrent, LogicalSize } from '@tauri-apps/api/webview';await getCurrentWebview().setSize(new LogicalSize(600, 500));Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L453
setZoom()
Sección titulada “setZoom()”setZoom(scaleFactor): Promise<void>Establece el nivel de zoom del webview.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo |
|---|---|
scaleFactor |
number |
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().setZoom(1.5);Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L555
show(): Promise<void>Muestra el webview.
Devuelve
Sección titulada «Devuelve»Promise<void>
Una promesa que indica el éxito o el fallo de la operación.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';await getCurrentWebview().show();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L539
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
Sección titulada «Devuelve»El tamaño del webview.
Ejemplo
Sección titulada «Ejemplo»import { getCurrentWebview } from '@tauri-apps/api/webview';const size = await getCurrentWebview().size();Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L415
getAll()
Sección titulada “getAll()”static getAll(): Promise<Webview[]>Obtiene una lista de instancias de Webview para todos los webviews disponibles.
Devuelve
Sección titulada «Devuelve»Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L239
getByLabel()
Sección titulada “getByLabel()”static getByLabel(label): Promise<null | Webview>Obtiene el Webview para el webview asociado con la etiqueta dada.
Parámetros
Sección titulada «Parámetros»| Parámetro | Tipo | Descripción |
|---|---|---|
label |
string |
La etiqueta del webview. |
Devuelve
Sección titulada «Devuelve»La instancia de Webview para comunicarse con el webview o null si el webview no existe.
Ejemplo
Sección titulada «Ejemplo»import { Webview } from '@tauri-apps/api/webview';const mainWebview = Webview.getByLabel('main');Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L225
getCurrent()
Sección titulada “getCurrent()”static getCurrent(): WebviewObtiene una instancia de Webview para el webview actual.
Devuelve
Sección titulada «Devuelve»Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L232
Interfaces
Sección titulada «Interfaces»WebviewOptions
Sección titulada “WebviewOptions”Configuración para el webview que se va a crear.
2.0.0
Propiedades
Sección titulada «Propiedades»| Propiedad | Tipo | Descripción | Definido en |
|---|---|---|---|
acceptFirstMouse? |
boolean |
Si al hacer clic en un webview inactivo también se hace clic a través de él al webview en macOS. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L746 |
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 | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L850 |
backgroundColor? |
Color |
Establece el color de fondo de la ventana y del webview. Específico de la plataforma: - macOS / iOS: No implementado. - Windows: - En Windows 7, se ignora el canal alfa. - En Windows 8 y más reciente, si el canal alfa no es 0, se ignorará. Desde 2.1.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L822 |
backgroundThrottling? |
BackgroundThrottlingPolicy |
Cambia el comportamiento predeterminado de limitación en segundo plano (background throttling). Por defecto, los navegadores usan una política de suspensión que limitará los temporizadores e incluso descargará toda la pestaña (vista) para liberar recursos después de aproximadamente 5 minutos cuando una vista se minimiza u oculta. Esto pausará todas las tareas hasta que el estado de visibilidad del documento cambie de oculto a visible al volver a traer la vista al primer plano. ## Específico de la plataforma - Linux / Windows / Android: No soportado. Soluciones 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 | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L841 |
dataDirectory? |
string |
Establece una ruta personalizada para el directorio de datos del webview (localStorage, caché, etc.) relativa a [appDataDir()]/${label}. Por razones de seguridad, las rutas fuera de esa ubicación solo se pueden configurar en el lado de Rust. Específico de la plataforma: - Windows: Los WebViews con diferentes valores para configuraciones como additionalBrowserArgs, browserExtensionsEnabled o scrollBarStyle deben tener diferentes directorios de datos. - macOS / iOS: No soportado, usa dataStoreIdentifier en su lugar. - Android: No soportado. Desde 2.9.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L870 |
dataStoreIdentifier? |
number[] |
Inicializa el WebView con un identificador de almacén de datos (data store identifier) personalizado. Esto se puede ver como un reemplazo para dataDirectory que no está disponible en WKWebView. Consulta https://developer.apple.com/documentation/webkit/wkwebsitedatastore/init(foridentifier:)?language=objc El arreglo debe contener 16 números u8. Específico de la plataforma: - macOS / iOS: Disponible en macOS >= 14 e iOS >= 17 - Windows / Linux / Android: No soportado. Desde 2.9.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L884 |
devtools? |
boolean |
Si el inspector web (web inspector), que generalmente se llama devtools del navegador, está habilitado o no. Habilitado por defecto. Esta API funciona en compilaciones de debug, pero requiere la flag de característica devtools para habilitarla en compilaciones de release. Específico de la plataforma - macOS: Esto llamará a funciones privadas en macOS. - Android: Abre chrome://inspect/#devices en Chrome para obtener la ventana de devtools. La API de devtools de WebView de Wry no está soportada en Android. - iOS: Abre Safari > Desarrollar > [Nombre de tu dispositivo] > [Tu WebView] para obtener la ventana de devtools. Desde 2.1.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L809 |
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". | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L857 |
dragDropEnabled? |
boolean |
Si arrastrar y soltar (drag and drop) está habilitado o no en el webview. Por defecto está habilitado. Deshabilitarlo es necesario para usar HTML5 drag and drop en el frontend en Windows. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L742 |
focus? |
boolean |
Si el webview debe tener foco o no Desde 2.1.0 | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L736 |
generalAutofillEnabled? |
boolean |
Controla el comportamiento general de autocompletado del WebView a nivel de navegador. Esta opción no deshabilita el autocompletado de contraseñas o tarjetas de crédito. Cuando se establece en false, el WebView no completará automáticamente campos de formulario generales utilizando datos almacenados previamente como direcciones o información de contacto. Si no se especifica, por defecto es true. ## Específico de la plataforma - Windows: Soportado. La función de autocompletado de WebView2 (llamada “Sugerencias”) puede no respetar autocomplete="off" en elementos de entrada en algunos casos. - Linux / Android / iOS / macOS: No soportado y no realiza ninguna operación. Desde 2.11.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L918 |
height |
number |
La altura inicial en píxeles lógicos. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L724 |
incognito? |
boolean |
Si el webview debe iniciarse en modo incógnito o no. Específico de la plataforma - Android: No soportado. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L758 |
javascriptDisabled? |
boolean |
Si debemos deshabilitar la ejecución de código JavaScript en la webview o no. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L845 |
proxyUrl? |
string |
La URL del proxy para el WebView para todas las solicitudes de red. Debe ser una URL http:// o socks5://. Específico de la plataforma - macOS: Requiere la flag de característica macos-proxy y solo se compila para macOS 14+. |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L768 |
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. |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L899 |
transparent? |
boolean |
Si el webview es transparente o no. Ten en cuenta que en macOS esto requiere la flag de característica macos-private-api, habilitada 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. |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L730 |
url? |
string |
URL remota o ruta de archivo local para abrir. - Una URL como https://github.com/tauri-apps se abre directamente en un webview de Tauri. - Una URL data: como data:text/html,<html>... solo es compatible con la característica de Cargo webview-data-url para la dependencia tauri. - Una ruta de archivo local o ruta como /path/to/page.html o /users se añade a la URL de la aplicación (la URL del devServer en desarrollo, o tauri://localhost/ y https://tauri.localhost/ en producción). |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L716 |
useHttpsScheme? |
boolean |
Establece si los protocolos personalizados deben usar https://<scheme>.localhost en lugar del predeterminado http://<scheme>.localhost en Windows y Android. Por defecto es false. #### Nota Usar un esquema https NO permitirá contenido mixto al intentar obtener endpoints http y, por lo tanto, no coincidirá con el comportamiento de los protocolos <scheme>://localhost utilizados en macOS y Linux. #### Advertencia Cambiar este valor entre versiones cambiará la ubicación de IndexedDB, cookies y localstorage y tu app no podrá acceder a ellos. Desde 2.1.0 |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L795 |
userAgent? |
string |
El user agent para el webview. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L750 |
width |
number |
El ancho inicial en píxeles lógicos. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L722 |
x |
number |
La posición vertical inicial en píxeles lógicos. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L718 |
y |
number |
La posición horizontal inicial en píxeles lógicos. | Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L720 |
zoomHotkeysEnabled? |
boolean |
Si el zoom de la página mediante atajos de teclado está habilitado Específico de la plataforma: - Windows: Controla la configuración IsZoomControlEnabled de WebView2. - MacOS / Linux: Inyecta un polyfill que acerca y aleja con ctrl/command + -/=, 20% en cada paso, en un rango del 20% al 1000%. Requiere el permiso webview:allow-set-webview-zoom - Android / iOS: No soportado. |
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L780 |
Alias de tipos
Sección titulada «Alias de tipos»type Color: [number, number, number] | [number, number, number, number] | object | string;Un color RGBA. Cada valor tiene un mínimo de 0 y un máximo de 255.
Puede ser una cadena #ffffff, un arreglo de 3 o 4 elementos o un objeto.
2.0.0
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/window.ts#L2121
DragDropEvent
Sección titulada “DragDropEvent”type DragDropEvent: object | object | object | object;Los tipos de eventos de arrastrar y soltar (drag and drop).
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L43
Funciones
Sección titulada «Funciones»getAllWebviews()
Sección titulada “getAllWebviews()”function getAllWebviews(): Promise<Webview[]>Obtiene una lista de instancias de Webview para todos los webviews disponibles.
Devuelve
Sección titulada «Devuelve»2.0.0
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L70
getCurrentWebview()
Sección titulada “getCurrentWebview()”function getCurrentWebview(): WebviewObtiene una instancia de Webview para el webview actual.
Devuelve
Sección titulada «Devuelve»2.0.0
Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/webview.ts#L54
© 2026 Colaboradores de Tauri. CC-BY / MIT