@zturnlibs/ztron-api


webview-window

Classes

WebviewWindow

Defined in: webview-window.ts:17

A native window created at runtime (multi-window).

Extends

Constructors

Constructor

new WebviewWindow(label, options?): WebviewWindow

Defined in: webview-window.ts:20

Parameters
label

string

options?

WebviewWindowOptions = {}

Returns

WebviewWindow

Overrides

Window.constructor

Properties

label

readonly label: string

Defined in: window.ts:157

Inherited from

Window.label

Methods

activityName()

activityName(): Promise<string | null>

Defined in: window.ts:365

Android-only upstream: current activity name (null on desktop).

Returns

Promise<string | null>

Inherited from

Window.activityName

center()

center(): Promise<void>

Defined in: window.ts:685

Returns

Promise<void>

Inherited from

Window.center

clearEffects()

clearEffects(): Promise<void>

Defined in: window.ts:300

Removes any applied vibrancy effect.

Returns

Promise<void>

Inherited from

Window.clearEffects

close()

close(): Promise<void>

Defined in: window.ts:537

Returns

Promise<void>

Inherited from

Window.close

create()

create(): Promise<void>

Defined in: webview-window.ts:26

Creates the native window with this instance's label + options.

Returns

Promise<void>

cursorPosition()

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

Defined in: window.ts:388

Screen-space cursor position (no label needed; upstream parity).

Returns

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

Inherited from

Window.cursorPosition

destroy()

destroy(): Promise<void>

Defined in: window.ts:421

Force-closes the window, bypassing preventClose.

Returns

Promise<void>

Inherited from

Window.destroy

getState()

getState(): Promise<{ alwaysOnTop: boolean; fullscreen: boolean; maximized: boolean; minimized: boolean; resizable: boolean; visible: boolean; } | null>

Defined in: window.ts:713

Reads the window's boolean state flags (maximized/fullscreen/etc).

Returns

Promise<{ alwaysOnTop: boolean; fullscreen: boolean; maximized: boolean; minimized: boolean; resizable: boolean; visible: boolean; } | null>

Inherited from

Window.getState

getTheme()

getTheme(): Promise<string | null>

Defined in: window.ts:210

The OS color scheme the window follows ("light" | "dark").

Returns

Promise<string | null>

Inherited from

Window.getTheme

getTitle()

getTitle(): Promise<string>

Defined in: window.ts:183

The current native window title.

Returns

Promise<string>

Inherited from

Window.getTitle

hide()

hide(): Promise<void>

Defined in: window.ts:229

Returns

Promise<void>

Inherited from

Window.hide

innerPosition()

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

Defined in: window.ts:765

The window's inner position (content top-left). Approximated by the outer frame origin — exact content origin needs titlebar-height measurement.

Returns

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

Inherited from

Window.innerPosition

innerSize()

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

Defined in: window.ts:200

The window's inner (content) size in points — excludes title bar.

Returns

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

Inherited from

Window.innerSize

isAlwaysOnTop()

isAlwaysOnTop(): Promise<boolean>

Defined in: window.ts:725

Whether the window stays on top of other windows.

Returns

Promise<boolean>

Inherited from

Window.isAlwaysOnTop

isClosable()

isClosable(): Promise<boolean>

Defined in: window.ts:642

Whether the native close button is enabled.

Returns

Promise<boolean>

Inherited from

Window.isClosable

isDecorated()

isDecorated(): Promise<boolean>

Defined in: window.ts:647

Whether the window has native decorations (title bar / borders).

Returns

Promise<boolean>

Inherited from

Window.isDecorated

isEnabled()

isEnabled(): Promise<boolean>

Defined in: window.ts:193

Whether the window is enabled (macOS: always true — no NSWindow state).

Returns

Promise<boolean>

Inherited from

Window.isEnabled

isFocused()

isFocused(): Promise<boolean>

Defined in: window.ts:652

Whether the window is currently focused (key window).

Returns

Promise<boolean>

Inherited from

Window.isFocused

isFullscreen()

isFullscreen(): Promise<boolean>

