UIIframeElementUpdate


The parameters for updating an iframe element.

See UIIframeElement for more details.

Remarks

id and type are required to identify the element to update.

Properties

type

type: "Iframe"


id

id: string

The ID of the element.


height?

optional height: string | number

The height of the iframe.

If not provided, the height will be automatically calculated following a 16:9 ratio.


url?

optional url: string

The URL of the iframe.


onCreate()?

optional onCreate: (args: { id: string; }) => void

A function to call when the element is created.

Parameters

Parameter
Type
Description

args

{ id: string; }

The arguments passed to the function.

args.id

string

The id of the element.

Returns

void


onDestroy()?

optional onDestroy: (args: { id: string; }) => void

A function to call when the element is destroyed.

Parameters

Parameter
Type
Description

args

{ id: string; }

The arguments passed to the function.

args.id

string

The id of the element.

Returns

void

Last updated

Was this helpful?