lightningsnapin:prechatUI

Add the lightning:prechatUI interface to a Lightning component to enable Snap-ins to identify it as a custom Lightning page template that can be used for the Snap-ins Chat pre-chat page. This interface has no effect except when used within Snap-ins Chat hosted on a website, Visualforce page, or Community (using the Snap-ins Chat Community component).

This interface is a marker interface. A marker interface is a signal to the component’s container to add the interface’s behavior to the component. You don’t need to implement any specific methods or attributes in your component, you simply add the interface name to the component’s implements attribute.

In this case, the interface doesn’t add behavior but makes the custom component available as a pre-chat page from Snap-ins Setup. Without this interface, the component doesn’t appear as a pre-chat page option in Snap-ins Setup. Use this interface with the lightningsnapin:prechatAPI component to enable customization of your pre-chat user interface experience in Snap-ins for web.

Example

This example shows the markup required to implement the lightningsnapin:prechatUI interface.

1<aura:component implements="lightningsnapin:prechatUI">
2    <!-- ... -->
3</aura:component>

Lightning Components Developer Guide

lightningsnapin:prechatUI

Example