Querybuilder - Documentation | www.HtmlElements.com

Overview

Smart.QueryBuilder represents a control for building filter queries. Queries with multiple groups of conditions and different operators can be created.

Getting Started with QueryBuilder Web Component

Smart UI for Web Components is distributed as smart-webcomponents NPM package. You can also get the full download from our website with all demos from the Download page.

Setup the QueryBuilder

Smart UI for Web Components is distributed as smart-webcomponents NPM package

  1. Download and install the package.

    npm install smart-webcomponents

  2. Once installed, import the QueryBuilder module in your application.

    <script type="module" src="node_modules/smart-webcomponents/source/modules/smart.querybuilder.js"></script>

  3. Adding CSS reference

    The smart.default.css CSS file should be referenced using following code.

    <link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />

  4. Add the QueryBuilder tag to your Web Page

    <smart-query-builder id="querybuilder"></smart-query-builder>

  5. Create the QueryBuilder Component

    	<script type="module">
    		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' }
    				]
    			}
    			}
    		});
    	</script>	   
    		

    Another option is to create the QueryBuilder is by using the traditional Javascript way:
    	const querybuilder = document.createElement('smart-query-builder');
    
    	querybuilder.disabled = true;
    	document.body.appendChild(querybuilder);
    		

    Smart framework provides a way to dynamically create a web component on demand from a DIV tag which is used as a host. The following imports the web component's module and creates it on demand, when the document is ready. The #querybuilder is the ID of a DIV tag.

    	import "../../source/modules/smart.querybuilder.js";
    
    	document.readyState === 'complete' ? init() : window.onload = init;
    
    	function init() { 
    		const querybuilder = new Smart.QueryBuilder('#querybuilder', { 
    				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' }
    				]
    			});
    	}
    	

  6. Open the page in your web server.

Building a Filter Query

A complex filter query can be built by adding and manipulating conditions in the QueryBuilder's UI. In the element's initialization code, an array of fields to choose from is passed.

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" type="text/css" href=../../source/styles/smart.default.css" />
    <script type="text/javascript" src="../../source/smart.element.js"></script>
    <script type="text/javascript" src="../../source/smart.button.js"></script>
    <script type="text/javascript" src="../../source/smart.scrollbar.js"></script>
    <script type="text/javascript" src="../../source/smart.menu.js"></script>
    <script type="text/javascript" src="../../source/smart.input.js"></script>
    <script type="text/javascript" src="../../source/smart.complex.js"></script>
    <script type="text/javascript" src="../../source/smart.math.js"></script>
    <script type="text/javascript" src="../../source/smart.numeric.js"></script>
    <script type="text/javascript" src="../../source/smart.numerictextbox.js"></script>
    <script type="text/javascript" src="../../source/smart.calendar.js"></script>
    <script type="text/javascript" src="../../source/smart.date.js"></script>
    <script type="text/javascript" src="../../source/smart.draw.js"></script>
    <script type="text/javascript" src="../../source/smart.dropdownlist.js"></script>
    <script type="text/javascript" src="../../source/smart.listbox.js"></script>
    <script type="text/javascript" src="../../source/smart.timepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.tooltip.js"></script>
    <script type="text/javascript" src="../../source/smart.datetimepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.checkbox.js"></script>
    <script type="text/javascript" src="../../source/smart.filterbuilder.js"></script>
    <script>
        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' }
                    ]
                };
            }
        });
    </script>
</head>
<body>
    <smart-query-builder id="queryBuilder"></smart-query-builder>
</body>
</html>

Demo

The shown operations result in the following value:

[[["price","<","300"]],"and",[["available","=",true],"or",["productName","startswith","app"]]]

Whether or not conditions can be dragged is controlled by the property allowDrag.

Setting value Initially

