igx-query-builder

November 19, 2025 ยท View on GitHub

The IgxQueryBuilder component provides a way to build complex queries through the UI. By specifying AND/OR operators, conditions and values the user creates an expression tree which describes the query. A walkthrough of how to get started can be found here

Usage

<igx-query-builder
    [entities]="entities"
    [expressionTree]="customExpressionTree">

    <!-- Custom header -->
    <igx-query-builder-header [title]="'Custom title for Query Builder'">
    </igx-query-builder-header>

</igx-query-builder>

API

igx-query-builder

Properties

NameTypeDescription
entitiesEntityType[]An array of entities. Contains information about name and fields.
expressionTreeIExpressionTreeGets/Sets the displayed expressions tree.
localestringLocale settings for the component. If this locale is not set, its value to be determined based on the global Angular application LOCALE_ID.
resourceStringsIQueryBuilderResourceStringsGets/sets the resource strings.
showEntityChangeDialogbooleanGets/sets whether the confirmation dialog should be shown when changing entity.
disableEntityChangebooleanGets/sets whether the entity select on root level should be disabled after the initial selection.
disableReturnFieldsChangebooleanGets/sets whether the return fields combo on root level should be disabled.

Events

NameDescription
expressionTreeChangeEmitted when entity, return fields, condition, field, operand, value is changed.

igx-query-builder-header

Properties

NameTypeDescription
titlestringSets the title displayed in the header.