UIIframeElementCreate
The parameters for creating an iframe element.
SeeUIIframeElement for more details.
Remarks
id is optional but recommended if you want to be able to perform updates.
Properties
type
type:
"Iframe"
url
url:
string
The URL of the iframe.
height?
optionalheight:string|number
The height of the iframe.
If not provided, the height will be automatically calculated following a 16:9 ratio.
onCreate()?
optionalonCreate: (args: {id:string; }) =>void
A function to call when the element is created.
Parameters
args
{id:string; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
onDestroy()?
optionalonDestroy: (args: {id:string; }) =>void
A function to call when the element is destroyed.
Parameters
args
{id:string; }
The arguments passed to the function.
args.id
string
The id of the element.
Returns
void
id?
optionalid:string
The ID of the element.
Remarks
If not provided, the element will be assigned a random ID, but it is recommended to provide it to perform further updates on the element.
If provided, it must be unique within the UI.
Default Value
undefined
Last updated
Was this helpful?