Getting started with EJ2 TypeScript Badge control

7 May 20255 minutes to read

This section explains how to create a simple Badge control and configure its available functionalities in TypeScript using the Essential® JS 2 quickstart seed repository.

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.

Dependencies

Install the following required dependent package to render the Badge control.

|-- @syncfusion/ej2-notifications

Set up development environment

Open the command prompt from the required directory, and run the following command to clone the Syncfusion® JavaScript (Essential® JS 2) quickstart project from GitHub.

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

After cloning the application in the ej2-quickstart folder, run the following command line to navigate to the ej2-quickstart folder.

cd ej2-quickstart

Add Syncfusion® JavaScript packages

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

The quickstart application is preconfigured with the dependent @syncfusion/ej2 package in the ~/package.json file. Use the following command to install the dependent npm packages from the command prompt.

npm install

Import the Syncfusion® CSS styles

The badge CSS files are available in the ej2-notifications package folder. This can be referenced in the ~/src/styles/styles.css file of your application using the following code.

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

We can also use CRG to generate combined control styles.

Add badge into application

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

Add an HTML span element with e-badge class inside any wrapper element (h1) into your index.html.

[src/index.html]

<h1>Badge Control <span class="e-badge">New</span></h1>

Run the application

Run the application in the browser using the following command.

npm start

The following example shows a basic badge control.

<!DOCTYPE html> <html lang="en"> <head> <title>Essential JS 2 for Badge </title> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="description" content="Essential JS 2 for Badge UI Control" /> <meta name="author" content="Syncfusion" /> <link href="index.css" rel="stylesheet" /> <link href="https://cdn.syncfusion.com/ej2/31.2.12/ej2-base/styles/material.css" rel="stylesheet" /> <link href="https://cdn.syncfusion.com/ej2/31.2.12/ej2-notifications/styles/material.css" rel="stylesheet" /> <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script> <script src="systemjs.config.js"></script> <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script> </head> <body> <div id='loader'>Loading....</div> <div id='container'> <div id='element'> <h1>Badge control <span class="e-badge e-badge-primary">New</span></h1> </div> </div> <style> #element { display: flex; width: 400px; margin: auto; border: 1px solid #dddddd; border-radius: 3px; justify-content: center; } </style> </body> </html>
#container { visibility: hidden; } #loader { color: #008cff; height: 40px; width: 30%; position: absolute; font-family: 'Helvetica Neue','calibiri'; font-size: 14px; top: 45%; left: 45%; }

See Also

Types of Badge