QueryBuilder JAVASCRIPT UI Component API

QueryBuilder Javascript API

Class

QueryBuilder

QueryBuilder allows you to build dynamically queries for filtering.

Allows users to drag and reorder conditions within a single group or move conditions between different groups, facilitating flexible arrangement and organization of conditions through a user-friendly drag-and-drop interface.

Default value

false

Try a demo showcasing the allowDrag property.

Example

Set the allowDrag property.

 <smart-query-builder allow-drag></smart-query-builder>

Set the allowDrag property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.allowDrag = false;

Get the allowDrag property.

 const querybuilder = document.querySelector('smart-query-builder');

 let allowDrag = querybuilder.allowDrag;

animation"none" | "simple" | "advanced"

Specifies or retrieves the current animation mode. When this property is set to 'none', all animations are disabled. Otherwise, the selected mode determines how animations are displayed within the component.

Allowed Values

"none" - animation is disabled
"simple" - ripple animation is disabled
"advanced" - all animations are enabled

Default value

"advanced"

Example

Set the animation property.

 <smart-query-builder animation='none'></smart-query-builder>

Set the animation property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.animation = 'simple';

Get the animation property.

 const querybuilder = document.querySelector('smart-query-builder');

 let animation = querybuilder.animation;

applyMode"change" | "immediately"

Controls the timing of when the element’s value is updated in response to changes, such as user input or interactions. This setting specifies whether the value updates immediately as the user types, when the input loses focus, or upon a specific event.

Allowed Values

"change" - The value of the element is updated when a change event is fired form one of the editors.
"immediately" - The value of the element is updated immediately after an editor's value is changed.

Default value

"change"

Example

Set the applyMode property.

 <smart-query-builder apply-mode='immediately'></smart-query-builder>

Set the applyMode property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.applyMode = 'change';

Get the applyMode property.

 const querybuilder = document.querySelector('smart-query-builder');

 let applyMode = querybuilder.applyMode;

autoApplyValueboolean

When 'applyMode' is set to 'immediately', the default value is instantly assigned to the editor's value, and the QueryBuilder's value is updated in real-time without requiring any additional user action. This ensures that changes are automatically reflected as soon as the default value is set.

Default value

false

Example

Set the autoApplyValue property.

 <smart-query-builder auto-apply-value></smart-query-builder>

Set the autoApplyValue property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.autoApplyValue = false;

Get the autoApplyValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let autoApplyValue = querybuilder.autoApplyValue;

autoPromptboolean

Controls whether the QueryBuilder component will automatically display a prompt asking the user to enter a value when a new condition is added. If 'applyMode' is set to 'immediately', and the operation field of a newly created condition is empty, QueryBuilder will automatically populate the operation field when the user selects or changes the condition operator. Additionally, whenever the operation or operator of an existing condition is changed, the input field will prompt the user to enter a new value relevant to the updated condition. This ensures that condition values are collected promptly and accurately as users modify or add filtering criteria.

Default value

false

Example

Set the autoPrompt property.

 <smart-query-builder auto-prompt></smart-query-builder>

Set the autoPrompt property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.autoPrompt = false;

Get the autoPrompt property.

 const querybuilder = document.querySelector('smart-query-builder');

 let autoPrompt = querybuilder.autoPrompt;

customOperations{label: string, name: string, editorTemplate: function, valueTemplate: function, handleValue: function, hideValue: boolean, expressionTemplate: string, expressionReaderCallback: function, expressionBuilderCallback: function}[]

Enhances the query builder’s condition structure by allowing additional custom operations. Each custom operation can be defined with the following fields:

Properties

labelstring

label to be displayed in the operator box. Multiple operations with the same label can exist

Default value

Get the label property.

 const querybuilder = document.querySelector('smart-query-builder');

 let label = querybuilder.customOperations[0].label;

namestring

A unique name for the operation.

Default value

Get the name property.

 const querybuilder = document.querySelector('smart-query-builder');

 let name = querybuilder.customOperations[0].name;

editorTemplatefunction

A callback function that creates a custom value editor. Takes three arguemnts:

fieldType - the type of the field for the operation.
value - the value of the condition.
fieldData - the field object.

Get the editorTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let editorTemplate = querybuilder.customOperations[0].editorTemplate;

