Getting started with EJ2 TypeScript Query Builder UI

4 Sep 20263 minutes to read

This section explains how to create a simple Query Builder and demonstrates the basic usage of the component using the Essential® JS 2 quickstart seed repository. The seed project is preconfigured 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:

Setup for local development

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:

cd ej2-quickstart

Add Syncfusion® TypeScript Query Builder packages

Install the @syncfusion/ej2-querybuilder package:

npm install @syncfusion/ej2-querybuilder --save

Install the remaining 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 that are available from the npm theme packages. Themes can also be loaded via CDN or customized with 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/query-builder/index.css";

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

Add the Query Builder control to the application

Open the application in Visual Studio Code and add the Query Builder 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>
        <div id="querybuilder"></div>
    </div>
</body>

</html>

To render the Query Builder control, add the following TypeScript code to the ~/src/app/app.ts file:

import { QueryBuilder, ColumnsModel } from '@syncfusion/ej2-querybuilder';

let columnData: ColumnsModel[] = [
    { field: 'EmployeeID', label: 'EmployeeID', type: 'number' },
    { field: 'FirstName', label: 'FirstName', type: 'string' },
    { field: 'TitleOfCourtesy', label: 'Title Of Courtesy', type: 'boolean', values: ['Mr.', 'Mrs.'] },
    { field: 'Title', label: 'Title', type: 'string' },
    { field: 'HireDate', label: 'HireDate', type: 'date', format: 'dd/MM/yyyy' },
    { field: 'Country', label: 'Country', type: 'string' },
    { field: 'City', label: 'City', type: 'string' }
];

let qryBldrObj: QueryBuilder = new QueryBuilder({
    width: '70%',
    columns: columnData
});

qryBldrObj.appendTo('#querybuilder');

Run the application

Run the app in the browser with the following command:

npm start

See also