Getting started in EJ2 TypeScript Dialog control

24 Jul 20265 minutes to read

This section explains the steps to create a simple Dialog and demonstrates the basic usage of the Dialog component using the Essential® JS 2 quickstart seed repository. This seed repository is pre-configured with the Essential® JS 2 package.

This application is integrated with the webpack.config.js configuration and uses the latest version of the webpack-cli. It requires node v14.15.0 or higher. For more information about webpack and its features, refer to the webpack documentation.

Prerequisites

Ensure the following tools are installed on your machine:

Set up the development environment

Clone the Syncfusion® TypeScript (Essential® JS 2) quickstart project from GitHub in the command prompt:

git clone https://github.com/SyncfusionExamples/ej2-quickstart-webpack ej2-quickstart

Navigate to the project folder in the command prompt:

cd ej2-quickstart

Install Syncfusion® Dialog package

Syncfusion® TypeScript (Essential® JS 2) packages are available on the npmjs.com public registry. You can install all Syncfusion® TypeScript (Essential® JS 2) controls in a single @syncfusion/ej2 package or individual packages for each control.

Use the following command to install the @syncfusion/ej2-popups package:

npm install @syncfusion/ej2-popups --save

Then, install the remaining dependent npm packages using the following command:

npm install

For more information about individual package and alternative installation methods, see the installation guide.

Import Syncfusion® Dialog CSS styles

Syncfusion® JavaScript controls provide built-in themes, which are available from the npm theme packages. Additionally, themes can be loaded via CDN or customized using the Theme Studio. For more information, refer to the themes documentation.

The quickstart application is preconfigured to use the Fluent2 theme. To install the Fluent2 theme package, use the following command:

npm install @syncfusion/ej2-fluent2-theme --save

The required styles are imported in the ~/src/styles/styles.css file, as shown below:

@import "../../node_modules/@syncfusion/ej2-fluent2-theme/styles/dialog/index.css";

Learn more about built-in themes and individual control CSS references.

Add Syncfusion® Dialog control to the application

Open the application in Visual Studio Code and add the Syncfusion® JavaScript UI controls.

In this article, the Dialog control is used as an example. Add the following Dialog element to the ~/src/index.html file.

<!DOCTYPE html>
<html lang="en">

<head>
    <title>Essential JS 2</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
</head>

<body style="margin-top: 100px;">
    <div id="container">
      <!--element which is going to render the Dialog -->
        <button class="e-control e-btn" id="targetButton" role="button" e-ripple="true">Open Dialog</button>
        <div id="dialog"></div>
    </div>
</body>

</html>

To render the Dialog control, add the following JavaScript code to the ~/src/app/app.ts file

import { Dialog } from '@syncfusion/ej2-popups';

// Initialize Dialog component
let dialog = new Dialog({

    // Dialog content
    content: 'This is a Dialog',
    // The Dialog shows within the target element
    target: document.getElementById("container") as HTMLElement,
    // Dialog width
    width: '250px',
    // Dialog position
    position: { X: 'center', Y: 'center' }
});
// Render initialized Dialog
dialog.appendTo('#dialog');

// Sample level code to handle the button click action

document.getElementById('targetButton')!.onclick = (): void => {
    if (dialog.visible) {
        dialog.hide();
    } else {
        dialog.show();
    }
};
html,
body,    
#container {
    height: 100%;
    overflow: hidden;
    width: 100%;
}

In the dialog control, max-height is calculated based on the dialog target element height. If the target property is not configured, the document.body is considered as a target. Therefore, to show a dialog in proper height, you need to add min-height to the target element.

If the dialog is rendered based on the body element, it gets the height based on the body’s height. If the dialog height exceeds the body height, the dialog height will not be set. In this scenario, set the CSS height style for html and body elements:


html, body {
   height: 100%;
}

Run the application

Now, run the application in the browser using the following command.

npm start

See Also