Defined in: window.ts:580

Returns

Promise<boolean>

Inherited from

Window.isFullscreen

isMaximizable()

isMaximizable(): Promise<boolean>

Defined in: window.ts:627

Whether the native maximize/zoom button is enabled.

Returns

Promise<boolean>

Inherited from

Window.isMaximizable

isMaximized()

isMaximized(): Promise<boolean>

Defined in: window.ts:565

Returns

Promise<boolean>

Inherited from

Window.isMaximized

isMinimizable()

isMinimizable(): Promise<boolean>

Defined in: window.ts:612

Whether the native minimize button is enabled.

Returns

Promise<boolean>

Inherited from

Window.isMinimizable

isMinimized()

isMinimized(): Promise<boolean>

Defined in: window.ts:569

Returns

Promise<boolean>

Inherited from

Window.isMinimized

isResizable()

isResizable(): Promise<boolean>

Defined in: window.ts:735

Whether the window is resizable.

Returns

Promise<boolean>

Inherited from

Window.isResizable

isVisible()

isVisible(): Promise<boolean>

Defined in: window.ts:730

Whether the window is visible.

Returns

Promise<boolean>

Inherited from

Window.isVisible

maximize()

maximize(): Promise<void>

Defined in: window.ts:556

Sets the native maximize state without toggling (Tauri v2 split).

Returns

Promise<void>

Inherited from

Window.maximize

minimize()

minimize(): Promise<void>

Defined in: window.ts:543

Returns

Promise<void>

Inherited from

Window.minimize

onBlurred()

onBlurred(handler): Promise<UnlistenFn>

Defined in: window.ts:926

Parameters
handler

() => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onBlurred

onCloseRequested()

onCloseRequested(handler): Promise<() => void>

Defined in: window.ts:947

Fires when a close is requested. The handler decides dynamically: call event.preventDefault() to keep the window open, otherwise the window is destroyed when the handler completes (Tauri v2 semantics).

Parameters
handler

(event) => unknown

Returns

Promise<() => void>

Inherited from

Window.onCloseRequested

onDragDropEvent()

onDragDropEvent(handler): () => void

Defined in: window.ts:310

A normalized drag-and-drop notification (Tauri DragDropEvent): enter carries paths + position, over only the position, drop paths + position, and leave fires when the drag leaves the window without a drop. Positions are physical pixels relative to the window's top-left.

Parameters
handler

(payload) => void

Returns

() => void

Inherited from

Window.onDragDropEvent

onFocusChanged()

onFocusChanged(handler): Promise<() => void>

Defined in: window.ts:931

Focus + blur combined (Tauri v2 sugar).

Parameters
handler

(focused) => void

Returns

Promise<() => void>

Inherited from

Window.onFocusChanged

onFocused()

onFocused(handler): Promise<UnlistenFn>

Defined in: window.ts:922

Parameters
handler

() => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onFocused

onMoved()

onMoved(handler): Promise<UnlistenFn>

Defined in: window.ts:891

Parameters
handler

(payload) => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onMoved

onResized()

onResized(handler): Promise<UnlistenFn>

Defined in: window.ts:887

Parameters
handler

(payload) => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onResized

onScaleChanged()

onScaleChanged(handler): Promise<UnlistenFn>

Defined in: window.ts:966

Fires when the backing scale factor changes (Retina display moves).

Parameters
handler

(payload) => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onScaleChanged

onThemeChanged()

onThemeChanged(handler): Promise<UnlistenFn>

Defined in: window.ts:973

Fires when the system theme changes (payload: "dark" | "light").

Parameters
handler

(theme) => void

Returns

Promise<UnlistenFn>

Inherited from

Window.onThemeChanged

outerPosition()

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

Defined in: window.ts:751

The window's outer position (top-left origin).

Returns

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

Inherited from

Window.outerPosition

outerSize()

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

Defined in: window.ts:740

The window's outer size (width × height, including decorations).

Returns

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

Inherited from

Window.outerSize

preventClose()

preventClose(prevent): Promise<void>

