View source for WID/Current/SDK/Overlay-combined

{{Article
|Standalone=No
|DisplayName=Overlay
|TocName=Overlay
|Context=Learn how to use an overlay window control that widgets can inject their UI into.
|ComingSoon=No
|Platform=GenesysEngage-cloud
|Role=Developer
|Section={{Section
|sectionHeading=Overview
|alignment=Vertical
|structuredtext=The Overlay plugin provides an overlay window control that widgets can inject their UI into, accepting the HTML UI, placing it inside an overlay control, and displaying the UI onscreen in a uniform overlay window fashion. This prevents individual widgets from managing the overlay themselves. It also means that each widget's UI can be moved between different container types. 

Overlay provides these benefits:

*Shows the UI in the center of the window.
*Open and close transition animations.
*No overlapping overlays. Only one at a time. Automatically managed by the Overlay plugin.
*Auto-recenter as the browser window size is changed.
*Automatic application of mobile styles when running in mobile mode.

===Usage===
Overlay is easy to use; you simply open and close it. When you call Overlay.open, you pass in the HTML content you want to show. If you call Overlay.open again while an overlay is already open, it will automatically close the previous overlay before showing yours (unless the previous overlay has reserved the overlay to prevent new overlays).

{{NoteFormat|By default, the overlay has no visible styles or content. You must pass in the HTML you want to show inside the Overlay area. Typically you should create an overlay-type container using Common.Generate.Container, put your content inside that, then send the whole thing into Overlay.open.|}}
===Customization===
Overlay does not have customization options.
===Mobile Support===
Overlay automatically applies mobile CSS styles to its outer container to affect the content within the overlay view. It is up to the content inside the overlay view to dynamically change when the Genesys Widgets .cx-mobile CSS classname is applied to an outer container.
|Status=No
}}{{Section
|sectionHeading=Configuration
|alignment=Vertical
|structuredtext=Overlay does not have configuration options.
|Status=No
}}{{Section
|sectionHeading=Localization
|alignment=Vertical
|structuredtext=Overlay does not have localization options.
|Status=No
}}{{Section
|sectionHeading=API Commands
|alignment=Vertical
|structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.

{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}


<source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.command('Overlay.close');</source>


===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.
====Example====
<source lang="javascript">
oMyPlugin.command('Overlay.open', {

	html: '<div>Template</div>',
	immutable: false,
	group: false

}).done(function(e){

	// Overlay opens successfully

}).fail(function(e){

	// Overlay failed to open
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}html
{{!}}{{!}}string
{{!}}{{!}}HTML String template for overlay window.
{{!}}-
{{!}}{{!}}immutable
{{!}}{{!}}boolean
{{!}}{{!}}When set to true, overlay cannot be closed by other plugins.
{{!}}-
{{!}}{{!}}group
{{!}}{{!}}string
{{!}}{{!}}The name of the overlay window group you want to add a new overlay view into.
{{!}}}


====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When overlay is successfully opened
{{!}}{{!}}{html: , events: <object>, group: } 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.'

<div>
===close===
</div>Closes the Overlay UI. Publishes the appropriate custom close event for current overlay being closed.

<div>
====Example====
</div>
<span id="<source lang=&quot;&quot;javascript&quot;&quot;>
oMyPlugin.command('Overlay.close').done(function(e){

	// Overlay closed successfully

}).fail(function(e){

	// Overlay failed to close
});
</source>" class="mceNonEditable wikimagic mw-tag" title="<source lang=&quot;&quot;javascript&quot;&quot;>oMyPlugin.command('Overlay.close').done(function(e){	// Overlay closed successfully}).fail(function(e){	// Overlay failed to close});</source>" data-mw-type="tag" data-mw-id="166014" data-mw-name="source" data-mw-wikitext="%3Csource%20lang='javascript'%3E%0AoMyPlugin.command('Overlay.close').done(function(e)%7B%0A%0A%09//%20Overlay%20closed%20successfully%0A%0A%7D).fail(function(e)%7B%0A%0A%09//%20Overlay%20failed%20to%20close%0A%7D);%0A%3C/source%3E" contenteditable="false"></span>

<div>
====Resolutions====
</div><div>
{{{!}}
{{!}}-
!{{!}}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'
{{!}}}
</div></object>
{{!}}}
|Status=No
}}{{Section
|sectionHeading=API Events
|alignment=Vertical
|structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.

{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}


<source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('Overlay.ready', function(e){});</source>
{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Description
!{{!}}Data
{{!}}-
{{!}}{{!}}ready
{{!}}{{!}}The Overlay plugin is initialized and ready to accept commands
{{!}}{{!}}n/a
{{!}}}
|Status=No
}}
}}