valueTemplatefunction

A callback function that displays the value after the edior has been closed. Takes two argument:

editor - the custom editor element
value - the condition value.

Get the valueTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valueTemplate = querybuilder.customOperations[0].valueTemplate;

handleValuefunction

A callback function that handles the value returned by the editor when it is closed. The callback takes one arguemnt - the custom editor element. If the dataType is 'object' the expected result from the function should contain a 'label' and 'value' attributes. Where the label will be used for displaying purposes while 'value' will be used as the actual value.

Get the handleValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let handleValue = querybuilder.customOperations[0].handleValue;

hideValueboolean

A boolean condition that specifies whether the operation requires a value or not.

Default value

false

Get the hideValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let hideValue = querybuilder.customOperations[0].hideValue;

validateValuefunction

A callback that is executed when QueryBuilder validation is triggered. The callback takes one argument, the value of the condition. The function should return true or false to determine whether the conditon is valid or not.

Get the validateValue property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validateValue = querybuilder.customOperations[0].validateValue;

onEditorOpenfunction

A callback that is called when the custom editor is rendered, visible inside the DOM and ready to be opened. The callback has one parameter - the custom editor element.

Get the onEditorOpen property.

 const querybuilder = document.querySelector('smart-query-builder');

 let onEditorOpen = querybuilder.customOperations[0].onEditorOpen;

expressionTemplatestring

A string representing a custom Linq expression template. If the value of the element is a string it will be considered as a Linq expression and it will be checked against all expressionTemplates to find a match.

Default value

"null"

Get the expressionTemplate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionTemplate = querybuilder.customOperations[0].expressionTemplate;

expressionReaderCallbackfunction

A callback that is used to specify which arguments from the expression are used for the fieldName and value. Used when converting a Linq expression to QueryBuilder value. Takes two arguments:

expression - the LinQ expression defined in the expressionTemplate of the customOperator. Type string
bindings - an array of expression parameters based on the expression template of the customOperator. Type string[]

Get the expressionReaderCallback property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionReaderCallback = querybuilder.customOperations[0].expressionReaderCallback;

expressionBuilderCallbackfunction

A callback function that is used to specify which arguments from the Linq expression are used for the fieldName and value when building the Linq expression from the current value of the element. Takes three arguments:

name - the name of the dataField. Type string.
operation - the name of the operation. Type string
value - the value of the operation. Type any( depends on the dataField).

Get the expressionBuilderCallback property.

 const querybuilder = document.querySelector('smart-query-builder');

 let expressionBuilderCallback = querybuilder.customOperations[0].expressionBuilderCallback;

Try a demo showcasing the customOperations property.

Example

Set the customOperations property.

 <smart-query-builder custom-operations='[{ label: "Matches /^\d{7}$/g", name: "/^\d{7}$/g", hideValue: true }, { label: "Similar to", name: "similar" }]'></smart-query-builder>

Set the customOperations property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.customOperations = [{ label: 'Is valid', name: 'isvalid' }];

Get the customOperations property.

 const querybuilder = document.querySelector('smart-query-builder');

 let customOperations = querybuilder.customOperations;

disabledboolean

Specifies whether the element is interactive and can receive user input. When enabled, the element functions normally. When disabled, the element becomes non-interactive and typically appears visually distinct (e.g., grayed out), preventing user actions such as clicks or text entry.

Default value

false

Example

Set the disabled property.

 <smart-query-builder disabled></smart-query-builder>

Set the disabled property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.disabled = false;

Get the disabled property.

 const querybuilder = document.querySelector('smart-query-builder');

 let disabled = querybuilder.disabled;

dropDownWidthstring

Configures or retrieves the width (in pixels) of the dropdown menus used in both the property and operator editors, allowing for precise control over their display size in the user interface.

Default value

"100%"

Example

Set the dropDownWidth property.

 <smart-query-builder drop-down-width='300'></smart-query-builder>

Set the dropDownWidth property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.dropDownWidth = '80%';

Get the dropDownWidth property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dropDownWidth = querybuilder.dropDownWidth;

fields{label: string, dataField: string, dataType: string, dataType: string, format: any, filterOperations: string[]}[]

''