A QueryBuilder can be initialized with a predefined value, as shown in the example below:

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" type="text/css" href=../../source/styles/smart.default.css" />
    <script type="text/javascript" src="../../source/smart.element.js"></script>
    <script type="text/javascript" src="../../source/smart.button.js"></script>
    <script type="text/javascript" src="../../source/smart.scrollbar.js"></script>
    <script type="text/javascript" src="../../source/smart.menu.js"></script>
    <script type="text/javascript" src="../../source/smart.input.js"></script>
    <script type="text/javascript" src="../../source/smart.complex.js"></script>
    <script type="text/javascript" src="../../source/smart.math.js"></script>
    <script type="text/javascript" src="../../source/smart.numeric.js"></script>
    <script type="text/javascript" src="../../source/smart.numerictextbox.js"></script>
    <script type="text/javascript" src="../../source/smart.calendar.js"></script>
    <script type="text/javascript" src="../../source/smart.date.js"></script>
    <script type="text/javascript" src="../../source/smart.draw.js"></script>
    <script type="text/javascript" src="../../source/smart.dropdownlist.js"></script>
    <script type="text/javascript" src="../../source/smart.listbox.js"></script>
    <script type="text/javascript" src="../../source/smart.timepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.tooltip.js"></script>
    <script type="text/javascript" src="../../source/smart.datetimepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.checkbox.js"></script>
    <script type="text/javascript" src="../../source/smart.filterbuilder.js"></script>
    <script>
        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' }
                    ],
                    value: [
                        [
                            ['purchased', '=', new Date(2019, 0, 4)],
                            'and',
                            ['productName', '<>', 'Monitors'],
                            'or',
                            ['productName', 'isblank']
                        ],
                        'and',
                        [
                            ['available', '=', true],
                            'and',
                            ['price', '<', 1300],
                        ]
                    ]
                };
            }
        });
    </script>
</head>
<body>
    <smart-query-builder id="queryBuilder"></smart-query-builder>
</body>
</html>

Demo

Custom Operations

Apart from standard comparison operations, such as Equals, Greater than, Less than, and Contains, users can define their own custom operations to use when creating queries with Smart.QueryBuilder:

Custom operations are defined by setting the customOperations property. Each member of this array can have the following fields:

  • label - label to be displayed in the operator box. Multiple operations with the same label can exist.
  • name - unique name of the operation
  • editorTemplate - callback function that creates a custom value editor
  • valueTemplate - callback function that displays the value after the edior has been closed
  • handleValue - callback function that handles the value returned by the editor when it is closed
  • hideValue - a boolean condition that specifies whether the operation requires a value or not

The name of the custom operation also has to be included in the filterOperations property/array of the field(s) it is applicable to.

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" type="text/css" href=../../source/styles/smart.default.css" />
    <script type="text/javascript" src="../../source/smart.element.js"></script>
    <script type="text/javascript" src="../../source/smart.button.js"></script>
    <script type="text/javascript" src="../../source/smart.scrollbar.js"></script>
    <script type="text/javascript" src="../../source/smart.menu.js"></script>
    <script type="text/javascript" src="../../source/smart.input.js"></script>
    <script type="text/javascript" src="../../source/smart.complex.js"></script>
    <script type="text/javascript" src="../../source/smart.math.js"></script>
    <script type="text/javascript" src="../../source/smart.numeric.js"></script>
    <script type="text/javascript" src="../../source/smart.numerictextbox.js"></script>
    <script type="text/javascript" src="../../source/smart.calendar.js"></script>
    <script type="text/javascript" src="../../source/smart.date.js"></script>
    <script type="text/javascript" src="../../source/smart.draw.js"></script>
    <script type="text/javascript" src="../../source/smart.dropdownlist.js"></script>
    <script type="text/javascript" src="../../source/smart.listbox.js"></script>
    <script type="text/javascript" src="../../source/smart.timepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.tooltip.js"></script>
    <script type="text/javascript" src="../../source/smart.datetimepicker.js"></script>
    <script type="text/javascript" src="../../source/smart.checkbox.js"></script>
    <script type="text/javascript" src="../../source/smart.filterbuilder.js"></script>
    <script>
        Smart('#queryBuilder', class {
            get properties() {
                return {
                    customOperations: [
                        { label: 'Matches /^\d{7}$/g', name: '/^\d{7}$/g', hideValue: true },
                        {
                            label: 'Is valid',
                            name: 'isvalid',
                            editorTemplate: function (fieldType, value, fieldData) {
                                const editor1 = document.createElement('smart-radio-button'),
                                    editor2 = document.createElement('smart-radio-button'),
                                    container = document.createElement('div');

                                editor1.innerHTML = 'Yes';
                                editor2.innerHTML = 'No';
                                container.className = 'container';

                                if (typeof value !== 'boolean') {
                                    value = !!parseFloat(value);
                                }

                                editor1.checked = value;
                                editor2.checked = !value;

                                container.appendChild(editor1);
                                container.appendChild(editor2);

                                return container;
                            },
                            valueTemplate: function (editor, value) {
                                return value ? '<em>yes</em>' : '<em>no</em>';
                            },
                            handleValue: function (editor) {
                                const editors = editor.getElementsByTagName('smart-radio-button');

                                return editors[0].checked;
                            }
                        }],
                    fields: [
                        { label: 'Id', dataField: 'id', dataType: 'number', filterOperations: ['=', '<', '>', 'isvalid'] },
                        { label: 'Product', dataField: 'productName', dataType: 'string' },
                        { label: 'Product code', dataField: 'productCode', dataType: 'string', filterOperations: ['=', '/^\d{7}$/g'] },
                        { label: 'Unit Price', dataField: 'price', dataType: 'number' },
                        { label: 'Produced', dataField: 'produced', dataType: 'date', filterOperations: ['<', '>'] },
                        { label: 'Purchased', dataField: 'purchased', dataType: 'datetime' },
                        { label: 'Available', dataField: 'available', dataType: 'boolean' }
                    ],
                    value: [
                        [
                            ['productCode', '/^\d{7}$/g'],
                            'or',
                            ['id', 'isvalid', true]
                        ],
                        'and',
                        [
                            ['available', '=', true],
                            'and',
                            ['price', '<', 1300],
                        ]
                    ]
                }
            }
        });
    </script>
