|
|
| (One intermediate revision by one other user not shown) |
| Line 1: |
Line 1: |
| | = SideBar = | | = SideBar = |
| | | | |
| − | Showing both when initially loaded on page and expanded.
| + | {{Template:PEC_Migrated}} |
| | | | |
| − | [[File:Sidebar-Desktop-Dark.png]]
| |
| − | [[File:Sidebar-Desktop-Dark-Expanded.png]]
| |
| − | <br/>
| |
| | | | |
| − | *[[SideBarConfiguration|Configuration]]
| |
| − | *[[SideBarLocalization|Localization]]
| |
| − | *[[SideBarCommands|API Commands]]
| |
| − | *[[SideBarEvents|API Events]]
| |
| | | | |
| − | == Overview ==
| + | {{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/SideBar-combined.}} |
| − | | |
| − | The Sidebar widget is displayed to the right side of the screen by default. The purpose of this Widget is to launch other Widgets with a single click. Customers can configure Widgets onto Sidebar, for which they would like to add a launch button. Sidebar Widget also supports configuring custom extension Widgets. The Sidebar UI is expanded when you hover your cursor over it. and then contracted back when you move the cursor away. Other features include configuring position, mobile support, and support adding new configuration on the fly which re-renders the sidebar.
| |
| − | | |
| − | == Usage ==
| |
| − | | |
| − | SideBar can be launched manually by the following methods:
| |
| − | * Calling the [[SideBarCommands|command]] "SideBar.open"
| |
| − | * Configuring [[SideBarConfiguration|Configuration]] to show and launch custom widgets.
| |
| − | | |
| − | ==Dependency==
| |
| − | | |
| − | The Sidebar Widget needs at-least one Widget to be configured.
| |
| − | | |
| − | == Customization ==
| |
| − | | |
| − | All text shown in the Sidebar Widget is fully customizable and [[SideBarLocalization|localizable]] by adding entries into your [[SideBarConfiguration|configuration]] and [[SideBarLocalization|localization]] options.
| |
| − | | |
| − | Sidebar supports themes. You may create and register your own themes for Genesys Widgets.
| |
| − | | |
| − | == Namespace ==
| |
| − | | |
| − | Sidebar plugin has the following namespaces tied-up with each of the following types:
| |
| − | | |
| − | {| style="width: auto;"
| |
| − | |-
| |
| − | ! Type
| |
| − | ! Namespace
| |
| − | |-
| |
| − | | [[SideBarConfiguration|Configuration]]
| |
| − | | sidebar
| |
| − | |-
| |
| − | | i18n - [[SideBarLocalization|Localization]]
| |
| − | | sidebar
| |
| − | |-
| |
| − | | CXBus - [[SideBarCommands|API Commands]] & [[SideBarEvents|API Events]]
| |
| − | | SideBar
| |
| − | |-
| |
| − | | CSS
| |
| − | | .cx-sidebar
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | == Mobile Support ==
| |
| − | | |
| − | Sidebar supports both desktop and mobile devices. In mobile mode, the sidebar launcher button is displayed to the bottom of the screen. When triggered, it expands to the full screen of mobile and shows all channels configured with scrollbar when necessary. Like all Genesys Widgets, there are two main modes: Desktop & Mobile. Desktop is employed for monitors, laptops, and tablets. Mobile is employed for smartphones. When a smartphone is detected, Sidebar switches to special fullscreen templates that are optimized for both portrait and landscape orientations.
| |
| − | | |
| − | Switching between desktop and mobile mode is done automatically by default. You may configure Genesys Widgets to switch between Desktop and Mobile mode manually if necessary.
| |
| − | | |
| − | == Screenshots ==
| |
| − | | |
| − | '''"Dark" Theme'''
| |
| − | <gallery>
| |
| − | Sidebar-Desktop-Dark.png|Sidebar in contracted mode - desktop
| |
| − | Sidebar-Desktop-Dark-Expanded.png|Sidebar in expanded mode - desktop
| |
| − | Sidebar-Desktop-Dark-Left.png|Sidebar in left side of the screen - desktop
| |
| − | Sidebar-Mobile-Dark.png|Sidebar launcher button in Mobile screen.
| |
| − | Sidebar-Mobile-Dark-Expanded.png|Sidebar expanded to fullscreen view in Mobile - portrait orientation
| |
| − | Sidebar-Mobile-Dark-Landscape-Expanded.png|Sidebar expanded to fullscreen view in Mobile - landscape orientation
| |
| − | </gallery>
| |
| − | | |
| − | '''"Light" Theme'''
| |
| − | <gallery>
| |
| − | Sidebar-Desktop-Light.png|Sidebar in contracted mode - desktop
| |
| − | Sidebar-Desktop-Light-Expanded.png|Sidebar in expanded mode - desktop
| |
| − | Sidebar-Mobile-Light.png|Sidebar launcher button in Mobile screen.
| |
| − | Sidebar-Mobile-Light-Expanded.png|Sidebar expanded to fullscreen view in Mobile - portrait orientation
| |
| − | Sidebar-Mobile-Light-Landscape-Expanded.png|Sidebar expanded to fullscreen view in Mobile - landscape orientation
| |
| − | </gallery>
| |
| | | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