Defined in: window.ts:416

Prevents the window from closing; a ztron://close-requested event is emitted instead, letting the frontend confirm (then call destroy()).

Parameters
prevent

boolean

Returns

Promise<void>

Inherited from

Window.preventClose

requestUserAttention()

requestUserAttention(type?): Promise<void>

Defined in: window.ts:676

Bounces the dock icon until activated. null cancels the request. (macOS maps Critical/Informational to the bounce style.)

Parameters
type?

UserAttentionType | null

Returns

Promise<void>

Inherited from

Window.requestUserAttention

scaleFactor()

scaleFactor(): Promise<number | null>

Defined in: window.ts:234

The window's backing scale factor (2 on Retina/HiDPI).

Returns

Promise<number | null>

Inherited from

Window.scaleFactor

sceneIdentifier()

sceneIdentifier(): Promise<string | null>

Defined in: window.ts:375

iOS-only upstream: current scene identifier (null on desktop).

Returns

Promise<string | null>

Inherited from

Window.sceneIdentifier

setActivityName()

setActivityName(name): Promise<void>

Defined in: window.ts:370

Android-only upstream: accepted as a documented no-op on desktop.

Parameters
name

string

Returns

Promise<void>

Inherited from

Window.setActivityName

setAlwaysOnBottom()

setAlwaysOnBottom(alwaysOnBottom): Promise<void>

Defined in: window.ts:594

Keeps the window below all other windows (v2-only).

Parameters
alwaysOnBottom

boolean

Returns

Promise<void>

Inherited from

Window.setAlwaysOnBottom

setAlwaysOnTop()

setAlwaysOnTop(alwaysOnTop): Promise<void>

Defined in: window.ts:586

Parameters
alwaysOnTop

boolean

Returns

Promise<void>

Inherited from

Window.setAlwaysOnTop

setBackgroundColor()

setBackgroundColor(color): Promise<void>

Defined in: window.ts:857

Sets the window background color: "#rrggbb", "#rrggbbaa" or "transparent". Takes effect on frameless/transparent windows.

Parameters
color

string

Returns

Promise<void>

Inherited from

Window.setBackgroundColor

setBadgeCount()

setBadgeCount(count): Promise<void>

Defined in: window.ts:835

Sets the dock badge count. null/undefined removes the badge. macOS dock / Windows taskbar; unsupported elsewhere.

Parameters
count

number | null

Returns

Promise<void>

Inherited from

Window.setBadgeCount

setBadgeLabel()

setBadgeLabel(badgeLabel): Promise<void>

Defined in: window.ts:846

Sets the dock badge to arbitrary text (macOS only). null/undefined/"" removes the badge.

Parameters
badgeLabel

string | null

Returns

Promise<void>

Inherited from

Window.setBadgeLabel

setBounds()

setBounds(x, y, width?, height?): Promise<void>

Defined in: window.ts:437

Sets the window bounds (position + size in one op, dpi types accepted).

Parameters
x

PositionLike

y

SizeLike

width?

number

height?

number

Returns

Promise<void>

Inherited from

Window.setBounds

setClosable()

setClosable(closable): Promise<void>

Defined in: window.ts:634

Toggles the native close button.

Parameters
closable

boolean

Returns

Promise<void>

Inherited from

Window.setClosable

setContentProtected()

setContentProtected(protect): Promise<void>

Defined in: window.ts:665

Prevents the window contents from being captured by other apps.

Parameters
protect

boolean

Returns

Promise<void>

Inherited from

Window.setContentProtected

setCursor()

setCursor(cursor): Promise<void>

Defined in: window.ts:345

Sets the window cursor (CSS-style name: "default", "pointer", "text", "crosshair", "move", "not-allowed", resize cursors, …).

Parameters
cursor

string

Returns

Promise<void>

Inherited from

Window.setCursor

setCursorGrab()

setCursorGrab(grab): Promise<void>

Defined in: window.ts:262

Locks the cursor at its current position (Tauri setCursorGrab). On macOS the cursor visually parks in place; release with false.

Parameters
grab

