kotlin-tauri-apps-api/tauri.apps.api/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 _.

Since

2.0.0

Inheritors

WebviewWindow

Constructors

Webview

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

Creates a new Webview.

Types

Companion

object Companion

Properties

label

open var label: WebviewLabel

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

listeners

open var listeners: ERROR CLASS: Symbol not found for js.objects.ReadonlyRecord<kotlin/String, ERROR CLASS: Symbol not found for js.array.ReadonlyArray<{tauri/apps/api/EventCallback<kotlin/Any?>=} kotlin/Function1<@R|kotlin/ParameterName|(name = String(event)) tauri/apps/api/Event<kotlin/Any?>, kotlin/Unit>>>

Local event listeners.

window

var window: Window

The window hosting this webview.

Functions

_handleTauriEvent

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

clearAllBrowsingData

fun clearAllBrowsingData(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Clears all browsing data for this webview.

fun close(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Closes the webview.

emit

fun <T> emit(event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

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

emitTo

fun <T> emitTo(target: EventTarget, event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun <T> emitTo(target: String, event: String, payload: T = definedExternally): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

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

hide

fun hide(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Hide the webview.

listen

open fun <T> listen(event: EventName, handler: EventCallback<T>): ERROR CLASS: Symbol not found for js.promise.Promise<{tauri/apps/api/UnlistenFn=} kotlin/Function0<kotlin/Unit>>

Listen to an emitted event on this webview.

once

open fun <T> once(event: EventName, handler: EventCallback<T>): ERROR CLASS: Symbol not found for js.promise.Promise<{tauri/apps/api/UnlistenFn=} kotlin/Function0<kotlin/Unit>>

Listen to an emitted event on this webview only once.

onDragDropEvent

fun onDragDropEvent(handler: EventCallback<DragDropEvent>): ERROR CLASS: Symbol not found for js.promise.Promise<{tauri/apps/api/UnlistenFn=} kotlin/Function0<kotlin/Unit>>

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

fun position(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/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

fun reparent(window: String): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun reparent(window: WebviewWindow): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun reparent(window: Window): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Moves this webview to the given label.

setAutoResize

fun setAutoResize(autoResize: Boolean): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

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

setBackgroundColor

open fun setBackgroundColor(color: Color?): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Specify the webview background color.

setFocus

fun setFocus(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Bring the webview to front and focus.

setPosition

fun setPosition(position: LogicalPosition): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setPosition(position: PhysicalPosition): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setPosition(position: Position): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Sets the webview position.

setSize

fun setSize(size: LogicalSize): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setSize(size: PhysicalSize): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

fun setSize(size: Size): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Resizes the webview.

setZoom

fun setZoom(scaleFactor: Double): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Set webview zoom level.

show

fun show(): ERROR CLASS: Symbol not found for js.promise.Promise<ERROR CLASS: Symbol not found for js.core.Void>

Show the webview.

size

fun size(): ERROR CLASS: Symbol not found for js.promise.Promise<tauri/apps/api/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.