An array defining the filterable fields and their corresponding configuration options to control their behavior and appearance. Each field in the array is represented as an object and can be customized using the following properties:

- 'label':
The human-readable name for the field. This label will be displayed in the filter field selection dropdown.

- 'dataField':
The key or property name in your data source that corresponds to this field.

- 'dataType':
Specifies the type of data contained in the field, such as ''string'', ''number'', ''date'', etc. This setting can affect which filter operations are available.

- 'filterOperations':
An array specifying which filter operations (such as ''contains'', ''equals'', ''greaterThan'', etc.) can be applied to this field. If this property is omitted, a default set of operations appropriate to the data type will be used.

- 'lookup':
An object for configuring the value selection input when filtering this field. The 'lookup' object supports the following options:

- 'autoCompleteDelay':
The delay, in milliseconds, between when the user types in the value selection input and when the dropdown with available options appears.

- 'dataSource':
An array containing the set of predefined options that the user can choose from in the dropdown.

- 'minLength':
The minimum number of characters the user must enter in the input before the options dropdown is shown.

- 'readonly':
Set to 'true' to make the value selection input act as a standard dropdown (the user can only select from the list); set to 'false' for a combo box (the user can type custom values in addition to choosing from the list).

This structure provides developers with fine-grained control over how each filter field appears and operates, including the available filter types and the way users select or enter filter values.

Properties

labelstring

Sets or gets the label.

Default value

Get the label property.

 const querybuilder = document.querySelector('smart-query-builder');

 let label = querybuilder.fields[0].label;

dataFieldstring

Sets or gets the data field

Default value

Get the dataField property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dataField = querybuilder.fields[0].dataField;

dataTypestring

Sets or gets the data type.

Default value

"string"

Get the dataType property.

 const querybuilder = document.querySelector('smart-query-builder');

 let dataType = querybuilder.fields[0].dataType;

formatstring

Sets or gets the filter format.

Default value

Get the format property.

 const querybuilder = document.querySelector('smart-query-builder');

 let format = querybuilder.fields[0].format;

filterOperationsstring[]

Sets or gets the filter operations.

Default value

[]

Get the filterOperations property.

 const querybuilder = document.querySelector('smart-query-builder');

 let filterOperations = querybuilder.fields[0].filterOperations;

Try a demo showcasing the fields property.

Example

Set the fields property.

 <smart-query-builder fields='[{ "label": "id", "dataField": "id", "dataType": "number", "format": null, "filterOperations": ["=", "anyof"] }, { "label": "Product", "dataField": "productName", "dataType": "string", "format": null }]'></smart-query-builder>

Set the fields property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.fields = [{ "label": "id", "dataField": "id", "dataType": "number", "format": null, "filterOperations": ["=", "anyof"] }, { "label": "Product", "dataField": "productName", "dataType": "string", "format": null }];

Get the fields property.

 const querybuilder = document.querySelector('smart-query-builder');

 let fields = querybuilder.fields;

fieldsMode"dynamic" | "static"

Controls whether users are allowed to create and add new fields by typing directly into the field (property) input box, enabling dynamic extension of available fields beyond the predefined options.

Allowed Values

"dynamic" - Allows to dynamically add new fields by typing inside the field input that is located inside a condition.
"static" - Fields are only added statically via the fields property.

Default value

"dynamic"

Example

Set the fieldsMode property.

 <smart-query-builder fields-mode='static'></smart-query-builder>

Set the fieldsMode property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.fieldsMode = 'dynamic';

Get the fieldsMode property.

 const querybuilder = document.querySelector('smart-query-builder');

 let fieldsMode = querybuilder.fieldsMode;

formatStringDatestring

Specifies or retrieves the format string used by the editor for fields of type 'date'. This determines how date values are displayed and parsed within the editor. Adjusting this string allows customization of the date format according to localization or application requirements.

Default value

"dd-MMM-yy"

Example

Set the formatStringDate property.

 <smart-query-builder format-string-date='dddd-MMMM-yyyy'></smart-query-builder>

Set the formatStringDate property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.formatStringDate = 'M/d/yyyy';

Get the formatStringDate property.

 const querybuilder = document.querySelector('smart-query-builder');

 let formatStringDate = querybuilder.formatStringDate;

