kotlin-tauri-apps-api/tauri.apps.api.webview/Webview

Webview

open external class Webview(source)

Create new webview or get a handle to an existing one.

Webviews are identified by a label a unique identifier that can be used to reference it later. It may only contain alphanumeric characters a-zA-Z plus the following special characters -, /, : and _.

Requires the `unstable` Cargo feature

Creating a webview with new Webview(...) adds a child webview to an existing window, which is an unstable API gated behind the unstable feature of the tauri crate:

[dependencies]
tauri = { version = "2", features = ["unstable"] }

Without it the call rejects with an "unstable feature not supported" error. Getting a handle to an existing webview (Webview.getByLabel, {@link getCurrentWebview}, {@link getAllWebviews}) and every method on this class work without the feature. To create a window that hosts a single webview, use {@link WebviewWindow} instead, which is stable.

Since

2.0.0

Inheritors

WebviewWindow

Constructors

Webview

constructor(window: Window, label: WebviewLabel, options: WebviewOptions)

Creates a new Webview.

Types

Companion

external object Companion

Properties

label

open external var label: WebviewLabel

The webview label. It is a unique identifier for the webview, can be used to reference it later.

listeners

open external var listeners: ReadonlyRecord<String, ReadonlyArray<EventCallback<Any?>>>

Local event listeners.

window

external var window: Window

The window hosting this webview.

Functions

_handleTauriEvent

external fun <T> _handleTauriEvent(event: String, handler: EventCallback<T>): Boolean

clearAllBrowsingData

external fun clearAllBrowsingData(): Promise<Void>

Clears all browsing data for this webview: cookies, localStorage, IndexedDB, caches and any other data the webview stores for the loaded origins.

external fun close(): Promise<Void>

Closes the webview.

emit

external fun <T> emit(event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets}.

emitTo

external fun <T> emitTo(target: EventTarget, event: String, payload: T = definedExternally): Promise<Void>

external fun <T> emitTo(target: String, event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets} matching the given target.

hide

external fun hide(): Promise<Void>

Hide the webview.

listen

open external fun <T> listen(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>

Listen to an emitted event on this webview.

once

open external fun <T> once(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>

Listen to an emitted event on this webview only once.

onDragDropEvent

external fun onDragDropEvent(handler: EventCallback<DragDropEvent>): Promise<UnlistenFn>

Listen to a file drop event. The listener is triggered when the user hovers the selected files on the webview, drops the files or cancels the operation.

position