Getting started with JavaScript Chat UI control

22 Jul 202616 minutes to read

This section explains the steps required to create a simple Essential® JS 2 Chat UI and demonstrates the basic usage of the Chat UI control in a JavaScript application.

Prerequisites

Before getting started, ensure the following requirements are met:

Requirement Notes
Modern web browser Chrome, Firefox, Edge, or Safari — latest version recommended
Code editor Visual Studio Code is recommended
Local HTTP server Required to serve the application. Opening HTML files directly via file:// may block script loading in some browsers. VS Code Live Server extension is recommended
Syncfusion® license key Required from version 16.2.0.17 onwards. Refer to the Registering a license key section

Dependencies

The list of dependencies required to use the Chat UI control in your application is given as follows:

|-- @syncfusion/ej2-interactive-chat
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-navigations
    |-- @syncfusion/ej2-inputs
    |-- @syncfusion/ej2-buttons
    |-- @syncfusion/ej2-dropdowns
    |-- @syncfusion/ej2-popups

For npm-based projects, install the packages using: npm install @syncfusion/ej2-interactive-chat --save

Control Initialization

The JavaScript (ES5) Chat UI control can be initialized by using either of the following ways.

  • Using local script and style references in a HTML page.
  • Using CDN link for script and style reference.

Using local script and style references in a HTML page

Step 1: Create an app folder quickstart for getting started.

Step 2: You can get the global scripts and styles from the Essential Studio® JavaScript (Essential® JS 2) build installed location.

Syntax:

Dependency Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\dist\global\{DEPENDENCY_PACKAGE_NAME}.min.js

Control Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\dist\global\{PACKAGE_NAME}.min.js

Dependency Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\styles\tailwind3.css

Control Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\styles\tailwind3.css

Example:

Dependency Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\dist\global\ej2-base.min.js

Control Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-interactive-chat\dist\global\ej2-interactive-chat.min.js

Dependency Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\styles\tailwind3.css

Control Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-interactive-chat\styles\tailwind3.css

The below located script and style file contains all Syncfusion® JavaScript (ES5) UI control resources in a single file.

Scripts: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\dist\ej2.min.js

Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\tailwind3.css

The Custom Resource Generator (CRG) is an online web tool, which can be used to generate the custom script and styles for a set of specific controls. This web tool is useful to combine the required control scripts and styles in a single file.

Step 3: Create a folder ~/quickstart/resources and copy/paste the global scripts and styles from the above installed location to ~/quickstart/resources/package corresponding package location.

Step 4: Create a HTML page (index.html) in ~/quickstart/index.html location and add the Essential® JS 2 script and style references.

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
            <title>JavaScript (ES5)</title>
            <!-- JavaScript (ES5) Chat UI dependency style -->
            <link href="resources/base/bootstrap5.3.css" rel="stylesheet" type="text/css"/>
            <link href="resources/buttons/bootstrap5.3.css" rel="stylesheet" type="text/css" />
            <link href="resources/popups/bootstrap5.3.css" rel="stylesheet" type="text/css" />
            <link href="resources/inputs/bootstrap5.3.css" rel="stylesheet" type="text/css" />
            <link href="resources/navigations/bootstrap5.3.css" rel="stylesheet" type="text/css" />
            <link href="resources/dropdowns/bootstrap5.3.css" rel="stylesheet" type="text/css"/>

            <!-- JavaScript (ES5) Chat UI control style -->
            <link href="resources/interactive-chat/bootstrap5.3.css" rel="stylesheet" type="text/css"/>

            <!-- JavaScript (ES5) Chat UI dependency global script -->
            <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
            <script src="resources/data/ej2-data.min.js" type="text/javascript"></script>
            <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
            <script src="resources/popups/ej2-popups.min.js" type="text/javascript"></script>
            <script src="resources/splitbuttons/ej2-splitbuttons.min.js" type="text/javascript"></script>
            <script src="resources/inputs/ej2-inputs.min.js" type="text/javascript"></script>
            <script src="resources/lists/ej2-lists.min.js" type="text/javascript"></script>
            <script src="resources/dropdowns/ej2-dropdowns.min.js" type="text/javascript"></script>
            <script src="resources/navigations/ej2-navigations.min.js" type="text/javascript"></script>
            <script src="resources/markdown-converter/ej2-markdown-converter.min.js" type="text/javascript"></script>

            <!-- JavaScript (ES5) Chat UI control global script -->
            <script src="resources/interactive-chat/ej2-interactive-chat.min.js" type="text/javascript"></script>
       </head>
       <body>
       </body>
  </html>