formatStringDateTimestring

Gets or sets the format string used by the editor for fields of type 'dateTime'. This format string determines how date and time values are displayed and parsed within the editor.

Default value

"dd-MMM-yy HH:mm:ss"

Example

Set the formatStringDateTime property.

 <smart-query-builder format-string-date-time='h:mm:ss tt'></smart-query-builder>

Set the formatStringDateTime property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.formatStringDateTime = 'yyyy-MM-dd hh:mm:ss';

Get the formatStringDateTime property.

 const querybuilder = document.querySelector('smart-query-builder');

 let formatStringDateTime = querybuilder.formatStringDateTime;

getDynamicFieldfunction | null

A callback function that is invoked whenever a new field is dynamically added. This function allows you to configure or modify the settings of the newly added field before it is rendered. This callback is only applicable when fieldsMode is set to 'dynamic'.

Try a demo showcasing the getDynamicField property.

Example

Set the getDynamicField property.

 <smart-query-builder get-dynamic-field='getDynamicFieldFunction'></smart-query-builder>

Set the getDynamicField property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.getDynamicField = function (field) { return { dataField: field.toLowerCase(), dataType: 'number', filterOperations: ['<', '>'] }; };

Get the getDynamicField property.

 const querybuilder = document.querySelector('smart-query-builder');

 let getDynamicField = querybuilder.getDynamicField;

iconsany

Specifies the CSS classes assigned to each built-in operation, which determine the corresponding icons displayed for those operations. The icon styles are defined in the smart-query-builder stylesheet. This property takes effect only when showIcons is set to true, enabling visual representation of operations with their respective icons.

Default value

{ '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'isblank', 'isnotblank': 'isnotblank' }

Example

Set the icons property.

 <smart-query-builder icons='{ "=": "equals", "<>": "notequals", ">": "greaterthan", ">=": "greaterthanorequal", "<": "lessthan", "<=": "lessthanorequal", "startswith": "startswith", "endswith": "endswith", "contains": "contains", "notcontains": "notcontains", "isblank": "blank", "isnotblank": "notblank" }'></smart-query-builder>

Set the icons property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.icons = { '=': 'equals', '<>': 'notequals', '>': 'greaterthan', '>=': 'greaterthanorequal', '<': 'lessthan', '<=': 'lessthanorequal', 'startswith': 'startswith', 'endswith': 'endswith', 'contains': 'contains', 'notcontains': 'notcontains', 'isblank': 'blank', 'isnotblank': 'notblank' };

Get the icons property.

 const querybuilder = document.querySelector('smart-query-builder');

 let icons = querybuilder.icons;

unlockKeystring

Provides methods to set or retrieve the 'unlockKey', a unique key required to unlock access to the product. Use this property to assign an unlock key for product activation or to obtain the currently assigned unlock key.

Default value

Example

Set the unlockKey property.

 <smart-query-builder unlock-key=''></smart-query-builder>

Set the unlockKey property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.unlockKey = '1111-2222-3333-4444-5555';

Get the unlockKey property.

 const querybuilder = document.querySelector('smart-query-builder');

 let unlockKey = querybuilder.unlockKey;

localestring

Specifies or retrieves the current language code (e.g., "en", "fr", "es"). This property determines which set of messages from the messages object will be used for display or processing. Setting this property updates the active language, while getting it returns the currently selected language.

Default value

"en"

Example

Set the locale property.

 <smart-query-builder locale='de'></smart-query-builder>

Set the locale property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.locale = 'fr';

Get the locale property.

 const querybuilder = document.querySelector('smart-query-builder');

 let locale = querybuilder.locale;

localizeFormatFunctionfunction | null

A callback function that allows you to define or modify the formatting of messages generated by the Localization Module before they are returned. Use this to customize message structure, apply additional processing, or support advanced localization needs.

Example

Set the localizeFormatFunction property.

 <smart-query-builder localize-format-function='function(defaultMessage, message, messageArguments){return '...'}'></smart-query-builder>

Set the localizeFormatFunction property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.localizeFormatFunction = function(defaultMessage, message, messageArguments){return '...'};

Get the localizeFormatFunction property.

 const querybuilder = document.querySelector('smart-query-builder');

 let localizeFormatFunction = querybuilder.localizeFormatFunction;

messagesobject

Specifies the names of the fields to be included in the filtered element, allowing you to control which data properties are retained or displayed after filtering.

Default value

"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

"add": "Add",

"addCondition": "Add Condition",

"addGroup": "Add Group",

"and": "And",

"notand": "Not And",

"or": "Or",

"notor": "Not Or",

"=": "Equals",

"<>": "Does not equal",

">": "Greater than",

">=": "Greater than or equal to",

"<": "Less than",

"<=": "Less than or equal to",

"startswith": "Starts with",

"endswith": "Ends with",

"contains": "Contains",

"notcontains": "Does not contain",

"isblank": "Is blank",

"isnotblank": "Is not blank",

"wrongParentGroupIndex": "{{elementType}}: Wrong parent group index in '{{method}}' method.",

"missingFields": "{{elementType}}: Fields are required for proper condition's adding. Set \"fields\" source and then conditions will be added as expected.",

"wrongElementNode": "{{elementType}}: Incorect node / node Id in '{{method}}' method.",

"invalidDataStructure": "{{elementType}}: Used invalid data structure in updateCondition/updateGroup method.",

"dateTabLabel": "DATE",

"timeTabLabel": "TIME",

"queryLabel": "Query"

}

