Getting started in EJ2 TypeScript MultiSelect control

24 Jul 20263 minutes to read

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

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

npm install @syncfusion/ej2-dropdowns

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/multi-select/index.css";

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

Add Syncfusion® MultiSelect control to the application

The MultiSelect can be initialized through three different tags as described in the Initialize Tags.

Add the HTML input element that needs to be initialized as a MultiSelect in index.html.

[src/index.html]

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

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

<body>
    <div id='container' style="margin:0 auto; width:300px;">
        <!--element which is going to render the MultiSelect-->
        <input type="text" tabindex="1" id='select' />
    </div>

</body>

</html>

Now, import the MultiSelect component to your app.ts and initialize it to the element #select as shown below.

After initialization, populate the MultiSelect with data using the dataSource  property. Here, an array of string values is passed to the MultiSelect component.

[src/app/app.ts]

import { MultiSelect } from '@syncfusion/ej2-dropdowns';

// define the array of data
let sportsData: string[] = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Gymnastics', 'Hockey', 'Rugby', 'Snooker', 'Tennis'];

// initialize MultiSelect component
let msObject: MultiSelect = new MultiSelect({
    //set the data to dataSource property
    dataSource: sportsData
});

// render initialized MultiSelect
msObject.appendTo('#select');

Run the application

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

npm start

See Also