Web

const Web: object

Defined in: client/api.d.ts:2143

Client-only, resource-owned CEF web-view API exposed as the global Web.

Type Declaration

createView()

createView(url, options?): number

Creates an origin-locked web view owned by the calling resource.

Parameters

url

string

Resource-relative URL or allowed absolute URL loaded into the view.

options?

Optional initial pixel geometry, stacking, visibility, and focus settings.

focus?

boolean

height?

number

visible?

boolean

width?

number

x?

number

y?

number

zIndex?

number

Returns

number

Numeric view ID used by the remaining Web methods.

destroyView()

destroyView(viewId): boolean

Destroys an owned view and removes all of its script event handlers.

Parameters

viewId

number

Owned view identifier.

Returns

boolean

True when a view was destroyed.

emit()

emit(viewId, eventName, payload?): boolean

Dispatches a CustomEvent into an owned view.

Parameters

viewId

number

Owned view identifier.

eventName

string

CustomEvent name dispatched in the page.

payload?

unknown

Optional JSON-serializable event detail.

Returns

boolean

True when the dispatch script was queued.

focusView()

focusView(viewId, focused?): boolean

Changes input focus for an owned view.

Parameters

viewId

number

Owned view identifier.

focused?

boolean

Whether the view captures keyboard and mouse input; defaults to true.

Returns

boolean

True when the view exists and focus was updated.

getScreenSize()

getScreenSize(): object

Returns the current client viewport size.

Returns

object

Width and height in physical pixels.

height

height: number

width

width: number

hideView()

hideView(viewId): boolean

Hides an owned view.

Parameters

viewId

number

Owned view identifier.

Returns

boolean

True when the view exists and was updated.

isViewVisible()

isViewVisible(viewId): boolean

Checks whether an owned view is currently visible.

Parameters

viewId

number

Owned view identifier.

Returns

boolean

False for missing or unowned views.

loadURL()

loadURL(viewId, url): boolean

Navigates a view and replaces its allowed origin with the new URL’s origin.

Parameters

viewId

number

Owned view identifier.

url

string

New resource-relative or allowed absolute URL.

Returns

boolean

True when navigation was requested.

off()

off(viewId, eventName, handler?): boolean

Removes page-event handlers from an owned view.

Parameters

viewId

number

Owned view identifier.

eventName

string

Page-to-script event name.

handler?

WebEventHandler

Optional exact callback; omitting it removes every matching handler owned by the resource.

Returns

boolean

True when at least one handler was removed.

on()

on(viewId, eventName, handler): void

Registers a handler for an event emitted by an owned same-origin page.

Parameters

viewId

number

Owned view identifier.

eventName

string

Page-to-script event name.

handler

WebEventHandler

Resource-owned callback invoked by the view’s callEvent bridge.

Returns

void

resizeView()

resizeView(viewId, width, height): boolean

Resizes an owned view’s viewport.

Parameters

viewId

number

Owned view identifier.

width

number

New viewport width in pixels.

height

number

New viewport height in pixels.

Returns

boolean

True when the view exists and was resized.

setViewPosition()

setViewPosition(viewId, x, y): boolean

Moves an owned view on screen.

Parameters

viewId

number

Owned view identifier.

x

number

New horizontal screen position in pixels.

y

number

New vertical screen position in pixels.

Returns

boolean

True when the view exists and was moved.

showView()

showView(viewId): boolean

Makes an owned view visible.

Parameters

viewId

number

Owned view identifier.

Returns

boolean

True when the view exists and was updated.