Example

Set the messages property.

 <smart-query-builder messages='{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","add":"Hinzufügen", "addCondition":"Bedingung hinzufugen","addGroup":"Gruppe hinzufugen","and":"Und","notand":"Nicht und","or":"Oder","notor":"Nicht oder","=":"Gleich","<>":"Ist nicht gleich",">":"Greusser als",">=":"Greusser als oder gleich wie","<":"Weniger als","<=":"Weniger als oder gleich","startswith":"Beginnt mit","endswith":"Endet mit","contains":"Enthalt","notcontains":"Beinhaltet nicht","isblank":"Ist leer","isnotblank":"Ist nicht leer","wrongParentGroupIndex":"{{elementType}}: Falscher ubergeordneter Gruppenindex in der Methode '{{method}}'.","missingFields":"{{elementType}}: Felder sind fur das Hinzufugen der richtigen Bedingung erforderlich. Legen Sie die Quelle fur \"Felder\" fest, und die Bedingungen werden wie erwartet hinzugefugt.","wrongElementNode":"{{elementType}}: Falsche Knoten- / Knoten-ID in der Methode '{{method}}'.","invalidDataStructure":"{{elementType}}: In der Methode updateCondition / updateGroup wurde eine ungultige Datenstruktur verwendet.", "dateTabLabel":"DATUM", "timeTabLabel":"ZEIT", "queryLabel":"Abfrage"}}'></smart-query-builder>

Set the messages property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","add":"Add","addCondition":"Add Condition","addGroup":"Add Group","and":"And","notand":"Not And","or":"Or","notor":"Not Or","=":"Equals","<>":"Does not equal",">":"Greater than",">=":"Greater than or equal to","<":"Less than","<=":"Less than or equal to","startswith":"Starts with","endswith":"Ends with","contains":"Contains","notcontains":"Does not contain","isblank":"Is blank","isnotblank":"Is not blank","wrongParentGroupIndex":"{{elementType}}: Wrong parent group index in '{{method}}' method.","missingFields":"{{elementType}}: Fields are required for proper condition's adding. Set \"fields\" source and then conditions will be added as expected.","wrongElementNode":"{{elementType}}: Incorect node / node Id in '{{method}}' method.","invalidDataStructure":"{{elementType}}: Used invalid data structure in updateCondition/updateGroup method.", "dateTabLabel":"DATE", "timeTabLabel":"TIME", "queryLabel":"Query"}};

Get the messages property.

 const querybuilder = document.querySelector('smart-query-builder');

 let messages = querybuilder.messages;

operatorPlaceholderstring

Specifies the placeholder text that appears within the operator selection box when no operator has been chosen for the condition. This text guides users by indicating that they need to select an operator.

Default value

"Operator"

Example

Set the operatorPlaceholder property.

 <smart-query-builder operator-placeholder='Operator not set'></smart-query-builder>

Set the operatorPlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.operatorPlaceholder = 'Choose operator...';

