of 3

Documentation

Unblu 7 (latest)

The embedded visitor UI provides a way of integrating Unblu into your website or single-page application (SPA) so that messaging remains the main focus and content.

Embedded visitor UI in split view mode

To add the embedded visitor UI to a page, Unblu provides a custom HTML element, <unblu-embedded-app>. The custom element has attributes for various configuration properties, such as the API key or the named area. You can place it anywhere on a page and size it any way you like to integrate seamlessly with your UI.

Embedded vs floating visitor UI

The embedded visitor UI is best suited to situations where the focus is on messaging. It provides a familiar email-like experience for visitors with plenty of space for longer form texts.

Like the floating visitor UI, you may customize the embedded visitor UI to suit your requirements in terms of branding and functionality available. However, the embedded visitor UI is directly embedded into your website, with no floating overlay. The size and position of the Unblu component are defined by the website, not using configuration properties, but dynamically using the website CSS.

The floating visitor UI is best suited to providing in-context assistance because it takes up less of the screen. The floating visitor UI can also be more easily added to any page.

You can use both the floating visitor UI and the embedded visitor UI on your website. You can even make both visitor UIs available in the same location. However, note that switching between the two visitor UIs deinitializes and reinitializes Unblu, resulting in an interruption of any ongoing calls or collaboration sessions.

View modes

The embedded visitor UI offers two different view modes, split view mode and single view mode.

Unblu can be configured to switch between split view mode and single view mode automatically based on the width of the embedded UI element.

Depending on the view mode, the content displayed to visitors varies.

Split view mode

In split view mode, the embedded visitor UI displays a sidebar on the left of the UI.

Embedded visitor UI in split view mode

The sidebar contains a list of the visitor’s conversations in chronological order (most recent at the top) and a button to start or join conversations. If no conversations exist yet, the conversation panel on the left is empty.

Content is displayed on the right: either the selected conversation or the engagement area.

Single view mode

In single view mode, either the conversation list or a selected conversation is displayed in the whole screen.

Embedded visitor UI in single view mode with the list of conversations displayed

The conversation list and the button to start a new conversation are displayed in a separate view from the current conversation, accessible via the back button Back arrow in the action bar.

Action bar

The action bar is available in both split and single views.

Embedded visitor UI action bar with dropdown menu open

Visitors can start available interactions from the dropdown menu located in the action bar at the top of the page.

The label of the action bar and the label of the engagement button are configurable.

Collaboration layers

When a collaboration layer is started, the UI switches to full screen to display the collaboration space over the whole browser.

The conversation is moved to a collapsible chat panel on the right side.

Calls

When a call is started in split view mode, the conversation is hidden when the call screen is shown and vice versa. Visitors can toggle between the conversation and the call using the Show chat panel button button at the top of the screen.

If a visitor tries to navigate to another conversation during the call, a message appears warning them that they must end the call first.

In single view mode, the conversation list is hidden during a call. Visitors can only toggle between the conversation panel and the call.

For more information about the different call controls available, see Floating visitor UI call view controls.

Integration

Two features of the Mozilla Web Component standard are used in the embedded UI:

  • Custom HTML elements are used to register a custom HTML element tag. The custom elements code is then called every time the tag is used.

  • Internally, the element uses shadow DOM to have a separate styling space.

Unblu provides the web component containing the embedded visitor UI, including the collaboration space. It’s configurable via the exposed attributes and JS API.

For information on how to integrate the embedded visitor UI into your website or SPA, see the Embedded JS API reference.

Embedded visitor UI configuration properties

See also