Step 5: Now, add the Chat UI element and initiate the JavaScript (ES5) Chat UI control in the index.html by using following code

[src/index.html]

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
       <head>
          <title>JavaScript (ES5)</title>
          <!-- JavaScript (ES5) Chat UI's dependency style -->
          <link href="resources/base/bootstrap5.3.css" rel="stylesheet" type="text/css"/>
          <link href="resources/buttons/bootstrap5.3.css" rel="stylesheet" type="text/css" />
          <link href="resources/popups/bootstrap5.3.css" rel="stylesheet" type="text/css" />
          <link href="resources/inputs/bootstrap5.3.css" rel="stylesheet" type="text/css" />
          <link href="resources/navigations/bootstrap5.3.css" rel="stylesheet" type="text/css" />
          <link href="resources/dropdowns/bootstrap5.3.css" rel="stylesheet" type="text/css"/>
          
          <!-- JavaScript (ES5) Chat UI control style -->
          <link href="resources/interactive-chat/bootstrap5.3.css" rel="stylesheet" type="text/css"/>

          <!-- JavaScript (ES5) Chat UI's dependency global script -->
          <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
          <script src="resources/data/ej2-data.min.js" type="text/javascript"></script>
          <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
          <script src="resources/popups/ej2-popups.min.js" type="text/javascript"></script>
          <script src="resources/splitbuttons/ej2-splitbuttons.min.js" type="text/javascript"></script>
          <script src="resources/inputs/ej2-inputs.min.js" type="text/javascript"></script>
          <script src="resources/lists/ej2-lists.min.js" type="text/javascript"></script>
          <script src="resources/dropdowns/ej2-dropdowns.min.js" type="text/javascript"></script>
          <script src="resources/navigations/ej2-navigations.min.js" type="text/javascript"></script>
          <script src="resources/markdown-converter/ej2-markdown-converter.min.js" type="text/javascript"></script>
          <!-- JavaScript (ES5) Chat UI control global script -->
          <script src="resources/interactive-chat/ej2-interactive-chat.min.js" type="text/javascript"></script>
       </head>
       <body>
            <!-- Add the HTML <div> chatUI  -->
          <div class="chatui-container" style="height: 380px; width: 450px;">
            <div id="chatUI"></div>
          </div>
          <script>
                // Initializes the Chat UI control
                let chatUI = new ej.interactivechat.ChatUI({});

                    // Render initialized Chat UI.
                chatUI.appendTo('#chatUI');
          </script>
       </body>
  </html>

Step 6: Now, run the index.html in web browser, it will render the Syncfusion® JavaScript (ES5) Chat UI control.

Step 1: Create an app folder quickstart for getting started.

Step 2: The JavaScript (ES5) control’s global scripts and styles are already hosted in the below CDN link formats.

Syntax:

Dependency Script: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Control Script: https://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Dependency Styles: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/styles/tailwind3.css

Control Styles: https://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/styles/tailwind3.css

Example:

Script: https://cdn.syncfusion.com/ej2/ej2-interactive-chat/dist/global/ej2-interactive-chat.min.js

Styles: https://cdn.syncfusion.com/ej2/ej2-interactive-chat/styles/tailwind3.css

