Commands

open

Opens the provided HTML in an Overlay View. When successful, it returns back the HTML and a custom close event for you to subscribe to. This alerts you when your overlay instance has been closed. You can also make your overlay immutable so that new overlay instances don't close yours. Only your widget can close its overlay when immutable is set to true.

Options

Option	Type	Description
html	string	HTML String template for overlay window.
immutable	boolean	When set to true, overlay cannot be closed by other plugins.

Resolutions

Status	When	Returns
resolved	When overlay is successfully opened	{html: <template>, events: <Object>}
rejected	When no html template is passed	'No HTML content was provided. Overlay has ignored your command.'
rejected	When overlay is already opened	'Overlay view is currently reserved.'

close

Closes the Overlay UI. Publishes the appropriate custom close event for current overlay being closed.

Resolutions

Status	When	Returns
resolved	When Overlay is successfully closed.	n/a
rejected	When Overlay is already closed.	'Overlay view is already closed'
rejected	When Overlay view is immutable.	'Overlay view is currently reserved'