boolean

Returns

Promise<void>

Inherited from

Window.setCursorGrab

setCursorIcon()

setCursorIcon(icon): Promise<void>

Defined in: window.ts:350

Alias of setCursor (Tauri v2 name).

Parameters
icon

string

Returns

Promise<void>

Inherited from

Window.setCursorIcon

setCursorPosition()

setCursorPosition(x, y?): Promise<void>

Defined in: window.ts:395

Warps the cursor to window coordinates (dpi types accepted).

Parameters
x

PositionLike

y?

number

Returns

Promise<void>

Inherited from

Window.setCursorPosition

setCursorVisible()

setCursorVisible(visible): Promise<void>

Defined in: window.ts:357

Hides/shows the system cursor (app-global hide counter — pair calls).

Parameters
visible

boolean

Returns

Promise<void>

Inherited from

Window.setCursorVisible

setDecorations()

setDecorations(decorations): Promise<void>

Defined in: window.ts:783

Toggles native window decorations (title bar / borders).

Parameters
decorations

boolean

Returns

Promise<void>

Inherited from

Window.setDecorations

setEffects()

setEffects(effects): Promise<void>

Defined in: window.ts:292

Vibrancy material (macOS). Windows-only effects are ignored there.

Parameters
effects

Effects

Returns

Promise<void>

Inherited from

Window.setEffects

setEnabled()

setEnabled(enabled): Promise<void>

Defined in: window.ts:463

Enables/disables the native window.

Parameters
enabled

boolean

Returns

Promise<void>

Inherited from

Window.setEnabled

setFileDropEnabled()

setFileDropEnabled(enabled): Promise<void>

Defined in: window.ts:251

Enables/disables the native file drag-and-drop handler. While enabled (default) file drags produce Window.onDragDropEvent events; disable it to let the page use the HTML5 drag-and-drop APIs instead.

Parameters
enabled

boolean

Returns

Promise<void>

Inherited from

Window.setFileDropEnabled

setFocus()

setFocus(): Promise<void>

Defined in: window.ts:689

Returns

Promise<void>

Inherited from

Window.setFocus

setFocusable()

setFocusable(focusable): Promise<void>

Defined in: window.ts:896

Toggles whether the window can take keyboard focus.

Parameters
focusable

boolean

Returns

Promise<void>

Inherited from

Window.setFocusable

setFullscreen()

setFullscreen(fullscreen): Promise<void>

Defined in: window.ts:573

Parameters
fullscreen

boolean

Returns

Promise<void>

Inherited from

Window.setFullscreen

setIcon()

setIcon(icon): Promise<void>

Defined in: window.ts:273

Sets the window/dock icon from an Image (registered host image). Pass null to clear.

Parameters
icon

Image | null

Returns

Promise<void>

Inherited from

Window.setIcon

setIgnoreCursorEvents()

setIgnoreCursorEvents(ignore): Promise<void>

Defined in: window.ts:239

Toggles whether the window ignores mouse/cursor events.

Parameters
ignore

boolean

Returns

Promise<void>

Inherited from

Window.setIgnoreCursorEvents

setMaximizable()

setMaximizable(maximizable): Promise<void>

Defined in: window.ts:619

Toggles the native maximize/zoom button.

Parameters
maximizable

boolean

Returns

Promise<void>

Inherited from

Window.setMaximizable

setMaxSize()

setMaxSize(size): Promise<void>

Defined in: window.ts:510

Sets the window maximum inner size. null unsets the constraint (dpi types accepted).

Parameters
size

SizeLike | null | undefined

Returns

Promise<void>

Inherited from

Window.setMaxSize

setMinimizable()

setMinimizable(minimizable): Promise<void>

Defined in: window.ts:604

Toggles the native minimize button (macOS/Windows; button-mask based).

Parameters
minimizable

boolean

Returns

Promise<void>

Inherited from

Window.setMinimizable

setMinSize()

setMinSize(size): Promise<void>

Defined in: window.ts:497

Sets the window minimum inner size. null unsets the constraint (dpi types accepted, like new LogicalSize(300, 200)).