Step 3: Create a HTML page (index.html) in ~/quickstart/index.html location and add the CDN link references. Now, add the Chat UI element and initiate the JavaScript (ES5) Chat UI control in the index.html by using following code.

You can use the messages property to add messages and the user property to configure the current user for the chat.

ej.base.enableRipple(true);

var currentUserModel = {
    id: "user1",
    user: "Albert"
};

var michaleUserModel = {
    id: "user2",
    user: "Michale Suyama"
};

var chatMessages = [
    {
        author: currentUserModel,
        text: "Hi Michale, are we on track for the deadline?"
    },
    {
        author: michaleUserModel,
        text: "Yes, the design phase is complete."
    },
    {
        author: currentUserModel,
        text: "I’ll review it and send feedback by today."
    }
];

// Initializes the Chat UI control
var chatUI = new ej.interactivechat.ChatUI({
    messages: chatMessages,
    user: currentUserModel
});

// Render initialized Chat UI.
chatUI.appendTo('#default-chat');
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
                
    <title>JavaScript (ES5) Chat UI</title>
    <!-- JavaScript (ES5) Chat UI's dependency style -->
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-base/styles/tailwind3.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-inputs/styles/tailwind3.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-buttons/styles/tailwind3.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-navigations/styles/tailwind3.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-popups/styles/tailwind3.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-splitbuttons/styles/tailwind3.css" rel="stylesheet" />

    <!-- JavaScript (ES5) Chat UI control style -->
    <link href="https://cdn.syncfusion.com/ej2/34.1.29/ej2-interactive-chat/styles/tailwind3.css" rel="stylesheet" />

    <!-- JavaScript (ES5) Chat UI's dependent scripts -->
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-splitbuttons/dist/global/ej2-splitbuttons.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-navigations/dist/global/ej2-navigations.min.js" type="text/javascript"></script>

    <!-- JavaScript (ES5) Chat UI control script -->
    <script src="https://cdn.syncfusion.com/ej2/34.1.29/ej2-interactive-chat/dist/global/ej2-interactive-chat.min.js" type="text/javascript"></script>

    <!--style reference from app-->
    <link href="index.css" rel="stylesheet">

  </head>

  <body>
    <!--Element to render the Chat UI control-->
    <div id='container' style="height: 380px; width: 450px;">
        <div id="default-chat"></div>
    </div>

    <script>
        var ele = document.getElementById('container');
        if(ele) {
          ele.style.visibility = "visible";
        }
    </script>
    <script src="index.js" type="text/javascript"></script>
  </body>
</html>

Registering a license key

Syncfusion® Essential® JS 2 controls require a valid license key from version 16.2.0.17 onwards. Without a license key, a license validation message will appear in the browser console.

Step 1: Obtain your license key from the Syncfusion License Portal or from the licensing FAQ page.

Step 2: Register the license key in your index.js file before initializing any Syncfusion® control.

// Register Syncfusion license key
ej.base.registerLicense('YOUR_LICENSE_KEY_HERE');

Replace 'YOUR_LICENSE_KEY_HERE' with the actual license key obtained from your Syncfusion account. For more information, refer to the Syncfusion Licensing documentation.

Step 4: Now, run the index.html in web browser, it will render the Syncfusion® JavaScript Chat UI control.

Troubleshooting

Chat UI renders blank / does not load

  • Verify that the container element exists and has a valid ID.
  • Open the browser developer console (F12) and check for JavaScript errors.
  • Ensure all CDN script tags are loading successfully (check the Network tab for 4xx/5xx errors).

License validation warning in the console

  • Register your license key before instantiating any Syncfusion® control.

Scripts blocked when opening via file://

  • Serve the application through a local HTTP server.

CDN resources fail to load

  • Check your internet connection.
  • Confirm the version number in the CDN URLs matches a valid published release. See the Syncfusion CDN page for available versions.