Chat Module
The use of this library is for the visualization of the chat only. This will be displayed throughout the job.
For the display of the Chat only it requires the use of the chat parameter call.
Consider the following examples:
<!DOCTYPE html>
<head>
<title>LSW v3 Embed</title>
</head>
<body>
<div id="instaleap-lsw-v3"></div>
</body>
<script src="https://xandar-lsw-v3.instaleap.io/lib/chat.js"></script>
<script>
const params = {
job: "myJob",
token: "myToken",
container: "#instaleap-lsw-v3"
}
window.instaleap.chat.render(params)
</script>
</html>
https://xandar-lsw-v3.instaleap.io/chat?job=myJob&token=myToken
Example:
The list of parameters is as follows
You can change the default colors used in the application by setting de primary and secondary colors parameters.
You can customize the color for the main background by setting the "backgroundColor" parameter.
Color Value
You can change the default colors used in the application by setting de primary and secondary colors parameters.
You can customize the color for the main background by setting the "backgroundColor" parameter.
Specific configuration parameters
| Parameter | Description |
|---|---|
| primaryColor | Used to change the primary color of the content. |
| secondaryColor | Used to change the secondary color of the content. |
| backgroundColor | Used to change the background color of the main content |
You can change the font family used in the application by setting the fontFamily parameter
Font Availability
Live status Web doesn't support any fonts by default, so make sure you have the fonts available on your site so that the widget can use them
Specific configuration parameters
| Parameter | Description |
|---|---|
| fontFamily | Any font you have available in your platform Example: monospace |
The parameter "language" allows configuring the displaying locales on the application
Supported Locales
Supported Languages
We Follow the ISO 639-1 standard language codes
es: Spanish (Spain)
en: English
pt: Portuguese (Portugal)
pt-br: Portuguese (Brazil)
Default Locale
If no language is being set, the app will try to use the locale used by the browser.
If no supported language (listed above) is being set by neither the parameter nor the browser, the content will be displayed in Spanish
Specific configuration parameters
| Parameter | Description |
|---|---|
| language | parameter used to change the language of the content Default: Spanish |
Customize Text
Title
You can customize the chat view using the parameter orderStatusText.📘 You can customize the following in the chat:
Title of the support tab in the chat of the client.
Title of the picking tab in the chat of the client.
Title of the driver tab in the chat of the client.
We recommend configuring also the language parameter when using custom step names, to avoid mixing the language of the content, retrieved from the browser, and the titles you are presenting.
Library mode params Encoding
In library mode, the configuration is set in the "chat” attribute.
URL Params Encoding
Remember that we require to comply with (UTF-8) encoding when sending query params. so that if your custom name string has whitespace, you should replace it with the symbol "%20".
ie: "chatSupportTabTitle=custom title support" => chatSupportTabTitle=custom%20title%20support"
| Parameter | Description |
|---|---|
| orderStatusTitle | Parameter to customize the title of the step view |
| Custom title chat | Allows you to customize the titles of the customer chat. |
Specific chat
You can specific view chat tab.
| Parameter | Description |
|---|---|
| Specific chat tab | Parameter used to display the shopper tab or the support tab in the chat. |
Hide parameters
Order number
You can hide text the chat view using the parameter hideOrderNumber.
| Parameter | Description |
|---|---|
| HideOrderNumber | Allows you to show or hide the number order in the header default: "false" options: "false: || "true" |
| hideChatWithSupport | Allows to show or hide the chat with the Support default: "false" options: "false: || "true" |
| hideChatWithPicker | Allows to show or hide the chat with the Picker default: "false" options: "false: || "true" |
Updated 3 days ago