Parameters
size

SizeLike | null | undefined

Returns

Promise<void>

Inherited from

Window.setMinSize

setOpacity()

setOpacity(opacity): Promise<void>

Defined in: window.ts:705

Sets the window opacity, 0.0 (transparent) to 1.0 (opaque).

Parameters
opacity

number

Returns

Promise<void>

Inherited from

Window.setOpacity

setOverlayIcon()

setOverlayIcon(icon): Promise<void>

Defined in: window.ts:284

Sets a small titlebar accessory icon (the macOS take on Windows' overlay/status badge). Pass null to clear.

Parameters
icon

Image | null

Returns

Promise<void>

Inherited from

Window.setOverlayIcon

setPosition()

setPosition(x, y?): Promise<void>

Defined in: window.ts:484

Moves the window. Accepts plain numbers, a LogicalPosition / PhysicalPosition, or a plain { x, y } object.

Parameters
x

PositionLike

y?

number

Returns

Promise<void>

Inherited from

Window.setPosition

setProgressBar()

setProgressBar(progress): Promise<void>

Defined in: window.ts:809

Dock/taskbar progress. Accepts a bare determinate value / null (v1 shape) or an upstream ProgressBarState object: Indeterminate toggles the spinning bar, None clears it.

Parameters
progress

number | ProgressBarStateInput | null

Returns

Promise<void>

Inherited from

Window.setProgressBar

setResizable()

setResizable(resizable): Promise<void>

Defined in: window.ts:697

Parameters
resizable

boolean

Returns

Promise<void>

Inherited from

Window.setResizable

setSceneIdentifier()

setSceneIdentifier(id): Promise<void>

Defined in: window.ts:380

iOS-only upstream: accepted as a documented no-op on desktop.

Parameters
id

string

Returns

Promise<void>

Inherited from

Window.setSceneIdentifier

setShadow()

setShadow(shadow): Promise<void>

Defined in: window.ts:458

Toggles the native window shadow.

Parameters
shadow

boolean

Returns

Promise<void>

Inherited from

Window.setShadow

setSimpleFullscreen()

setSimpleFullscreen(fullscreen): Promise<void>

Defined in: window.ts:915

Borderless "simple" fullscreen: content fills the screen without the native fullscreen space transition (frame + decorations restored on off).

Parameters
fullscreen

boolean

Returns

Promise<void>

Inherited from

Window.setSimpleFullscreen

setSize()

setSize(width, height?): Promise<void>

Defined in: window.ts:471

Sets the window size. Accepts plain numbers, a LogicalSize / PhysicalSize, or a plain { width, height } object.

Parameters
width

SizeLike

height?

number

Returns

Promise<void>

Inherited from

Window.setSize

setSizeConstraints()

setSizeConstraints(constraints): Promise<void>

Defined in: window.ts:520

Sets min/max inner-size constraints in one call.

Parameters
constraints

WindowSizeConstraints | null | undefined

Returns

Promise<void>

Inherited from

Window.setSizeConstraints

setSkipTaskbar()

setSkipTaskbar(skipTaskbar): Promise<void>

Defined in: window.ts:657

Hides the window icon from the taskbar/dock (macOS: whole app).

Parameters
skipTaskbar

boolean

Returns

Promise<void>

Inherited from

Window.setSkipTaskbar

setTheme()

setTheme(theme): Promise<void>

Defined in: window.ts:220

App-wide theme override ("dark"/"light"; null follows system).

Parameters
theme

"dark" | "light" | null

Returns

Promise<void>

Inherited from

Window.setTheme

setTitle()

setTitle(title): Promise<void>

Defined in: window.ts:178

Parameters
title

string

Returns

Promise<void>

Inherited from

Window.setTitle

setTitleBarStyle()

setTitleBarStyle(style): Promise<void>

Defined in: window.ts:869

Sets the title-bar style (macOS only): "visible" (default), "transparent" (hidden chrome) or "overlay" (content under the traffic lights — the Tauri "transparent + full-size content view").

Parameters
style

TitleBarStyle

Returns

Promise<void>

Inherited from

Window.setTitleBarStyle

setTrafficLightPosition()

setTrafficLightPosition(x, y): Promise<void>

Defined in: window.ts:981

Moves the traffic-light buttons (close/minimize/zoom) — for frameless macOS windows with titleBarStyle: "overlay".

Parameters
x

number

y

number

Returns

Promise<void>

Inherited from

Window.setTrafficLightPosition

setTransparent()

setTransparent(transparent): Promise<void>

Defined in: window.ts:775

Toggles a transparent window background.

Parameters
transparent

boolean

Returns

Promise<void>

Inherited from

Window.setTransparent

setVisible()

setVisible(visible): Promise<void>

Defined in: window.ts:693

Parameters
visible

boolean

Returns

Promise<void>

Inherited from

Window.setVisible

setVisibleOnAllWorkspaces()

setVisibleOnAllWorkspaces(visible): Promise<void>

Defined in: window.ts:904

Shows the window on all workspaces / virtual desktops (macOS).

Parameters
visible

boolean

Returns

Promise<void>

Inherited from

Window.setVisibleOnAllWorkspaces

setZoom()

setZoom(zoom): Promise<void>

Defined in: window.ts:408

Zooms the web content (CSS zoom factor, e.g. 1.5).

Parameters
zoom

number

Returns

Promise<void>

Inherited from

Window.setZoom

show()

show(): Promise<void>

Defined in: window.ts:225

Alias of setVisible(true) / setVisible(false) (Tauri v2 parity).

Returns

Promise<void>

Inherited from

Window.show

startDragging()

startDragging(): Promise<void>

Defined in: window.ts:794

Starts a native window drag — call from a mousedown on a data-tauri-drag-region element of a frameless window.

Returns

Promise<void>

Inherited from

Window.startDragging

startResizeDragging()

startResizeDragging(direction?): Promise<void>

Defined in: window.ts:429

Starts a native resize drag (direction: "north"/"south"/"east"/"west" or combinations like "southeast"). macOS is not implemented.

Parameters
direction?

string = "southeast"

Returns

Promise<void>

Inherited from

Window.startResizeDragging

theme()

theme(): Promise<string | null>

Defined in: window.ts:215

The OS color scheme, alias of getTheme (Tauri v2 parity).

Returns

Promise<string | null>

Inherited from

Window.theme

title()

title(): Promise<string>

Defined in: window.ts:188

Sets the window title (alias of setTitle for Tauri v2 parity).

Returns

Promise<string>

Inherited from

Window.title

toggleMaximize()

toggleMaximize(): Promise<void>

Defined in: window.ts:551

Returns

Promise<void>

Inherited from

Window.toggleMaximize

unmaximize()

unmaximize(): Promise<void>

Defined in: window.ts:561

Restores a maximized window (no-op when not zoomed).

Returns

Promise<void>

Inherited from

Window.unmaximize

unminimize()

unminimize(): Promise<void>

Defined in: window.ts:547

Returns

Promise<void>

Inherited from

Window.unminimize

getByLabel()

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

Defined in: window.ts:164

Looks up a live window by label (null when it doesn't exist).

Parameters
label

string

Returns

Promise<Window | null>

Inherited from

Window.getByLabel

getCurrent()

static getCurrent(): Window

Defined in: window.ts:169

The current window (label from the bootstrap metadata).

Returns

Window

Inherited from

Window.getCurrent

Interfaces

WebviewWindowOptions

Defined in: webview-window.ts:8

Properties

height?

optional height?: number

Defined in: webview-window.ts:11

html?

optional html?: string

Defined in: webview-window.ts:13

title?

optional title?: string

Defined in: webview-window.ts:9

url?

optional url?: string

Defined in: webview-window.ts:12

width?

optional width?: number

Defined in: webview-window.ts:10

Functions

getCurrentWebviewWindow()

getCurrentWebviewWindow(): Window

Defined in: webview-window.ts:35

The window that invoked this call (single-window alias of Window).

Returns

Window