Search results

Getting started with JavaScript (ES5) Message control

02 Dec 2022 / 2 minutes to read

This section explains the steps required to create a simple JavaScript (ES5) Message control and configure its available functionalities in the TypeScript using the Essential JS 2 quickstart seed repository. This seed repository is pre-configured with all the Essential JS 2 packages.

Dependencies

The following list of dependencies are required to use the Message control in the application.

Copied to clipboard
|-- @syncfusion/ej2-notifications
  |-- @syncfusion/ej2-base
  |-- @syncfusion/ej2-buttons
  |-- @syncfusion/ej2-popups

Setup for local development

To get started with the Message control, clone the Essential JS 2 quickstart project, and install the necessary npm packages by using the following command line scripts.

Copied to clipboard
git clone https://github.com/syncfusion/ej2-quickstart.git quickstart
cd quickstart
npm install

Configuring system JS

The Syncfusion Message packages should be mapped in the system.config.js configuration file.

Copied to clipboard
System.config({
    paths: {
        'npm:': './node_modules/',
        'syncfusion:': 'npm:@syncfusion/'  
    },
    map: {
        app: 'app',

        //Syncfusion packages mapping
        "@syncfusion/ej2-base": "syncfusion:ej2-base/dist/ej2-base.umd.min.js",
        "@syncfusion/ej2-buttons":"syncfusion:ej2-buttons/dist/ej2-buttons.umd.min.js",
        "@syncfusion/ej2-popups":"syncfusion:ej2-popups/dist/ej2-popups.umd.min.js",
        "@syncfusion/ej2-notifications":"syncfusion:ej2-notifications/dist/ej2-notifications.umd.min.js"
    },
    packages: {
        'app': { main: 'app', defaultExtension: 'js' }
    }
});

System.import('app');

Adding CSS reference

The combined CSS files are available in the Essential JS 2 package root folder. This can be referenced in the [src/styles/styles.css] file using the following code.

Copied to clipboard
@import '../../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../../node_modules/@syncfusion/ej2-notifications/styles/material.css';

To add the individual control CSS, refer to the individual control theme section. To use the combined control styles, make use of Syncfusion CRG (Custom Resource Generator) in the application.

Add Message control

Now, start adding the Essential JS 2 Message control to the application. To get started, add the HTML <div> element to the index.html file.

Copied to clipboard
<!DOCTYPE html>
<html lang="en">

<head>
    <title>Essential JS 2 Message control</title>
    <link href="https://cdn.syncfusion.com/ej2/20.3.56/ej2-base/styles/material.css" rel="stylesheet" type="text/css" />
    <link href="https://cdn.syncfusion.com/ej2/20.3.56/ej2-navigations/styles/material.css" rel="stylesheet" type="text/css"/>
    <script src="//cdn.syncfusion.com/ej2/20.3.56/dist/ej2.min.js" type="text/javascript"></script>
</head>
<body>
    <!--Element which will render as Message-->
    <div id="msg"></div>
</body>
<script>
    var msgObj = new ej.notfications.Message({
        content: "Please read the comments carefully"
    });
    msgObj.appendTo("#msg");
</script>
</html>

Run the application

Run the application in the browser using the following command.

Copied to clipboard
npm start

The following example shows a basic Message control.

Source
Preview
index.html
Copied to clipboard
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Essential JS 2 Message control</title>

    <!-- Essential JS 2 Base's material theme (Dependency Styles) -->
    <link href="https://cdn.syncfusion.com/ej2/20.3.56/ej2-base/styles/material.css" rel="stylesheet" type="text/css" />

    <!-- Essential JS 2 Message material theme (Control Styles) -->
    <link href="https://cdn.syncfusion.com/ej2/20.3.56/ej2-notifications/styles/material.css" rel="stylesheet"
        type="text/css" />

    <!-- Essential JS 2 Base's global script (Dependency Script) -->
    <script src="https://cdn.syncfusion.com/ej2/20.3.56/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>

    <!-- Essential JS 2 Message global script (Control Script) -->
    <script src="https://cdn.syncfusion.com/ej2/20.3.56/ej2-notifications/dist/global/ej2-notifications.min.js"
        type="text/javascript"></script>

</head>

<body>
    <!--Element which will render as Message-->
    <div class="msg-default">
        <div id="msg"></div>
    </div>

    <script>
        var msgObj = new ej.notifications.Message({
            content: "Please read the comments carefully"
        });
        msgObj.appendTo("#msg");
    </script>
    
    <style>
        /* Sample level styles */
        .msg-default .e-message {
            margin: 100px;
        }
    </style>
</body>
</html>