Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 1: Line 1:
 
= Toaster =
 
= Toaster =
 
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Toaster-combined.}}
*[[Documentation:PSAAS:Administrator:ToasterConfiguration|Configuration]]
 
*[[Documentation:PSAAS:Administrator:ToasterLocalization|Localization]]
 
*[[Documentation:PSAAS:Administrator:ToasterCommands|API Commands]]
 
*[[Documentation:PSAAS:Administrator:ToasterEvents|API Events]]
 
 
 
== Overview ==
 
 
 
The Toaster plugin provides a toast view control that widgets can inject their UI into. The Toaster plugin accepts an HTML UI and puts it inside a toast view and displays the UI onscreen in the lower-bottom-right of the screen. When it is opened it will slide up from the bottom. When it is closed it will slide down until it is offscreen.
 
 
 
Toaster provides these benefits:
 
* Shows UI as a slide-up toast view in the lower-bottom-right of the screen.
 
* Open and close transition animations.
 
* No overlapping toasts, only one at a time. Automatically managed by the Toaster plugin.
 
 
 
== Usage ==
 
Toaster is very easy to use; you simply open and close it. When you call Toaster.open, you pass-in the HTML content you want to show. If you call Toaster.open again while a toast is already open, it will automatically close the previous toast before showing yours (unless the previous toast has reserved the view to prevent new toasts).
 
 
 
{{NoteFormat|Only one toast can be shown at a time. If you attempt to open a second toast, the first toast will be dismissed automatically before showing the second toast.}}
 
 
 
== Namespace ==
 
 
 
Toaster plugin has the following namespaces tied-up with each of the following types.  
 
 
 
{| style="width: auto;"
 
|-
 
! Type
 
! Namespace
 
|-
 
| CXBus - [[ToasterCommands|API Commands]] & [[ToasterEvents|API Events]]
 
| Toaster
 
|-
 
| CSS
 
| .cx-toaster
 
|-
 
|}
 
 
 
== Customization ==
 
 
 
Toaster does not have customization options.
 
 
 
== Mobile Support ==
 
 
 
Toaster does not have mobile-specific styles at this time.
 
 
 
== Screenshots ==
 
 
 
[[File:Toaster_Main.png|none|WebChat uses the Toaster plugin to show an invitation to customers]]
 
 
 
 
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 21:52, October 17, 2019

Toaster

Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Toaster-combined.
Comments or questions about this documentation? Contact us for support!