Get the operatorPlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let operatorPlaceholder = querybuilder.operatorPlaceholder;

propertyPlaceholderstring

Specifies the placeholder text displayed within the condition's property field when no field is currently selected by the user. This text provides guidance or prompts users to select a field.

Default value

"Property"

Example

Set the propertyPlaceholder property.

 <smart-query-builder property-placeholder='Property not set'></smart-query-builder>

Set the propertyPlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.propertyPlaceholder = 'Choose property...';

Get the propertyPlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let propertyPlaceholder = querybuilder.propertyPlaceholder;

rightToLeftboolean

Configures or retrieves the value that determines whether the element’s alignment supports right-to-left (RTL) text direction, which is typically used for languages such as Arabic or Hebrew. This property controls whether the element’s layout and text flow are adjusted to accommodate RTL locales.

Default value

false

Try a demo showcasing the rightToLeft property.

Example

Set the rightToLeft property.

 <smart-query-builder right-to-left></smart-query-builder>

Set the rightToLeft property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.rightToLeft = false;

Get the rightToLeft property.

 const querybuilder = document.querySelector('smart-query-builder');

 let rightToLeft = querybuilder.rightToLeft;

showIconsboolean

Controls the visibility of operator icons within the operator selection dropdown menu. When enabled, icons representing each operator are displayed alongside their names in the dropdown list; when disabled, only the operator names are shown without icons.

Default value

false

Try a demo showcasing the showIcons property.

Example

Set the showIcons property.

 <smart-query-builder show-icons></smart-query-builder>

Set the showIcons property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.showIcons = false;

Get the showIcons property.

 const querybuilder = document.querySelector('smart-query-builder');

 let showIcons = querybuilder.showIcons;

showFieldNameArrowboolean

Controls the visibility of the dropdown icon associated with the operator field in the conditions section. When enabled, the dropdown icon appears next to the operator field name, allowing users to select an operator from the available options. When disabled, the dropdown icon is hidden, preventing users from opening the operator selection menu.

Default value

false

Example

Set the showFieldNameArrow property.

 <smart-query-builder show-field-name-arrow></smart-query-builder>

Set the showFieldNameArrow property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.showFieldNameArrow = false;

Get the showFieldNameArrow property.

 const querybuilder = document.querySelector('smart-query-builder');

 let showFieldNameArrow = querybuilder.showFieldNameArrow;

themestring

Specifies the theme to be applied to the element. The theme controls the overall appearance, including colors, fonts, and styling, to ensure a consistent visual presentation throughout the interface.

Default value

Example

Set the theme property.

 <smart-query-builder theme='blue'></smart-query-builder>

Set the theme property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.theme = 'red';

Get the theme property.

 const querybuilder = document.querySelector('smart-query-builder');

 let theme = querybuilder.theme;

unfocusableboolean

If set to true, this property prevents the element from receiving keyboard or programmatic focus, making it unable to become the active element within the user interface.

Default value

false

Example

Set the unfocusable property.

 <smart-query-builder unfocusable></smart-query-builder>

Set the unfocusable property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.unfocusable = false;

Get the unfocusable property.

 const querybuilder = document.querySelector('smart-query-builder');

 let unfocusable = querybuilder.unfocusable;

validateOnInputboolean

Specifies whether the condition's value should be validated in real-time as the user types (on every key up event) or only when the input field loses focus (on blur), which is the default behavior. If enabled, value validation occurs after the user stops typing, following a delay defined by the validationTimeout property, which sets the time interval (in milliseconds) before triggering validation after typing ceases.

Default value

false

Example

Set the validateOnInput property.

 <smart-query-builder validate-on-input></smart-query-builder>

Set the validateOnInput property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.validateOnInput = false;

Get the validateOnInput property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validateOnInput = querybuilder.validateOnInput;

validationTimeoutnumber

Specifies the delay (in milliseconds) that begins once the user has stopped typing in the value field, after which the condition value is validated. This property works in conjunction with validationOnInput, controlling how soon validation is triggered after user input is complete.

Default value

100

Example

Set the validationTimeout property.

 <smart-query-builder validation-timeout='500'></smart-query-builder>

Set the validationTimeout property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.validationTimeout = 200;

