IframeUI

Base class for defining and interacting with custom UI elements whose contents are displayed
in an iframe.

Extended by

• Modal
• Panel

---

Constructors

new IframeUI()

ts

new IframeUI(client): IframeUI

Parameters

Parameter	Type
client	EditorClient

Returns

IframeUI

---

Properties

client

ts

protected readonly client: EditorClient;

---

framePosition

ts

protected framePosition: object;

The location of this frame within the top-level browser window. This is always updated immediately before
messageFromFrame is called.

h

ts

h: number = 1;

w

ts

w: number = 1;

x

ts

x: number = 0;

y

ts

y: number = 0;

---

loaded

ts

protected loaded: boolean = false;

True after the iframe has fired an onload event (not all scripts are necessarily finished executing)

---

messageActionName

ts

protected messageActionName: string;

---

Methods

frameClosed()

ts

protected frameClosed(): void

Called when the iframe has been removed from the DOM

Returns

void

---

frameLoaded()

ts

protected frameLoaded(): void

Called when the iframe has been constructed, its srcdoc set, and the window loaded event has fired

Returns

void

---

hookMessages()

ts

protected hookMessages(): void

Subclasses must call hookMessages some time before the UI is displayed. A Modal
will call this when the open() method is called, where a Panel will need to do
this in the constructor to watch for the user opening the panel.

Returns

void

---

messageFromFrame()

ts

protected messageFromFrame(message): void

Receives messages sent from the iframe via parent.postMessage(, '*')

Parameters

Parameter	Type	Description
message	any	data sent from the iframe

Returns

void

---

sendMessage()

ts

sendMessage(data): Promise<void>

Send a message to this UI component's iframe via window.postMessage.

Parameters

Parameter	Type	Description
data	UnsafeJsonSerializableOrUndefined	Data to send to the iframe

Returns

Promise<void>

---

unhookMessages()

ts

protected unhookMessages(): void

Subclasses must call unhookMessages to allow them to be garbage collected.

Returns

void