Angular QueryBuilder - Setup

Smart UI for Angular supports both standalone components (bootstrapApplication) and NgModule-based apps (bootstrapModule(AppModule)). Steps 1-5 show the standalone path; the section below shows the NgModule path with the same package and styles.

Demo source (Smart UI repo): angular/src/querybuilder/overview

1 NPM Install

Install the smart-webcomponents-angular package:

npm install smart-webcomponents-angular

2 Register styles

Add the default Smart UI stylesheet to angular.json -> projects -> <your-project> -> architect -> build -> options -> styles (merge with existing entries):

"styles": [
		"node_modules/smart-webcomponents-angular/source/styles/smart.default.css"
	]

Add optional theme CSS from the same package after smart.default.css if you use Bootstrap, Fluent, or other bundled themes.

3 Import the Angular module

Import QueryBuilderModule from smart-webcomponents-angular/querybuilder: use @Component.imports for standalone, or add it to your AppModule (or feature module) imports array for NgModule apps.

import { QueryBuilderModule } from 'smart-webcomponents-angular/querybuilder';

4 Root component (standalone)

Add QueryBuilderModule to your root standalone component (src/app/app.ts). Snippet from Smart UI demos (paths normalized to app.html / App where applicable):

 import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
import { QueryBuilderComponent } from 'smart-webcomponents-angular/querybuilder';

import { QueryBuilderModule } from 'smart-webcomponents-angular/querybuilder';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [ QueryBuilderModule ],
  templateUrl: './app.html',
  styleUrl: './app.css'
})

export class App implements AfterViewInit, OnInit {	
	@ViewChild('querybuilder', { read: QueryBuilderComponent, static: false }) querybuilder!: QueryBuilderComponent;
	
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
		this.init();
    }
		
	init(): void {
		// init code.
	    
    window.Smart('#queryBuilder', class {
        get properties() {
            return {
                allowDrag: true,
                fields: [
                    { label: 'Id', dataField: 'id', dataType: 'number' },
                    { label: 'Product', dataField: 'productName', dataType: 'string' },
                    { label: 'Unit Price', dataField: 'price', dataType: 'number' },
                    { label: 'Purchased', dataField: 'purchased', dataType: 'datetime' },
                    { label: 'Available', dataField: 'available', dataType: 'boolean' }
                ]
            };
        }
    });

	}	
}

Boot the app with bootstrapApplication from src/main.ts and an ApplicationConfig in src/app/app.config.ts as generated by the CLI.

5 Template (standalone)

Use your markup in src/app/app.html (or inline template). Bind properties and events on smart-query-builder as needed:

 <div class="demo-description">The Query Builder component allows you to build complex quieries through
    UI. The output of the component is a JSON object with the query.</div>
<smart-query-builder
#querybuilder id="queryBuilder"></smart-query-builder>

6 NgModule bootstrap (also supported)

Same npm package and angular.json styles as steps 1-2. Put QueryBuilderModule on your NgModule.imports instead of @Component.imports, and bootstrap with bootstrapModule(AppModule).

The demo sources bundled for this widget use standalone only (there is no app.module.ts in that folder). NgModule is fully supported: put QueryBuilderModule from smart-webcomponents-angular/querybuilder on NgModule.imports, make your root component non-standalone (remove standalone: true and move widget modules from @Component.imports to the module), and bootstrap with platformBrowserDynamic().bootstrapModule(AppModule).

Minimal main.ts + app.module.ts pairing (adjust paths to match your CLI layout):

src/main.ts

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

platformBrowserDynamic().bootstrapModule(AppModule).catch((err) => console.error(err));

src/app/app.module.ts

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import { QueryBuilderModule } from 'smart-webcomponents-angular/querybuilder';

@NgModule({
	declarations: [ AppComponent ],
	imports: [ BrowserModule, QueryBuilderModule ],
	bootstrap: [ AppComponent ]
})
export class AppModule { }

Reuse the template and class logic from steps 4-5 in AppComponent, configured for declarations + NgModule.imports instead of a standalone @Component.

Run

ng serve or npm start - then open http://localhost:4200/.

Smart UI for Angular - full documentation

Common Use Cases

  • Get filter expression

    Retrieve the current query as a filter

    const filter = queryBuilder.value;
  • Set initial conditions

    Pre-populate the query builder

    queryBuilder.value = [
      ['productName', 'contains', 'Tea'],
      'and',
      ['price', '>', 5]
    ];

Troubleshooting

How do I get the filter expression?
Access queryBuilder.value to get the current conditions as an array that can be used for filtering data.
How do I add custom operators?
Define custom operators in the customOperations property for specific field types.

Accessibility

The QueryBuilder component follows WAI-ARIA best practices:

  • Keyboard navigation - Tab, Arrow keys, Enter, and Escape are supported
  • ARIA roles - Appropriate roles and labels are applied automatically
  • Focus management - Visible focus indicators for keyboard users
  • Screen readers - State changes are announced to assistive technology
  • High contrast - Supports Windows High Contrast Mode and forced colors

For custom labeling, set aria-label or aria-labelledby attributes on the component.

Live demos

Supported stacks: Smart UI targets Angular 17+, React 18+, Vue 3+, Node 18 LTS, and evergreen browsers; pin exact package versions to your org policy.