Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This page is about Chat for JSM Cloud. Using Server or Data Center? Click here.

To change the appearance of the Chat Widget on an external website, you need to modify the widget’s HTML code that you’ve placed on the website, along with the CSS rules placed on the page.

...

Code Block
<chat-widget primary-color="#2D60D8" text-color="#FFFFFF">

</chat-widget>

To add meta data:

...

Code Block
<chat-widget
metadata="[
{ name: 'Age', value: 100, render: true, },
{ name: 'Greeting', value: 'Hello world', render: true, },
{ name: 'Hidden', value: 'hidden', render: false, },
]">
</chat-widget>

To

...

show the Widget automatically:

Code Block
chatWidget.setAttribute('auto-show', 'false');

...

Code Block
<chat-widget auto-show="false" <></chat-widget>

To show the Widget (e.g., if ‘auto-show' is set to 'false'):

Code Block
chatWidget.show();

To hide the Widget:

Code Block
chatWidget.hide();

You can define the callbacks or listen to the events:

Code Block
chatWidget.onload = () => console.log('The Widget is fully loaded');

OR

Code Block
chatWidget.addEventListener('load', () => console.log('The Widget is fully loaded'));

 

Code Block
chatWidget.onclose = () => console.log('The Widget is closed');

OR

Code Block
chatWidget.addEventListener('close', () => console.log('The Widget is closed'));

To use the Widget in full-screen mode (the Conversation List will be open automatically on full screen on the page or in a frame)

Code Block
chatWidget.setAttribute('full-screen');

OR

Code Block
<chat-widget full-screen></chat-widget>
Note

The old version of the Chat Widget is no longer supported. We highly recommend that you switch to the new version by replacing the old code snippet on your website with the new one to ensure the best possible experience for your customers. You can find information about the customization settings for the old widget below.

...