UIIframeElementCreate
The parameters for creating an iframe element.
See UIIframeElement for more details.
id is optional but recommended if you want to be able to perform updates.
type: "Iframe"
url: string
The URL of the iframe.
optional height: string | number
The height of the iframe.
If not provided, the height will be automatically calculated following a 16:9 ratio.
optional onCreate: (args: { id: string; }) => void
A function to call when the element is created.
The arguments passed to the function.
void
optional onDestroy: (args: { id: string; }) => void
A function to call when the element is destroyed.
The arguments passed to the function.
void
optional id: string
The ID of the element.
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.
undefined
Last updated
