Skip to content

Commit c53a1dc

Browse files
committed
feat(query-builder): update readme, add back showLegend with deprecation comment
1 parent 2ffe85a commit c53a1dc

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

projects/igniteui-angular/src/lib/query-builder/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A walkthrough of how to get started can be found [here](https://www.infragistics
55
## Usage
66
```html
77
<igx-query-builder
8-
[fields]="fields"
8+
[entities]="entities"
99
[expressionTree]="customExpressionTree">
1010

1111
<!-- Custom header -->
@@ -23,17 +23,18 @@ A walkthrough of how to get started can be found [here](https://www.infragistics
2323

2424
| Name | Type | Description |
2525
| :--- | :--- | :--- |
26-
| `fields` | FieldType[] | An array of fields to be filtered. Contains information about label, field, type, operands. |
26+
| `entities` | EntityType[] | An array of entities. Contains information about name and fields. |
2727
| `expressionTree` | IExpressionTree | Gets/Sets the displayed expressions tree. |
2828
| `locale` | string | Locale settings for the component. If this locale is not set, its value to be determined based on the global Angular application LOCALE_ID. |
2929
| Content Cell | Content Cell | Content Cell |
3030
| `resourceStrings` | IQueryBuilderResourceStrings | Gets/sets the resource strings. |
31+
| `showEntityChangeDialog` | boolean | Gets/sets whether the confirmation dialog should be shown when changing entity. |
3132

3233
#### Events
3334

3435
| Name | Description |
3536
| :--- | :--- |
36-
| `expressionTreeChange` | Emitted when condition, field, operand, value is changed. | no | - |
37+
| `expressionTreeChange` | Emitted when entity, return fields, condition, field, operand, value is changed. | no | - |
3738

3839
### igx-query-builder-header
3940

projects/igniteui-angular/src/lib/query-builder/query-builder-header.component.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,18 @@ export class IgxQueryBuilderHeaderComponent {
2121
@Input()
2222
public title: string;
2323

24+
/**
25+
* Show/hide the legend.
26+
*
27+
* @example
28+
* ```html
29+
* <igx-query-builder-header [showLegend]="false"></igx-query-builder-header>
30+
* ```
31+
* @deprecated in version 19.1.0.
32+
*/
33+
@Input()
34+
public showLegend = true;
35+
2436
/**
2537
* Sets the resource strings.
2638
* By default it uses EN resources.

0 commit comments

Comments
 (0)