How to get started easily with Syncfusion Angular 9 Query Builder ?

A quick start project that helps you to create an Angular 9 Query Builder with a minimal code configurations.

Angular 9 Query Builder

The following section explains you how to create a simple angular 9 Query Builder component.

Prerequisites

Before start, we need following items to create Angular Query Builder in Angular 9 application

• Node.js (latest version)
• Angular
• Angular CLI
• Visual studio code for editor.
• Typescript 3.7+

Dependencies

The angular 9 Query Builder is created from the Syncfusion ej2-angular-querybuilder package from npmjs, which are distributed in npm as @syncfusion scoped packages.

Creating Angular Project

• Install Angular cli 9 using following command.

  npm install -g @angular/cli@9.0.2
  

• Create a new Angular 9 project using angular cli and navigate to that folder.

  ng new <project name>
  cd <project name>
  

Adding Angular Query Builder

• After running the Angular 9 application successfully, configure the Angular Query Builder in this application. Install Angular Query Builder and EJ2 package using following command. The --save command will instruct the NPM to include a Query Builder package inside the dependencies section of the package.json.

  npm install @syncfusion/ej2-angular-querybuilder --save
  

• Import Query Builder from installed package.
• Import and inject the other required modules within the providers section of app.module.ts.

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { QueryBuilderModule } from '@syncfusion/ej2-angular-querybuilder';
  import { AppComponent } from './app.component';
  import { enableRipple } from '@syncfusion/ej2-base';
   
  enableRipple(true);
   
  @NgModule({
    declarations: [
      AppComponent
    ],
    imports: [
      BrowserModule,
      QueryBuilderModule
    ],
    providers: [],
    bootstrap: [AppComponent]
  })
  export class AppModule {} 
  

• Add the given below angular query builder’s styles in styles.css.

  @import "../node_modules/@syncfusion/ej2-base/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-dropdowns/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-inputs/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-calendars/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-popups/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-querybuilder/styles/material.css";
  

• Add the angular Query Builder component in app.component.ts.

  import { Component } from '@angular/core';
   
  @Component({
      selector: 'app-root',
      template: `<ejs-querybuilder width="70%">
      <e-columns>
          <e-column field="EmployeeID" label="Employee ID" type="number"></e-column>
          <e-column field="FirstName" label="First Name" type="string"></e-column>
          <e-column field="TitleOfCourtesy" label="Title Of Courtesy" type="boolean" [values]="values"></e-column>
          <e-column field="Title" label="Title" type="string"></e-column>
          <e-column field="HireDate" label="Hire Date" type="date" format="dd/MM/yyyy"></e-column>
          <e-column field="Country" label="Country" type="string"></e-column>
          <e-column field="City" label="City" type="string"></e-column>
      </e-columns>
  </ejs-querybuilder>`
  })
  export class AppComponent  {
      public values: string[] = ['Mr.', 'Mrs.'];
  }
  

• Now serve the application using following command.

  ng serve 
  

Once the files are compiled successfully, it will serve the site at localhost:4200

Screenshot:

Rendering with Rule

You can render the Query Builder component with rule, using the rule property. [app.component.ts]

import { Component , OnInit  } from '@angular/core';
import { RuleModel } from '@syncfusion/ej2-angular-querybuilder';
 
@Component({
    selector: 'app-root',
    template: `<ejs-querybuilder width="70%" [rule] = "importRules">
    <e-columns>
        <e-column field="EmployeeID" label="Employee ID" type="number"></e-column>
        <e-column field="FirstName" label="First Name" type="string"></e-column>
        <e-column field="TitleOfCourtesy" label="Title Of Courtesy" type="boolean" [values]="values"></e-column>
        <e-column field="Title" label="Title" type="string"></e-column>
        <e-column field="HireDate" label="Hire Date" type="date" format="dd/MM/yyyy"></e-column>
        <e-column field="Country" label="Country" type="string"></e-column>
        <e-column field="City" label="City" type="string"></e-column>
    </e-columns>
</ejs-querybuilder >`
})
export class AppComponent implements OnInit {
    public importRules: RuleModel;
    public values: string[] = ['Mr.', 'Mrs.'];
    
    ngOnInit(): void {
    this.importRules = {
        'condition': 'and',
        'rules': [{
            'label': 'Employee ID',
            'field': 'EmployeeID',
            'type': 'number',
            'operator': 'equal',
            'value': 1
        },
        {
            'label': 'Title',
            'field': 'Title',
            'type': 'string',
            'operator': 'equal',
            'value': 'Sales Manager'
        }]
    };
}
}

Screenshot:

Summary

Refer to our documentation and online samples for more features. If you have any queries, please let us know in comments below.  You can also contact us through our Support forum or Direct-Trac. We are happy to assist you!