HtmlPanel

interface HtmlPanel

HTML Panel HTML panels should only be created through Inbox​.createHtmlPanel, Chatbox​.createHtmlPanel or Popup​.createHtmlPanel.

Method Overview

destroy

Destroys the HTML panel

hide

Hides the panel if it's visible.

isVisible

Returns true if the panel is visible, false if it's hidden or destroyed

setHeight

Changes the panel height.

show

Shows the panel if it's hidden.

Properties

DOMContentLoadedPromise
: Promise<void>

This promise resolves when the "DOMContentLoaded" event fires on the ifram's window.

window
: Window
windowLoadedPromise
: Promise<void>

This promise resolves when the "load" event fires on the ifram's window.

destroy

1htmlPanel.destroy(): Promise<void>
Destroys the HTML panel

Parameters

None.

Returns

Promise<void>

hide

1htmlPanel.hide()
Hides the panel if it's visible.

Parameters

None.

Returns

void

isVisible

1htmlPanel.isVisible(): boolean
Returns true if the panel is visible, false if it's hidden or destroyed

Parameters

None.

Returns

boolean

setHeight

1htmlPanel.setHeight(height)
Changes the panel height.

If you don't need to change the height after the panel is created, you can pass it as an option to the createHtmlPanel.

Parameters

height
: number

Returns

void

show

1htmlPanel.show()
Shows the panel if it's hidden.

Parameters

None.

Returns

void