@zturnlibs/ztron-api

---

webview#

Classes#

Webview#

Defined in: webview.ts:10

Webview-layer controls for a window's embedded web content.

Constructors#

Constructor#

new Webview(label): Webview

Defined in: webview.ts:13

Parameters#

label#

string

Returns#

Webview

Properties#

label#

readonly label: string

Defined in: webview.ts:11

Methods#

clearAllBrowsingData()#

clearAllBrowsingData(): Promise<void>

Defined in: webview.ts:97

Clears all browsing data for the webview's store: cookies, cache, local/session storage, IndexedDB (WKWebsiteDataStore / WebView2 profile equivalents).

Returns#

Promise<void>

close()#

close(): Promise<void>

Defined in: webview.ts:142

Closes the webview's window.

Returns#

Promise<void>

hide()#

hide(): Promise<void>

Defined in: webview.ts:132

Hides the webview's window.

Returns#

Promise<void>

position()#

position(): Promise<{ x: number; y: number; }>

Defined in: webview.ts:60

Webview position (single-webview era: congruent with the owning window's outer position — the bare multi-webview split lands in G7).

Returns#

Promise<{ x: number; y: number; }>

print()#

print(): Promise<void>

Defined in: webview.ts:31

Opens the page print dialog (wry parity: delegates to the page's own window.print()).

Returns#

Promise<void>

setBackgroundColor()#

setBackgroundColor(color): Promise<void>

Defined in: webview.ts:36

Webview-layer background color (single-webview era: window surface).

Parameters#

color#

string

Returns#

Promise<void>

setFocus()#

setFocus(): Promise<void>

Defined in: webview.ts:127

Focuses the webview (its window's key state).

Returns#

Promise<void>

setPosition()#

setPosition(x, y): Promise<void>

Defined in: webview.ts:109

Positions the webview content within its window (reparent-less).

Parameters#

x#

number

y#

number

Returns#

Promise<void>

setSize()#

setSize(width, height): Promise<void>

Defined in: webview.ts:118

Resizes the webview content within its window.

Parameters#

width#

number

height#

number

Returns#

Promise<void>

setZoom()#

setZoom(zoom): Promise<void>

Defined in: webview.ts:147

Sets the web content zoom factor (CSS zoom).

Parameters#

zoom#

number

Returns#

Promise<void>

show()#

show(): Promise<void>

Defined in: webview.ts:137

Shows the webview's window.

Returns#

Promise<void>

size()#

size(): Promise<{ height: number; width: number; }>

Defined in: webview.ts:65

Webview size (window-congruent; see Webview.position).

Returns#

Promise<{ height: number; width: number; }>

toggleDevtools()#

toggleDevtools(): Promise<{ platform: string; reason?: string; supported: boolean; }>

Defined in: webview.ts:48

Toggles the inspector. Upstream parity note: macOS WKWebView exposes no public toggle (devtools are enabled in debug builds), so the host reports supported: false there instead of failing silently.

Returns#

Promise<{ platform: string; reason?: string; supported: boolean; }>

window()#

window(): Window

Defined in: webview.ts:104

The owning window handle (webview controls often mirror window ops).

Returns#

Window

capabilities()#

static capabilities(): Promise<{ autoResize: boolean; multipleWebviewsPerWindow: boolean; perWindow: boolean; reparent: boolean; }>

Defined in: webview.ts:83

Host webview capability map (G7): one webview per window on this backend; same-window multi-webview/reparent/autoResize are reported as false instead of silently no-op'ing.

Returns#

Promise<{ autoResize: boolean; multipleWebviewsPerWindow: boolean; perWindow: boolean; reparent: boolean; }>

getByLabel()#

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

Defined in: webview.ts:73

Looks up a webview by label. In the single-webview-per-window era a webview exists exactly when its window does.

Parameters#

label#

string

Returns#

Promise<Webview | null>

getCurrent()#

static getCurrent(): Webview

Defined in: webview.ts:18

The current webview (label from the bootstrap metadata).

Returns#

Webview

Functions#

getAllWebviews()#

getAllWebviews(): Promise<Webview[]>

Defined in: webview.ts:156

All live webviews as Webview handles.

Returns#

Promise<Webview[]>

---

getCurrentWebview()#

getCurrentWebview(): Webview

Defined in: webview.ts:166

Upstream naming alias of Webview.getCurrent.

Returns#

Webview