Getting started in EJ2 TypeScript Avatar control

28 Jul 20262 minutes to read

This section explains the steps to create a simple Avatar and demonstrates the basic usage of the Avatar 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. 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® TypeScript Avatar packages

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-layouts package:

npm install @syncfusion/ej2-layouts --save

Install the required npm packages:

npm install

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

Import Syncfusion® CSS styles

Syncfusion® TypeScript 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/avatar/index.css";

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

Add Syncfusion® Avatar control to the application

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

In this article, the Avatar control is used as an example. Add the following Avatar 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>
    <div id='element'>
        <span class="e-avatar e-avatar-xlarge"></span>
    </div>
    <style>
        .e-avatar {
            background-image: url(https://ej2.syncfusion.com/demos/src/avatar/images/pic01.png);
        }
    </style>
</body>

</html>

Run the application

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

npm start

See also