</head>
<body>
    <smart-query-builder id="queryBuilder"></smart-query-builder>
</body>
</html>

Demo

Operation Icons

Icons can be shown next to labels in the coparison operation box by setting the property showIcons to true. The icons property, on the other hand, defines CSS classes to be applied to each of the built-in operations. Icons for these classes are applied in the smart-query-builder style sheet.

Demo

To apply a custom icon to a particular operation, add CSS that defines the icon's appearance:

<style type="text/css">
    .custom-equals-icon:after {
        background-image: url("https://img.icons8.com/officel/16/000000/equal-sign.png");
    }
</style>

then set the respective icons field (in this case, '=', the Equals operation) to the name of the class defined in the CSS:

document.getElementById('queryBuilder').icons['='] = 'custom-equals-icon';

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event


Create a new element:
	const querybuilder = document.createElement('smart-query-builder');
	

Append it to the DOM:
	document.body.appendChild(querybuilder);
	

Remove it from the DOM:
	querybuilder.parentNode.removeChild(querybuilder);
	

Set a property:
	querybuilder.propertyName = propertyValue;
	

Get a property value:
	const propertyValue = querybuilder.propertyName;
	

Invoke a method:
	querybuilder.methodName(argument1, argument2);
	

Add Event Listener:
	const eventHandler = (event) => {
	   // your code here.
	};

	querybuilder.addEventListener(eventName, eventHandler);
	

Remove Event Listener:
	querybuilder.removeEventListener(eventName, eventHandler, true);
	

Using with Typescript

Smart Web Components package includes TypeScript definitions which enables strongly-typed access to the Smart UI Components and their configuration.

Inside the download package, the typescript directory contains .d.ts file for each web component and a smart.elements.d.ts typescript definitions file for all web components. Copy the typescript definitions file to your project and in your TypeScript file add a reference to smart.elements.d.ts

Read more about using Smart UI with Typescript.

Getting Started with Angular QueryBuilder Component

Setup Angular Environment

Angular provides the easiest way to set angular CLI projects using Angular CLI tool.

Install the CLI application globally to your machine.

npm install -g @angular/cli

Create a new Application

ng new smart-angular-querybuilder

Navigate to the created project folder

cd smart-angular-querybuilder

Setup the QueryBuilder

Smart UI for Angular is distributed as smart-webcomponents-angular NPM package

  1. Download and install the package.
    npm install smart-webcomponents-angular
  2. Once installed, import the QueryBuilderModule in your application root or feature module.

    app.module.ts

    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
    
    import { QueryBuilderModule } from 'smart-webcomponents-angular/querybuilder';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, QueryBuilderModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ AppComponent ]
    })
    
    export class AppModule { }
    	

  3. Adding CSS reference

    The following CSS file is available in ../node_modules/smart-webcomponents-angular/ package folder. This can be referenced in [src/styles.css] using following code.

    	@import 'smart-webcomponents-angular/source/styles/smart.default.css';

    Another way to achieve the same is to edit the angular.json file and in the styles add the style.

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


    app.component.html

     
    <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>
    		

    app.component.ts

     
    import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
    import { QueryBuilderComponent } from 'smart-webcomponents-angular/querybuilder';
    
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
    	styleUrls: ['./app.component.css']
    })
    
    export class AppComponent 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' }
                    ]
                };
            }
        });
    
    	}	
    }
    		

    app.module.ts

     
    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
    
    import { QueryBuilderModule } from 'smart-webcomponents-angular/querybuilder';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, QueryBuilderModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ AppComponent ]
    })
    
    export class AppModule { }
    		