Get the validationTimeout property.

 const querybuilder = document.querySelector('smart-query-builder');

 let validationTimeout = querybuilder.validationTimeout;

valueany

The value is structured as a multidimensional array, where each top-level element represents a group operator (such as AND or OR) that organizes multiple conditions. Within each group, an array of condition objects specifies the individual filtering criteria. This structure allows for the representation of complex, nested logical expressions by combining multiple groups and conditions.

Try a demo showcasing the value property.

Example

Set the value property.

 <smart-query-builder value='[[["productCode", "/^\d{7}$/g"], "or", ["id", "isvalid", true]]]'></smart-query-builder>

Set the value property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.value = [[['available', '=', true], 'and', ['price', '<', 1300],], 'or', [['produced', '>', new Date(2015, 3, 4)], 'and', ['purchased', '>=', new Date(2020, 4, 23, 15, 33)]]];

Get the value property.

 const querybuilder = document.querySelector('smart-query-builder');

 let value = querybuilder.value;

valueFormatFunctionfunction | null

A callback function that formats the display or value of the condition input fields before they are rendered or processed. Use this to customize how condition values appear to users or are handled within the application.

Example

Set the valueFormatFunction property.

 <smart-query-builder value-format-function='function (details) { return details.label + '%'; }'></smart-query-builder>

Set the valueFormatFunction property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.valueFormatFunction = function (details) { return details.label + '$'; };

Get the valueFormatFunction property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valueFormatFunction = querybuilder.valueFormatFunction;

valuePlaceholderstring

Specifies the placeholder text displayed within the condition's value input field when no value has been entered. This text provides guidance or hints to the user about the expected input.

Default value

"Value"

Example

Set the valuePlaceholder property.

 <smart-query-builder value-placeholder='Value not set'></smart-query-builder>

Set the valuePlaceholder property by using the HTML Element's instance.

 const querybuilder = document.querySelector('smart-query-builder');

 querybuilder.valuePlaceholder = 'Choose value...';

Get the valuePlaceholder property.

 const querybuilder = document.querySelector('smart-query-builder');

 let valuePlaceholder = querybuilder.valuePlaceholder;

Events

changeCustomEvent

This event is triggered whenever the value within the query builder is modified by the user, such as adding, editing, or removing rules or conditions. It provides an opportunity to respond to changes in the query configuration, such as validating input, updating results, or synchronizing state with other components.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onChange

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Try a demo showcasing the change event.

Example

Set up the event handler of change event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('change', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

dragEndCustomEvent

This event is triggered when a condition that is being dragged is dropped onto a valid target area within the interface. You can prevent the drop action from completing by calling event.preventDefault() within the event handler function. This allows you to implement custom validation or restrict drops based on specific criteria before the condition is accepted.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragEnd

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.target - The target item.

ev.detail.targetData - the data of the target item.

ev.detail.targetSide - The side of the target item where the dragged item will be dropped.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragEnd event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragEnd', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        target = detail.target,
        targetData = detail.targetData,
        targetSide = detail.targetSide;

	// event handling code goes here.
})

draggingCustomEvent

This event is triggered whenever a condition element is actively being dragged within the user interface. It fires continuously throughout the dragging process, allowing developers to track the position and state of the condition as it moves, and to implement custom behaviors—such as visual feedback or dynamic updates—while the drag action is in progress.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragging

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item that is being dragged.

ev.detail.data - The data of the item that is being dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragging event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragging', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

dragStartCustomEvent

This event fires when a drag operation begins within the smart-query-builder component. You can intercept and prevent the drag action from proceeding by calling event.preventDefault() within your event handler. This allows you to implement custom logic or restrictions before the drag operation officially starts.

Bubbles Yes
Cancelable Yes
Interface CustomEvent
Event handler property onDragStart

Arguments

evCustomEvent

ev.detailObject

ev.detail.item - The item is going to be dragged.

ev.detail.data - The data of the item that is going to be dragged.

ev.detail.originalEvent - The original event.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of dragStart event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('dragStart', function (event) {
    const detail = event.detail,
        item = detail.item,
        data = detail.data,
        originalEvent = detail.originalEvent;

	// event handling code goes here.
})

itemClickCustomEvent

