igniteui-angular 22.0.0-rc.1 → 22.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/igniteui-angular-accordion.mjs +1 -1
- package/fesm2022/igniteui-angular-accordion.mjs.map +1 -1
- package/fesm2022/igniteui-angular-action-strip.mjs +1 -1
- package/fesm2022/igniteui-angular-action-strip.mjs.map +1 -1
- package/fesm2022/igniteui-angular-button-group.mjs +1 -1
- package/fesm2022/igniteui-angular-button-group.mjs.map +1 -1
- package/fesm2022/igniteui-angular-calendar.mjs +1 -1
- package/fesm2022/igniteui-angular-calendar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-card.mjs +6 -6
- package/fesm2022/igniteui-angular-card.mjs.map +1 -1
- package/fesm2022/igniteui-angular-carousel.mjs +6 -6
- package/fesm2022/igniteui-angular-carousel.mjs.map +1 -1
- package/fesm2022/igniteui-angular-chips.mjs +34 -34
- package/fesm2022/igniteui-angular-chips.mjs.map +1 -1
- package/fesm2022/igniteui-angular-core.mjs +6 -6
- package/fesm2022/igniteui-angular-core.mjs.map +1 -1
- package/fesm2022/igniteui-angular-date-picker.mjs +2 -2
- package/fesm2022/igniteui-angular-date-picker.mjs.map +1 -1
- package/fesm2022/igniteui-angular-directives.mjs +12 -12
- package/fesm2022/igniteui-angular-directives.mjs.map +1 -1
- package/fesm2022/igniteui-angular-drop-down.mjs +5 -5
- package/fesm2022/igniteui-angular-drop-down.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-core.mjs +35 -23
- package/fesm2022/igniteui-angular-grids-core.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-grid.mjs +51 -51
- package/fesm2022/igniteui-angular-grids-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-hierarchical-grid.mjs +7 -7
- package/fesm2022/igniteui-angular-grids-hierarchical-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-grids-tree-grid.mjs +5 -5
- package/fesm2022/igniteui-angular-grids-tree-grid.mjs.map +1 -1
- package/fesm2022/igniteui-angular-icon.mjs +4 -4
- package/fesm2022/igniteui-angular-icon.mjs.map +1 -1
- package/fesm2022/igniteui-angular-input-group.mjs +18 -18
- package/fesm2022/igniteui-angular-input-group.mjs.map +1 -1
- package/fesm2022/igniteui-angular-list.mjs +5 -5
- package/fesm2022/igniteui-angular-list.mjs.map +1 -1
- package/fesm2022/igniteui-angular-navbar.mjs +5 -5
- package/fesm2022/igniteui-angular-navbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-paginator.mjs +2 -2
- package/fesm2022/igniteui-angular-paginator.mjs.map +1 -1
- package/fesm2022/igniteui-angular-progressbar.mjs +7 -7
- package/fesm2022/igniteui-angular-progressbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-query-builder.mjs +2 -2
- package/fesm2022/igniteui-angular-query-builder.mjs.map +1 -1
- package/fesm2022/igniteui-angular-radio.mjs +5 -5
- package/fesm2022/igniteui-angular-radio.mjs.map +1 -1
- package/fesm2022/igniteui-angular-select.mjs +217 -209
- package/fesm2022/igniteui-angular-select.mjs.map +1 -1
- package/fesm2022/igniteui-angular-slider.mjs +17 -17
- package/fesm2022/igniteui-angular-slider.mjs.map +1 -1
- package/fesm2022/igniteui-angular-snackbar.mjs +1 -1
- package/fesm2022/igniteui-angular-snackbar.mjs.map +1 -1
- package/fesm2022/igniteui-angular-splitter.mjs +2 -2
- package/fesm2022/igniteui-angular-splitter.mjs.map +1 -1
- package/fesm2022/igniteui-angular-stepper.mjs +2 -2
- package/fesm2022/igniteui-angular-stepper.mjs.map +1 -1
- package/fesm2022/igniteui-angular-time-picker.mjs +1 -1
- package/fesm2022/igniteui-angular-time-picker.mjs.map +1 -1
- package/fesm2022/igniteui-angular-tree.mjs +1 -1
- package/fesm2022/igniteui-angular-tree.mjs.map +1 -1
- package/input-group/README.md +1 -1
- package/migrations/migration-collection.json +5 -0
- package/migrations/update-22_0_0/index.d.ts +3 -0
- package/migrations/update-22_0_0/index.js +86 -0
- package/migrations/update-22_0_0/index.spec.d.ts +1 -0
- package/migrations/update-22_0_0/index.spec.js +116 -0
- package/package.json +2 -2
- package/skills/igniteui-angular-grids/references/sizing.md +1 -0
- package/skills/igniteui-angular-grids/references/structure.md +1 -0
- package/skills/igniteui-angular-grids/references/types.md +2 -1
- package/types/igniteui-angular-accordion.d.ts +3 -3
- package/types/igniteui-angular-action-strip.d.ts +1 -1
- package/types/igniteui-angular-button-group.d.ts +1 -1
- package/types/igniteui-angular-calendar.d.ts +1 -1
- package/types/igniteui-angular-card.d.ts +6 -6
- package/types/igniteui-angular-carousel.d.ts +6 -6
- package/types/igniteui-angular-chips.d.ts +38 -38
- package/types/igniteui-angular-core.d.ts +9 -9
- package/types/igniteui-angular-date-picker.d.ts +4 -4
- package/types/igniteui-angular-directives.d.ts +15 -15
- package/types/igniteui-angular-drop-down.d.ts +6 -6
- package/types/igniteui-angular-grids-core.d.ts +31 -29
- package/types/igniteui-angular-grids-grid.d.ts +51 -51
- package/types/igniteui-angular-grids-hierarchical-grid.d.ts +7 -7
- package/types/igniteui-angular-grids-tree-grid.d.ts +7 -7
- package/types/igniteui-angular-icon.d.ts +4 -4
- package/types/igniteui-angular-input-group.d.ts +17 -17
- package/types/igniteui-angular-list.d.ts +7 -7
- package/types/igniteui-angular-navbar.d.ts +7 -7
- package/types/igniteui-angular-paginator.d.ts +2 -2
- package/types/igniteui-angular-progressbar.d.ts +7 -7
- package/types/igniteui-angular-query-builder.d.ts +3 -3
- package/types/igniteui-angular-radio.d.ts +5 -5
- package/types/igniteui-angular-select.d.ts +91 -7
- package/types/igniteui-angular-slider.d.ts +17 -17
- package/types/igniteui-angular-snackbar.d.ts +1 -1
- package/types/igniteui-angular-splitter.d.ts +3 -3
- package/types/igniteui-angular-stepper.d.ts +2 -2
- package/types/igniteui-angular-time-picker.d.ts +1 -1
- package/types/igniteui-angular-tree.d.ts +2 -2
|
@@ -338,7 +338,7 @@ declare class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective imp
|
|
|
338
338
|
private _toolbarTemplate;
|
|
339
339
|
private _paginatorTemplate;
|
|
340
340
|
/**
|
|
341
|
-
* Sets if all immediate children of the grids for this
|
|
341
|
+
* Sets if all immediate children of the grids for this row island should be expanded/collapsed.
|
|
342
342
|
* ```html
|
|
343
343
|
* <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
|
|
344
344
|
* <igx-row-island [key]="'childData'" [expandChildren]="true" #rowIsland>
|
|
@@ -351,7 +351,7 @@ declare class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective imp
|
|
|
351
351
|
*/
|
|
352
352
|
set expandChildren(value: boolean);
|
|
353
353
|
/**
|
|
354
|
-
* Gets if all immediate children of the grids for this
|
|
354
|
+
* Gets if all immediate children of the grids for this row island have been set to be expanded/collapsed.
|
|
355
355
|
* ```typescript
|
|
356
356
|
* const expanded = this.rowIsland.expandChildren;
|
|
357
357
|
* ```
|
|
@@ -610,7 +610,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
610
610
|
*/
|
|
611
611
|
set data(value: any[] | null);
|
|
612
612
|
/**
|
|
613
|
-
* Returns an array of data set to the
|
|
613
|
+
* Returns an array of data set to the hierarchical grid.
|
|
614
614
|
* ```typescript
|
|
615
615
|
* let filteredData = this.grid.filteredData;
|
|
616
616
|
* ```
|
|
@@ -636,7 +636,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
636
636
|
set totalItemCount(count: number);
|
|
637
637
|
get totalItemCount(): number;
|
|
638
638
|
/**
|
|
639
|
-
* Sets if all immediate children of the
|
|
639
|
+
* Sets if all immediate children of the hierarchical grid should be expanded/collapsed.
|
|
640
640
|
* Default value is false.
|
|
641
641
|
* ```html
|
|
642
642
|
* <igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" [expandChildren]="true"></igx-hierarchical-grid>
|
|
@@ -646,7 +646,7 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
646
646
|
*/
|
|
647
647
|
set expandChildren(value: boolean);
|
|
648
648
|
/**
|
|
649
|
-
* Gets if all immediate children of the
|
|
649
|
+
* Gets if all immediate children of the hierarchical grid previously have been set to be expanded/collapsed.
|
|
650
650
|
* If previously set and some rows have been manually expanded/collapsed it will still return the last set value.
|
|
651
651
|
* ```typescript
|
|
652
652
|
* const expanded = this.grid.expandChildren;
|
|
@@ -743,13 +743,13 @@ declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirect
|
|
|
743
743
|
*/
|
|
744
744
|
allRows(): RowType[];
|
|
745
745
|
/**
|
|
746
|
-
* Returns the collection of
|
|
746
|
+
* Returns the collection of hierarchical grid rows for current page.
|
|
747
747
|
*
|
|
748
748
|
* @hidden @internal
|
|
749
749
|
*/
|
|
750
750
|
dataRows(): RowType[];
|
|
751
751
|
/**
|
|
752
|
-
* Returns an array of the selected
|
|
752
|
+
* Returns an array of the selected grid cells.
|
|
753
753
|
*
|
|
754
754
|
* @example
|
|
755
755
|
* ```typescript
|
|
@@ -63,7 +63,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
63
63
|
protected _diTransactions: HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
|
|
64
64
|
protected transactionFactory: IgxHierarchicalTransactionFactory;
|
|
65
65
|
/**
|
|
66
|
-
* Sets the child data key of the
|
|
66
|
+
* Sets the child data key of the tree grid.
|
|
67
67
|
* ```html
|
|
68
68
|
* <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" [autoGenerate]="true"></igx-tree-grid>
|
|
69
69
|
* ```
|
|
@@ -72,7 +72,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
72
72
|
*/
|
|
73
73
|
childDataKey: string;
|
|
74
74
|
/**
|
|
75
|
-
* Sets the foreign key of the
|
|
75
|
+
* Sets the foreign key of the tree grid.
|
|
76
76
|
* ```html
|
|
77
77
|
* <igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [autoGenerate]="true">
|
|
78
78
|
* </igx-tree-grid>
|
|
@@ -227,7 +227,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
227
227
|
*/
|
|
228
228
|
get transactions(): HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
|
|
229
229
|
/**
|
|
230
|
-
* Sets the count of levels to be expanded in the
|
|
230
|
+
* Sets the count of levels to be expanded in the tree grid. By default it is
|
|
231
231
|
* set to `Infinity` which means all levels would be expanded.
|
|
232
232
|
* ```html
|
|
233
233
|
* <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" expansionDepth="1" [autoGenerate]="true"></igx-tree-grid>
|
|
@@ -291,7 +291,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
291
291
|
*/
|
|
292
292
|
refreshGridState(args?: IRowDataEventArgs): void;
|
|
293
293
|
/**
|
|
294
|
-
* Creates a new
|
|
294
|
+
* Creates a new tree grid row with the given data. If a parentRowID is not specified, the newly created
|
|
295
295
|
* row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches
|
|
296
296
|
* the specified parentRowID. If the parentRowID does not exist, an error would be thrown.
|
|
297
297
|
* ```typescript
|
|
@@ -369,7 +369,7 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
369
369
|
/** @hidden */
|
|
370
370
|
deleteRowById(rowId: any): any;
|
|
371
371
|
/**
|
|
372
|
-
* Returns the
|
|
372
|
+
* Returns the tree grid row by index.
|
|
373
373
|
*
|
|
374
374
|
* @example
|
|
375
375
|
* ```typescript
|
|
@@ -395,13 +395,13 @@ declare class IgxTreeGridComponent extends IgxGridBaseDirective implements GridT
|
|
|
395
395
|
*/
|
|
396
396
|
allRows(): RowType[];
|
|
397
397
|
/**
|
|
398
|
-
* Returns the collection of
|
|
398
|
+
* Returns the collection of tree grid rows for current page.
|
|
399
399
|
*
|
|
400
400
|
* @hidden @internal
|
|
401
401
|
*/
|
|
402
402
|
dataRows(): RowType[];
|
|
403
403
|
/**
|
|
404
|
-
* Returns an array of the selected
|
|
404
|
+
* Returns an array of the selected grid cells.
|
|
405
405
|
*
|
|
406
406
|
* @example
|
|
407
407
|
* ```typescript
|
|
@@ -197,8 +197,8 @@ interface IgxIconLoadedEvent {
|
|
|
197
197
|
/**
|
|
198
198
|
* **Ignite UI for Angular Icon Service** -
|
|
199
199
|
*
|
|
200
|
-
* The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with
|
|
201
|
-
* In addition it could be used to associate a custom class to be applied on
|
|
200
|
+
* The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with icon.
|
|
201
|
+
* In addition it could be used to associate a custom class to be applied on icon according to given font-family.
|
|
202
202
|
*
|
|
203
203
|
* Example:
|
|
204
204
|
* ```typescript
|
|
@@ -245,7 +245,7 @@ declare class IgxIconService {
|
|
|
245
245
|
*/
|
|
246
246
|
set defaultFamily(family: IconFamily);
|
|
247
247
|
/**
|
|
248
|
-
* Registers a custom class to be applied to
|
|
248
|
+
* Registers a custom class to be applied to icon for a given font-family.
|
|
249
249
|
* ```typescript
|
|
250
250
|
* this.iconService.registerFamilyAlias('material', 'material-icons');
|
|
251
251
|
* ```
|
|
@@ -264,7 +264,7 @@ declare class IgxIconService {
|
|
|
264
264
|
/** @hidden @internal */
|
|
265
265
|
setRefsByTheme(theme: IgxTheme): void;
|
|
266
266
|
/**
|
|
267
|
-
* Creates a family to className relationship that is applied to the
|
|
267
|
+
* Creates a family to className relationship that is applied to the icon
|
|
268
268
|
* whenever that family name is used.
|
|
269
269
|
* ```typescript
|
|
270
270
|
* this.iconService.setFamily('material', { className: 'material-icons', type: 'liga' });
|
|
@@ -402,7 +402,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
402
402
|
*/
|
|
403
403
|
get resourceStrings(): IInputResourceStrings;
|
|
404
404
|
/**
|
|
405
|
-
* Property that enables/disables the auto-generated class of the
|
|
405
|
+
* Property that enables/disables the auto-generated class of the input group.
|
|
406
406
|
* By default applied the class is applied.
|
|
407
407
|
* ```typescript
|
|
408
408
|
* @ViewChild("MyInputGroup")
|
|
@@ -421,8 +421,8 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
421
421
|
isFocused: boolean;
|
|
422
422
|
/**
|
|
423
423
|
* @hidden @internal
|
|
424
|
-
* When truthy, disables the
|
|
425
|
-
* Controlled by the underlying
|
|
424
|
+
* When truthy, disables the input group.
|
|
425
|
+
* Controlled by the underlying input.
|
|
426
426
|
* ```html
|
|
427
427
|
* <igx-input-group [disabled]="true"></igx-input-group>
|
|
428
428
|
* ```
|
|
@@ -468,15 +468,15 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
468
468
|
get textAreaClass(): boolean;
|
|
469
469
|
/**
|
|
470
470
|
* Sets how the input will be styled.
|
|
471
|
-
* Allowed values of type
|
|
471
|
+
* Allowed values of type input group type.
|
|
472
472
|
* ```html
|
|
473
473
|
* <igx-input-group [type]="'search'">
|
|
474
474
|
* ```
|
|
475
475
|
*/
|
|
476
476
|
set type(value: IgxInputGroupType);
|
|
477
477
|
/**
|
|
478
|
-
* Returns the type of the
|
|
479
|
-
* The default is `
|
|
478
|
+
* Returns the type of the input group. How the input is styled.
|
|
479
|
+
* The default is `box`.
|
|
480
480
|
* ```typescript
|
|
481
481
|
* @ViewChild("MyInputGroup")
|
|
482
482
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -488,7 +488,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
488
488
|
get type(): IgxInputGroupType;
|
|
489
489
|
/**
|
|
490
490
|
* Sets the theme of the input.
|
|
491
|
-
* Allowed values of type
|
|
491
|
+
* Allowed values of type input group theme.
|
|
492
492
|
* ```typescript
|
|
493
493
|
* @ViewChild("MyInputGroup")
|
|
494
494
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -499,7 +499,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
499
499
|
set theme(value: IgxTheme);
|
|
500
500
|
/**
|
|
501
501
|
* Returns the theme of the input.
|
|
502
|
-
* The returned value is of type
|
|
502
|
+
* The returned value is of type input group type.
|
|
503
503
|
* ```typescript
|
|
504
504
|
* @ViewChild("MyInputGroup")
|
|
505
505
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -516,7 +516,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
516
516
|
/** @hidden @internal */
|
|
517
517
|
hintClickHandler(event: MouseEvent): void;
|
|
518
518
|
/**
|
|
519
|
-
* Returns whether the
|
|
519
|
+
* Returns whether the input group has hints.
|
|
520
520
|
* ```typescript
|
|
521
521
|
* @ViewChild("MyInputGroup")
|
|
522
522
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -535,7 +535,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
535
535
|
/** @hidden @internal */
|
|
536
536
|
set suffixes(items: QueryList<IgxSuffixDirective>);
|
|
537
537
|
/**
|
|
538
|
-
* Returns whether the
|
|
538
|
+
* Returns whether the input group has border.
|
|
539
539
|
* ```typescript
|
|
540
540
|
* @ViewChild("MyInputGroup")
|
|
541
541
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -546,7 +546,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
546
546
|
*/
|
|
547
547
|
get hasBorder(): boolean;
|
|
548
548
|
/**
|
|
549
|
-
* Returns whether the
|
|
549
|
+
* Returns whether the input group type is line.
|
|
550
550
|
* ```typescript
|
|
551
551
|
* @ViewChild("MyInputGroup1")
|
|
552
552
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -557,7 +557,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
557
557
|
*/
|
|
558
558
|
get isTypeLine(): boolean;
|
|
559
559
|
/**
|
|
560
|
-
* Returns whether the
|
|
560
|
+
* Returns whether the input group type is box.
|
|
561
561
|
* ```typescript
|
|
562
562
|
* @ViewChild("MyInputGroup1")
|
|
563
563
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -582,7 +582,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
582
582
|
/** @hidden @internal */
|
|
583
583
|
get fileNames(): string;
|
|
584
584
|
/**
|
|
585
|
-
* Returns whether the
|
|
585
|
+
* Returns whether the input group type is border.
|
|
586
586
|
* ```typescript
|
|
587
587
|
* @ViewChild("MyInputGroup1")
|
|
588
588
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -593,7 +593,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
593
593
|
*/
|
|
594
594
|
get isTypeBorder(): boolean;
|
|
595
595
|
/**
|
|
596
|
-
* Returns true if the
|
|
596
|
+
* Returns true if the input group theme is Fluent.
|
|
597
597
|
* ```typescript
|
|
598
598
|
* @ViewChild("MyInputGroup1")
|
|
599
599
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -604,7 +604,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
604
604
|
*/
|
|
605
605
|
get isTypeFluent(): boolean;
|
|
606
606
|
/**
|
|
607
|
-
* Returns true if the
|
|
607
|
+
* Returns true if the input group theme is Bootstrap.
|
|
608
608
|
* ```typescript
|
|
609
609
|
* @ViewChild("MyInputGroup1")
|
|
610
610
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -615,7 +615,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
615
615
|
*/
|
|
616
616
|
get isTypeBootstrap(): boolean;
|
|
617
617
|
/**
|
|
618
|
-
* Returns true if the
|
|
618
|
+
* Returns true if the input group theme is Indigo.
|
|
619
619
|
* ```typescript
|
|
620
620
|
* @ViewChild("MyInputGroup1")
|
|
621
621
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -626,7 +626,7 @@ declare class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentC
|
|
|
626
626
|
*/
|
|
627
627
|
get isTypeIndigo(): boolean;
|
|
628
628
|
/**
|
|
629
|
-
* Returns whether the
|
|
629
|
+
* Returns whether the input group type is search.
|
|
630
630
|
* ```typescript
|
|
631
631
|
* @ViewChild("MyInputGroup1")
|
|
632
632
|
* public inputGroup: IgxInputGroupComponent;
|
|
@@ -191,7 +191,7 @@ declare class IgxListItemComponent implements IListChild {
|
|
|
191
191
|
get contentElement(): any;
|
|
192
192
|
/**
|
|
193
193
|
* Returns the `context` object which represents the `template context` binding into the `list item container`
|
|
194
|
-
* by providing the `$implicit` declaration which is the
|
|
194
|
+
* by providing the `$implicit` declaration which is the list item itself.
|
|
195
195
|
* ```typescript
|
|
196
196
|
* let listItemComponent = this.listItem.context;
|
|
197
197
|
* ```
|
|
@@ -444,7 +444,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
444
444
|
* Sets/gets the empty list template.
|
|
445
445
|
*
|
|
446
446
|
* @remarks
|
|
447
|
-
* This template is used by
|
|
447
|
+
* This template is used by list in case there are no list items
|
|
448
448
|
* defined and `isLoading` is set to `false`.
|
|
449
449
|
*
|
|
450
450
|
* @example
|
|
@@ -464,7 +464,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
464
464
|
* Sets/gets the list loading template.
|
|
465
465
|
*
|
|
466
466
|
* @remarks
|
|
467
|
-
* This template is used by
|
|
467
|
+
* This template is used by list in case there are no list items defined and `isLoading` is set to `true`.
|
|
468
468
|
*
|
|
469
469
|
* @example
|
|
470
470
|
* ```html
|
|
@@ -642,7 +642,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
642
642
|
* Event emitted when a pan item is returned to its original position.
|
|
643
643
|
*
|
|
644
644
|
* @remarks
|
|
645
|
-
* Provides a reference to an object of type
|
|
645
|
+
* Provides a reference to an object of type list as an event argument.
|
|
646
646
|
*
|
|
647
647
|
* @example
|
|
648
648
|
* ```html
|
|
@@ -655,7 +655,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
655
655
|
* Event emitted when a pan gesture is executed on a list item.
|
|
656
656
|
*
|
|
657
657
|
* @remarks
|
|
658
|
-
* Provides references to the
|
|
658
|
+
* Provides references to the list item and list pan state as event arguments.
|
|
659
659
|
*
|
|
660
660
|
* @example
|
|
661
661
|
* ```html
|
|
@@ -667,7 +667,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
667
667
|
* Event emitted when a list item is clicked.
|
|
668
668
|
*
|
|
669
669
|
* @remarks
|
|
670
|
-
* Provides references to the
|
|
670
|
+
* Provides references to the list item and `Event` as event arguments.
|
|
671
671
|
*
|
|
672
672
|
* @example
|
|
673
673
|
* ```html
|
|
@@ -750,7 +750,7 @@ declare class IgxListComponent extends IgxListBaseDirective {
|
|
|
750
750
|
*
|
|
751
751
|
* @remarks
|
|
752
752
|
* Gets the `context` object which represents the `template context` binding into the `list container`
|
|
753
|
-
* by providing the `$implicit` declaration which is the
|
|
753
|
+
* by providing the `$implicit` declaration which is the list itself.
|
|
754
754
|
*
|
|
755
755
|
* @example
|
|
756
756
|
* ```typescript
|
|
@@ -2,7 +2,7 @@ import * as i0 from '@angular/core';
|
|
|
2
2
|
import { EventEmitter } from '@angular/core';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Action icon is a container for the action nav icon of the navbar.
|
|
6
6
|
*/
|
|
7
7
|
declare class IgxNavbarActionDirective {
|
|
8
8
|
static ɵfac: i0.ɵɵFactoryDeclaration<IgxNavbarActionDirective, never>;
|
|
@@ -37,14 +37,14 @@ declare class IgxNavbarComponent {
|
|
|
37
37
|
*/
|
|
38
38
|
id: string;
|
|
39
39
|
/**
|
|
40
|
-
* Sets the icon of the
|
|
40
|
+
* Sets the icon of the navbar.
|
|
41
41
|
* ```html
|
|
42
42
|
* <igx-navbar [title]="currentView" actionButtonIcon="arrow_back"></igx-navbar>
|
|
43
43
|
* ```
|
|
44
44
|
*/
|
|
45
45
|
actionButtonIcon: string;
|
|
46
46
|
/**
|
|
47
|
-
* Sets the title of the
|
|
47
|
+
* Sets the title of the navbar.
|
|
48
48
|
* ```html
|
|
49
49
|
* <igx-navbar title="Sample App" actionButtonIcon="menu">
|
|
50
50
|
* ```
|
|
@@ -52,7 +52,7 @@ declare class IgxNavbarComponent {
|
|
|
52
52
|
title: string;
|
|
53
53
|
/**
|
|
54
54
|
* The event that will be thrown when the action is executed,
|
|
55
|
-
* provides reference to the
|
|
55
|
+
* provides reference to the navbar component as argument
|
|
56
56
|
* ```typescript
|
|
57
57
|
* public actionExc(event){
|
|
58
58
|
* alert("Action Execute!");
|
|
@@ -65,7 +65,7 @@ declare class IgxNavbarComponent {
|
|
|
65
65
|
*/
|
|
66
66
|
action: EventEmitter<IgxNavbarComponent>;
|
|
67
67
|
/**
|
|
68
|
-
* Sets the titleId of the
|
|
68
|
+
* Sets the titleId of the navbar. If not set it will be automatically generated.
|
|
69
69
|
* ```html
|
|
70
70
|
* <igx-navbar [titleId]="'igx-navbar-7'" title="Sample App" actionButtonIcon="menu">
|
|
71
71
|
* ```
|
|
@@ -81,14 +81,14 @@ declare class IgxNavbarComponent {
|
|
|
81
81
|
protected titleContent: IgxNavbarTitleDirective;
|
|
82
82
|
private isVisible;
|
|
83
83
|
/**
|
|
84
|
-
* Sets whether the action button of the
|
|
84
|
+
* Sets whether the action button of the navbar is visible.
|
|
85
85
|
* ```html
|
|
86
86
|
* <igx-navbar [title]="currentView" [isActionButtonVisible]="'false'"></igx-navbar>
|
|
87
87
|
* ```
|
|
88
88
|
*/
|
|
89
89
|
set isActionButtonVisible(value: boolean);
|
|
90
90
|
/**
|
|
91
|
-
* Returns whether the
|
|
91
|
+
* Returns whether the navbar action button is visible, true/false.
|
|
92
92
|
* ```typescript
|
|
93
93
|
* @ViewChild("MyChild")
|
|
94
94
|
* public navBar: IgxNavbarComponent;
|
|
@@ -199,7 +199,7 @@ declare class IgxPaginatorComponent implements IgxPaginatorToken {
|
|
|
199
199
|
get isLastPageDisabled(): boolean;
|
|
200
200
|
get nativeElement(): any;
|
|
201
201
|
/**
|
|
202
|
-
* Goes to the next page of the
|
|
202
|
+
* Goes to the next page of the paginator, if the paginator is not already at the last page.
|
|
203
203
|
* ```typescript
|
|
204
204
|
* this.paginator.nextPage();
|
|
205
205
|
* ```
|
|
@@ -208,7 +208,7 @@ declare class IgxPaginatorComponent implements IgxPaginatorToken {
|
|
|
208
208
|
*/
|
|
209
209
|
nextPage(): void;
|
|
210
210
|
/**
|
|
211
|
-
* Goes to the previous page of the
|
|
211
|
+
* Goes to the previous page of the paginator, if the paginator is not already at the first page.
|
|
212
212
|
* ```typescript
|
|
213
213
|
* this.paginator.previousPage();
|
|
214
214
|
* ```
|
|
@@ -168,7 +168,7 @@ declare abstract class BaseProgressDirective {
|
|
|
168
168
|
*/
|
|
169
169
|
protected get hasFraction(): boolean;
|
|
170
170
|
/**
|
|
171
|
-
* Returns the
|
|
171
|
+
* Returns the linear progress bar/circular progress bar value in percentage.
|
|
172
172
|
* ```typescript
|
|
173
173
|
* @ViewChild("MyProgressBar")
|
|
174
174
|
* public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent
|
|
@@ -180,7 +180,7 @@ declare abstract class BaseProgressDirective {
|
|
|
180
180
|
*/
|
|
181
181
|
get valueInPercent(): number;
|
|
182
182
|
/**
|
|
183
|
-
* Returns value that indicates the current
|
|
183
|
+
* Returns value that indicates the current linear progress bar/circular progress bar position.
|
|
184
184
|
* ```typescript
|
|
185
185
|
* @ViewChild("MyProgressBar")
|
|
186
186
|
* public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent;
|
|
@@ -197,7 +197,7 @@ declare abstract class BaseProgressDirective {
|
|
|
197
197
|
protected _updateProgressValues(): void;
|
|
198
198
|
private _resetCounterValues;
|
|
199
199
|
/**
|
|
200
|
-
* Set value that indicates the current
|
|
200
|
+
* Set value that indicates the current linear progress bar / circular progress bar position.
|
|
201
201
|
* ```html
|
|
202
202
|
* <igx-linear-bar [value]="50"></igx-linear-bar>
|
|
203
203
|
* <igx-circular-bar [value]="50"></igx-circular-bar>
|
|
@@ -213,7 +213,7 @@ declare class IgxLinearProgressBarComponent extends BaseProgressDirective implem
|
|
|
213
213
|
valueMin: number;
|
|
214
214
|
cssClass: string;
|
|
215
215
|
/**
|
|
216
|
-
* Set
|
|
216
|
+
* Set linear progress bar to have striped style. By default it is set to false.
|
|
217
217
|
* ```html
|
|
218
218
|
* <igx-linear-bar [striped]="true" [max]="200" [value]="50"></igx-linear-bar>
|
|
219
219
|
* ```
|
|
@@ -248,7 +248,7 @@ declare class IgxLinearProgressBarComponent extends BaseProgressDirective implem
|
|
|
248
248
|
get hasText(): boolean;
|
|
249
249
|
/**
|
|
250
250
|
* Set the position that defines where the text is aligned.
|
|
251
|
-
* Possible options - `
|
|
251
|
+
* Possible options - `START` (default), `CENTER`, `END`.
|
|
252
252
|
* ```typescript
|
|
253
253
|
* public positionCenter: IgxTextAlign;
|
|
254
254
|
* public ngOnInit() {
|
|
@@ -276,7 +276,7 @@ declare class IgxLinearProgressBarComponent extends BaseProgressDirective implem
|
|
|
276
276
|
*/
|
|
277
277
|
textTop: boolean;
|
|
278
278
|
/**
|
|
279
|
-
* Set type of the
|
|
279
|
+
* Set type of the linear progress bar. Possible options - `default`, `success`, `info`, `warning`, and `error`.
|
|
280
280
|
* ```html
|
|
281
281
|
* <igx-linear-bar [type]="'error'"></igx-linear-bar>
|
|
282
282
|
* ```
|
|
@@ -353,7 +353,7 @@ declare class IgxCircularProgressBarComponent extends BaseProgressDirective impl
|
|
|
353
353
|
*/
|
|
354
354
|
get textContent(): string;
|
|
355
355
|
/**
|
|
356
|
-
* Set type of the
|
|
356
|
+
* Set type of the circular progress bar. Possible options - `default`, `success`, `info`, `warning`, and `error`.
|
|
357
357
|
* ```html
|
|
358
358
|
* <igx-circular-bar [type]="'error'"></igx-circular-bar>
|
|
359
359
|
* ```
|
|
@@ -20,7 +20,7 @@ declare class IgxQueryBuilderHeaderComponent {
|
|
|
20
20
|
*/
|
|
21
21
|
get getClass(): string;
|
|
22
22
|
/**
|
|
23
|
-
* Sets the title of the
|
|
23
|
+
* Sets the title of the query builder header.
|
|
24
24
|
*
|
|
25
25
|
* @example
|
|
26
26
|
* ```html
|
|
@@ -720,7 +720,7 @@ declare class IgxQueryBuilderComponent implements OnDestroy {
|
|
|
720
720
|
*/
|
|
721
721
|
showEntityChangeDialog: boolean;
|
|
722
722
|
/**
|
|
723
|
-
* Gets the list of entities available for the
|
|
723
|
+
* Gets the list of entities available for the query builder.
|
|
724
724
|
*
|
|
725
725
|
* Each entity describes a logical group of fields that can be used in queries.
|
|
726
726
|
* An entity can optionally have child entities, allowing nested sub-queries.
|
|
@@ -729,7 +729,7 @@ declare class IgxQueryBuilderComponent implements OnDestroy {
|
|
|
729
729
|
*/
|
|
730
730
|
get entities(): EntityType[];
|
|
731
731
|
/**
|
|
732
|
-
* Sets the list of entities for the
|
|
732
|
+
* Sets the list of entities for the query builder.
|
|
733
733
|
* If the `expressionTree` is defined, it will be recreated with the new entities.
|
|
734
734
|
*
|
|
735
735
|
* Each entity should be an {@link EntityType} object describing the fields and optionally child entities.
|
|
@@ -186,11 +186,11 @@ declare class IgxRadioGroupDirective implements ControlValueAccessor, OnDestroy,
|
|
|
186
186
|
*/
|
|
187
187
|
get radioButtons(): QueryList<IgxRadioComponent>;
|
|
188
188
|
/**
|
|
189
|
-
* Sets/gets the
|
|
189
|
+
* Sets/gets the value attribute.
|
|
190
190
|
*
|
|
191
191
|
* @example
|
|
192
192
|
* ```html
|
|
193
|
-
* <igx-radio-group [value]
|
|
193
|
+
* <igx-radio-group [value]="'radioButtonValue'"></igx-radio-group>
|
|
194
194
|
* ```
|
|
195
195
|
*/
|
|
196
196
|
get value(): any;
|
|
@@ -243,10 +243,10 @@ declare class IgxRadioGroupDirective implements ControlValueAccessor, OnDestroy,
|
|
|
243
243
|
get invalid(): boolean;
|
|
244
244
|
set invalid(value: boolean);
|
|
245
245
|
/**
|
|
246
|
-
* An event that is emitted after the radio group
|
|
246
|
+
* An event that is emitted after the radio group value is changed.
|
|
247
247
|
*
|
|
248
248
|
* @remarks
|
|
249
|
-
* Provides references to the selected
|
|
249
|
+
* Provides references to the selected radio and the value property as event arguments.
|
|
250
250
|
*
|
|
251
251
|
* @example
|
|
252
252
|
* ```html
|
|
@@ -376,7 +376,7 @@ declare class IgxRadioGroupDirective implements ControlValueAccessor, OnDestroy,
|
|
|
376
376
|
*
|
|
377
377
|
* @remarks
|
|
378
378
|
* Checks whether the provided value is consistent to the current radio button.
|
|
379
|
-
* If it is, the checked attribute will have value `true` and selected property will contain the selected
|
|
379
|
+
* If it is, the checked attribute will have value `true` and selected property will contain the selected radio.
|
|
380
380
|
*
|
|
381
381
|
* @example
|
|
382
382
|
* ```typescript
|