Running the Angular application

After completing the steps required to render a QueryBuilder, run the following command to display the output in your web browser

ng serve
and open localhost:4200 in your favorite web browser.

Read more about using Smart UI for Angular: https://www.htmlelements.com/docs/angular-cli/.

Getting Started with React QueryBuilder Component

Setup React Environment

The easiest way to start with React is to use create-react-app. To scaffold your project structure, follow the installation instructions.

	npm install -g create-react-app
	create-react-app my-app
	cd my-app
	npm start
	

Preparation

Open src/App.js andsrc/App.css

  1. Remove everything inside the App div tag in src/App.js:
    <div className="App"> </div>
  2. Remove the logo.svg import
  3. Remove the contents of src/App.css
  4. Remove src/logo.svg

Setup the QueryBuilder

Smart UI for React is distributed as smart-webcomponents-react NPM package

  1. Download and install the package.
    npm install smart-webcomponents-react
  2. Once installed, import the React QueryBuilder Component and CSS files in your application and render it app.js

    import 'smart-webcomponents-react/source/styles/smart.default.css';
    import React from "react";
    import ReactDOM from "react-dom";
    import { QueryBuilder } from 'smart-webcomponents-react/querybuilder';
    
    class App extends React.Component {
    
    
    	componentDidMount() {
    
    	}
    
    	render() {
    		return (
    			<div>
    				<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>
    				<QueryBuilder allowDrag
    					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'
    					}
    					]}
    					ref="querybuilder" id="queryBuilder"></QueryBuilder>
    			</div >
    		);
    	}
    }
    
    ReactDOM.render(<App />, document.querySelector("#root"));
    
    export default App;
    	

Running the React application

Start the app with
npm start
and open localhost:3000 in your favorite web browser to see the output.

Read more about using Smart UI for React: https://www.htmlelements.com/docs/react/.

Getting Started with Vue QueryBuilder Component


Setup Vue Environment

We will use vue-cli to get started. Let's install vue-cli

npm install -g @vue/cli

Then we can start creating our Vue.js projects with:

vue create my-project

Setup the QueryBuilder

Open the "my-project" folder and run:

npm install smart-webcomponents

Setup with Vue 3.x

  • Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

    Open src/main.js in your favorite text editor and change its contents to the following:

    main.js

    import { createApp } from 'vue'
    import App from './App.vue'
    
    const app = createApp(App)
    
    app.config.isCustomElement = tag => tag.startsWith('smart-');
    app.mount('#app')
    		
  • Open src/App.vue in your favorite text editor and change its contents to the following:

    App.vue

    <template>
      <div class="vue-root">
        <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 id="queryBuilder"></smart-query-builder>
      </div>
    </template>
    
    <script>
    import { onMounted } from "vue";
    import "smart-webcomponents/source/styles/smart.default.css";
    import "smart-webcomponents/source/modules/smart.querybuilder.js";
    
    export default {
      name: "app",
      setup() {
        onMounted(() => {
          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"
                    }
                  ]
                };
              }
            }
          );
        });
      }
    };
    </script>
    
    <style>
    body {
      height: 800px;
    }
    </style>
    		
    We can now use the smart-query-builder with Vue 3. Data binding and event handlers will just work right out of the box.

Setup with Vue 2.x

  • Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

    Open src/main.js in your favorite text editor and change its contents to the following:

    main.js

    import Vue from 'vue'
    import App from './App.vue'
    
    Vue.config.productionTip = false
    Vue.config.ignoredElements = [
    'smart-query-builder'
    ]
    
    new Vue({
      render: h => h(App),
    }).$mount('#app')
  • Open src/App.vue in your favorite text editor and change its contents to the following:

    App.vue

    <template>
      <smart-query-builder id="queryBuilder"></smart-query-builder>
    </template>
    
    <script>
    import 'smart-webcomponents/source/modules/smart.querybuilder.js';
    import "smart-webcomponents/source/styles/smart.default.css";
    
    export default {
      name: "app",
      mounted: function() {
        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' }
                        ]
                   };
              }
         });
      }
    };
    </script>
    
    <style>
    </style>
    		
    We can now use the smart-query-builder with Vue. Data binding and event handlers will just work right out of the box.
    We have bound the properties of the smart-query-builder to values in our Vue component.

Running the Vue application

Start the app with
npm run serve
and open localhost:8080 in your favorite web browser to see the output below:

Read more about using Smart UI for Vue: https://www.htmlelements.com/docs/vue/.