This event is triggered whenever a user interacts with any component of the query builder—such as selecting an operator, clicking on a field name, entering a value, or pressing the close button. It allows you to respond to user actions on any of the query builder’s building blocks.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onItemClick

Arguments

evCustomEvent

ev.detailObject

ev.detail.id - The internal id of the clicked item, e.g. '0.1', '1.1', etc.

ev.detail.type - The type of the clicked item ( condition or a group ).

ev.detail.data - The data of the item.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of itemClick event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('itemClick', function (event) {
    const detail = event.detail,
        id = detail.id,
        type = detail.type,
        data = detail.data;

	// event handling code goes here.
})

propertySelectedCustomEvent

This event is triggered when a user selects a specific field, indicating that the field has become active or has received focus. It can be used to initiate actions such as loading related data, displaying contextual hints, or tracking user interactions with the form element.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onPropertySelected

Arguments

evCustomEvent

ev.detailObject

ev.detail.label - The label of the selected property.

ev.detail.value - The value of the selected property.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of propertySelected event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('propertySelected', function (event) {
    const detail = event.detail,
        label = detail.label,
        value = detail.value;

	// event handling code goes here.
})

validationChangeCustomEvent

This event is triggered whenever the component performs input validation. Validation occurs each time a user enters a new value and then shifts focus away from the component (for example, by clicking or tabbing to another UI element). The event provides an opportunity to respond to changes in the input’s validity, such as displaying error messages or updating related state.

Bubbles Yes
Cancelable No
Interface CustomEvent
Event handler property onValidationChange

Arguments

evCustomEvent

ev.detailObject

ev.detail.oldValue - Old validation status.

ev.detail.newValue - New validation status.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of validationChange event.

const querybuilder = document.querySelector('smart-query-builder');
querybuilder.addEventListener('validationChange', function (event) {
    const detail = event.detail,
        oldValue = detail.oldValue,
        newValue = detail.newValue;

	// event handling code goes here.
})

Methods

getLinq(): string

Transforms the element's current value into a valid Dynamic LINQ expression, enabling advanced querying and runtime evaluation based on the element's data.

Returnsstring

Invoke the getLinq method.

const querybuilder = document.querySelector('smart-query-builder');
const result = querybuilder.getLinq();

Try a demo showcasing the getLinq method.

CSS Variables

--smart-query-builder-default-widthvar()

Default value

"auto"

Default width of QueryBuilder.

--smart-query-builder-default-heightvar()

Default value

"auto"

Default height of QueryBuilder.

--smart-query-builder-min-widthvar()

Default value

"100px"

Minimum width of QueryBuilder.

--smart-query-builder-content-paddingvar()

Default value

"5px"

Padding of QueryBuilder.

--smart-query-builder-editor-widthvar()

Default value

"125px"

Width of editors in QueryBuilder.

QueryBuilder Javascript API

allowDragboolean

Default value

Example

animation"none" | "simple" | "advanced"

Default value

Example

applyMode"change" | "immediately"

Default value

Example

autoApplyValueboolean

Default value

Example

autoPromptboolean

Default value

Example

customOperations{label: string, name: string, editorTemplate: function, valueTemplate: function, handleValue: function, hideValue: boolean, expressionTemplate: string, expressionReaderCallback: function, expressionBuilderCallback: function}[]

Properties

labelstring

Default value

namestring

Default value

editorTemplatefunction

valueTemplatefunction

handleValuefunction

hideValueboolean

Default value

validateValuefunction

onEditorOpenfunction

expressionTemplatestring

Default value

expressionReaderCallbackfunction

expressionBuilderCallbackfunction

Example

disabledboolean

Default value

Example

dropDownWidthstring

Default value

Example

fields{label: string, dataField: string, dataType: string, dataType: string, format: any, filterOperations: string[]}[]

Properties

labelstring

Default value

dataFieldstring

Default value

dataTypestring

Default value

formatstring

Default value

filterOperationsstring[]

Default value

Example

fieldsMode"dynamic" | "static"

Default value

Example

formatStringDatestring

Default value

Example

formatStringDateTimestring

Default value

Example

getDynamicFieldfunction | null

Example

iconsany

Default value

Example

unlockKeystring

Default value