kotlin-tauri-apps-api/tauri.apps.api.webviewwindow/WebviewWindow

WebviewWindow

open external class WebviewWindow : Webview(source)

Constructors

WebviewWindow

constructor(label: WebviewLabel, options: WebviewWindowOptions = definedExternally)

Creates a new {@link Window} hosting a {@link Webview}.

Types

Companion

external object Companion

Set the window and webview background color.

Properties

label

open external override var label: String

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

listeners

open external override 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 override fun <T> listen(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>

Listen to an emitted event on this webview window.

once

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

Listen to an emitted event on this webview window 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

external fun position(): Promise<PhysicalPosition>

The position of the top-left hand corner of the webview's client area relative to the top-left hand corner of the desktop.

reparent

external fun reparent(window: String): Promise<Void>

external fun reparent(window: WebviewWindow): Promise<Void>

external fun reparent(window: Window): Promise<Void>

Moves this webview to the window with the given label.

setAutoResize

external fun setAutoResize(autoResize: Boolean): Promise<Void>

Sets whether the webview should automatically grow and shrink its size and position when the parent window resizes.

setBackgroundColor

open external fun setBackgroundColor(color: Color?): Promise<Void>

Specify the webview background color.

setFocus

external fun setFocus(): Promise<Void>

Bring the webview to front and focus.

setPosition

external fun setPosition(position: LogicalPosition): Promise<Void>

external fun setPosition(position: PhysicalPosition): Promise<Void>

external fun setPosition(position: Position): Promise<Void>

Sets the webview position.

setSize

external fun setSize(size: LogicalSize): Promise<Void>

external fun setSize(size: PhysicalSize): Promise<Void>

external fun setSize(size: Size): Promise<Void>

Resizes the webview.

setZoom

external fun setZoom(scaleFactor: Double): Promise<Void>

Set webview zoom level.

show

external fun show(): Promise<Void>

Show the webview.

size

external fun size(): Promise<PhysicalSize>

The physical size of the webview's client area. The client area is the content of the webview, excluding the title bar and borders.