Angular Query Builder
Demo: http://niklr.github.io/angular-query-builder
This is a sample HTML / JavaScript application that demonstrates how to use AngularJS in combination with Bootstrap to create a dynamic query building web user interface.
The project was inspired by: https://github.com/mfauveau/angular-query-builder
Additional features:
- Autocomplete based on selected options implemented with Bootstrap's typeahead plugin.
- Dynamic source fields based on selected source types.
- Dynamic comparison operators based on selected source field.
- Nested form validation.
- Configurable maximum for groups and conditions.
- Fancy enter and leave animations for groups and conditions.
Table of Content
Dependencies
Basic setup
index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Angular Query Builder</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link href="libraries/bootstrap/css/bootstrap.css" rel="stylesheet"> <link href="libraries/bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> <link href="main.css" rel="stylesheet"> </head> <body ng-app="app"> <div ng-controller="MainController"> <div class="aqb-search-form"> <form name="searchForm" ng-submit="search(searchForm, $event)"> <div class="aqb-search-form-body"> <div class="aqb-animate-combined" ng-repeat="group in searchContainer.groups | orderBy:'index'"> <div search-group search-container="searchContainer" groups="searchContainer.groups" group-index="$index" source-types="sourceTypes" logical-operators="logicalOperators"></div> </div> </div> <div class="aqb-search-form-footer"> <button type="submit" class="btn" ng-disabled="searchForm.$invalid">Search</button> </div> </form> </div> <div> <pre>{{jsonOutput}}</pre> </div> </div> <script src="libraries/jquery/jquery.js"></script> <script src="libraries/bootstrap/js/bootstrap.js"></script> <script src="libraries/angular/angular.js"></script> <script src="libraries/angular/angular-animate.js"></script> <script src="libraries/underscore/underscore.js"></script> <script src="js/angular-query-builder-templates.min.js"></script> <script src="js/angular-query-builder.min.js"></script> <script src="main.js"></script> </body> </html>main.js
angular.module('app', [ 'angular-query-builder' ]) .controller('MainController', ['$scope', 'AppConfig', function ($scope, AppConfig) { AppConfig.setMaxGroups(4); AppConfig.setMaxConditions(4); $scope.jsonOutput = {}; $scope.search = function (form, $event) { $scope.jsonOutput = JSON.stringify($scope.searchContainer, null, 4); }; $scope.sourceTypes = [ { "name": "Objects", "displayName": "Objects", "sourceFields": [ { "name": "ObjectId", "displayName": "Id", "comparisonOperators": [ { "name": "Equals", "displayName": "=" }, { "name": "NotEquals", "displayName": "!=" } ] } ], } ]; $scope.logicalOperators = [ { "name": "And", "displayName": "AND" }, { "name": "Or", "displayName": "OR" } ]; var defaultSearchContainer = { "groups": [ { "sourceType": { "name": "Objects", "displayName": "Objects" }, "logicalOperator": { "name": "And", "displayName": "AND" }, "conditions": [ {} ] } ] }; $scope.searchContainer = defaultSearchContainer; }]);Configuration
AppConfig.setMaxGroupsSets the maximum amount of groups the user is able to create.AppConfig.setMaxConditionsSets the maximum amount of conditions the user is able to create.
Terminology
Angular Query Builder differentiates between SearchContainer, Group, Condition, SourceType, SourceField, ComparisonOperator, LogicalOperator and InputItem. Each object can be dynamically defined within the $scope of the AngularJS controller.
SearchContainercan contain one or multipleGroup.Groupconsists of aSourceType,LogicalOperatorand one or multipleCondition.Conditionconsists of aSourceField,ComparisonOperatorand anInputItem.SourceTypebasically represents the source to be searched. It is possible to define multipleSourceTypebut in most cases one is sufficient. TheSourceTypeobject consists of the following keys:nameis a stringdisplayNameis a stringsourceFieldsis an array ofSourceFieldobjects
SourceFielddefines the available options for the first dropdown element of eachCondition. TheSourceFieldobject consists of the following keys:nameis a stringdisplayNameis a stringcomparisonOperatorsis an array ofComparisonOperatorobjects
ComparisonOperatordefines the available options for the second dropdown element of eachCondition. TheComparisonOperatorobject consists of the following keys:nameis a stringdisplayNameis a string
LogicalOperatordefines how eachConditionin aGroupshould be logically connected. TheLogicalOperatorobject consists of the following keys:nameis a stringdisplayNameis a string
InputItemcontains the data entered by the user. TheInputItemobject consists of the following keys:datais a stringdisplayNameis a string
Building
In order to build Angular Query Builder, ensure that you have Git and Node.js installed.
Clone a copy of the repo:
git clone https://github.com/niklr/angular-query-builder.gitChange to the angular-query-builder directory:
cd angular-query-builderInstall Grunt and dev dependencies:
npm install -g grunt-cli npm installUse one of the following to build:
grunt release # Builds into dist grunt release-watch # Same as release + watching for changes 
