igniteui-angular 12.3.0-alpha.0 → 12.3.0-alpha.1

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.
Files changed (61) hide show
  1. package/bundles/igniteui-angular.umd.js +454 -544
  2. package/bundles/igniteui-angular.umd.js.map +1 -1
  3. package/esm2015/igniteui-angular.js +106 -107
  4. package/esm2015/lib/action-strip/action-strip.component.js +19 -2
  5. package/esm2015/lib/action-strip/grid-actions/grid-action-button.component.js +2 -2
  6. package/esm2015/lib/action-strip/grid-actions/grid-editing-actions.component.js +4 -4
  7. package/esm2015/lib/action-strip/grid-actions/grid-pinning-actions.component.js +5 -5
  8. package/esm2015/lib/banner/banner.component.js +1 -1
  9. package/esm2015/lib/combo/combo.common.js +28 -11
  10. package/esm2015/lib/combo/combo.component.js +12 -24
  11. package/esm2015/lib/core/i18n/action-strip-resources.js +4 -0
  12. package/esm2015/lib/core/i18n/resources.js +5 -3
  13. package/esm2015/lib/core/utils.js +11 -1
  14. package/esm2015/lib/directives/radio/radio-group.directive.js +5 -13
  15. package/esm2015/lib/drop-down/drop-down-item.base.js +1 -5
  16. package/esm2015/lib/grids/cell.component.js +1 -17
  17. package/esm2015/lib/grids/column-actions/column-actions.component.js +3 -7
  18. package/esm2015/lib/grids/grid/grid.component.js +3 -7
  19. package/esm2015/lib/grids/grid-base.directive.js +58 -118
  20. package/esm2015/lib/grids/grid-public-row.js +3 -12
  21. package/esm2015/lib/grids/headers/grid-header-row.component.js +2 -2
  22. package/esm2015/lib/grids/hierarchical-grid/hierarchical-grid.component.js +3 -7
  23. package/esm2015/lib/grids/tree-grid/tree-grid.component.js +3 -7
  24. package/esm2015/lib/icon/icon.component.js +1 -6
  25. package/esm2015/lib/services/overlay/utilities.js +1 -1
  26. package/esm2015/lib/simple-combo/simple-combo.component.js +123 -30
  27. package/esm2015/lib/toast/toast.component.js +3 -6
  28. package/esm2015/public_api.js +1 -1
  29. package/fesm2015/igniteui-angular.js +274 -347
  30. package/fesm2015/igniteui-angular.js.map +1 -1
  31. package/igniteui-angular.d.ts +105 -106
  32. package/igniteui-angular.metadata.json +1 -1
  33. package/lib/action-strip/action-strip.component.d.ts +10 -0
  34. package/lib/banner/banner.component.d.ts +1 -2
  35. package/lib/combo/combo.common.d.ts +27 -14
  36. package/lib/combo/combo.component.d.ts +9 -19
  37. package/lib/core/i18n/action-strip-resources.d.ts +4 -0
  38. package/lib/core/i18n/resources.d.ts +3 -1
  39. package/lib/core/utils.d.ts +4 -0
  40. package/lib/directives/radio/radio-group.directive.d.ts +4 -4
  41. package/lib/grids/cell.component.d.ts +0 -9
  42. package/lib/grids/column-actions/column-actions.component.d.ts +2 -1
  43. package/lib/grids/grid/grid.component.d.ts +2 -1
  44. package/lib/grids/grid-base.directive.d.ts +54 -37
  45. package/lib/grids/grid-public-row.d.ts +2 -3
  46. package/lib/grids/hierarchical-grid/hierarchical-grid.component.d.ts +2 -1
  47. package/lib/grids/tree-grid/tree-grid.component.d.ts +2 -1
  48. package/lib/icon/icon.component.d.ts +2 -2
  49. package/lib/services/overlay/utilities.d.ts +2 -1
  50. package/lib/simple-combo/simple-combo.component.d.ts +20 -3
  51. package/lib/toast/toast.component.d.ts +2 -0
  52. package/migrations/common/filterSourceDirs.d.ts +2 -2
  53. package/migrations/common/filterSourceDirs.js +2 -2
  54. package/migrations/migration-collection.json +0 -5
  55. package/migrations/{update-12_3_0 → update-13_0_0}/changes/members.json +0 -0
  56. package/package.json +1 -1
  57. package/public_api.d.ts +1 -0
  58. package/esm2015/lib/core/deprecateDecorators.js +0 -101
  59. package/lib/core/deprecateDecorators.d.ts +0 -20
  60. package/migrations/update-12_3_0/index.d.ts +0 -3
  61. package/migrations/update-12_3_0/index.js +0 -9
@@ -1,5 +1,6 @@
1
1
  import { Renderer2, ViewContainerRef, QueryList, TemplateRef, AfterContentInit, ChangeDetectorRef, AfterViewInit } from '@angular/core';
2
2
  import { DisplayDensityBase, IDisplayDensityOptions } from '../core/density';
3
+ import { IActionStripResourceStrings } from '../core/i18n/action-strip-resources';
3
4
  import { IgxDropDownComponent } from '../drop-down/public_api';
4
5
  import { OverlaySettings } from '../services/public_api';
5
6
  import { IgxGridActionsBaseDirective } from './grid-actions/grid-actions-base.directive';
@@ -76,6 +77,14 @@ export declare class IgxActionStripComponent extends DisplayDensityBase implemen
76
77
  * @internal
77
78
  */
78
79
  hostClass: string;
80
+ /**
81
+ * Gets/Sets the resource strings.
82
+ *
83
+ * @remarks
84
+ * By default it uses EN resources.
85
+ */
86
+ set resourceStrings(value: IActionStripResourceStrings);
87
+ get resourceStrings(): IActionStripResourceStrings;
79
88
  /**
80
89
  * Reference to the menu
81
90
  *
@@ -91,6 +100,7 @@ export declare class IgxActionStripComponent extends DisplayDensityBase implemen
91
100
  */
92
101
  menuOverlaySettings: OverlaySettings;
93
102
  private _hidden;
103
+ private _resourceStrings;
94
104
  constructor(_viewContainer: ViewContainerRef, renderer: Renderer2, _displayDensityOptions: IDisplayDensityOptions, cdr: ChangeDetectorRef);
95
105
  /**
96
106
  * Getter for the 'display' property of the current `IgxActionStrip`
@@ -5,8 +5,7 @@ import { CancelableEventArgs, IBaseEventArgs } from '../core/utils';
5
5
  import { ToggleAnimationSettings } from '../expansion-panel/toggle-animation-component';
6
6
  export interface BannerEventArgs extends IBaseEventArgs {
7
7
  /**
8
- * @deprecated
9
- * To get a reference to the banner, use `owner` instead.
8
+ * @deprecated in 12.1.0. To get a reference to the banner, use `owner` instead
10
9
  */
11
10
  banner: IgxBannerComponent;
12
11
  event?: Event;
@@ -5,14 +5,13 @@ import { DisplayDensityBase, IDisplayDensityOptions } from '../core/displayDensi
5
5
  import { IgxSelectionAPIService } from '../core/selection';
6
6
  import { CancelableBrowserEventArgs, IBaseCancelableBrowserEventArgs, IBaseEventArgs } from '../core/utils';
7
7
  import { IForOfState, IgxForOfDirective } from '../directives/for-of/for_of.directive';
8
- import { ISelectionEventArgs } from '../drop-down/public_api';
9
8
  import { IgxIconService } from '../icon/public_api';
10
9
  import { IgxInputGroupType } from '../input-group/inputGroupType';
11
10
  import { IgxInputDirective, IgxInputGroupComponent } from '../input-group/public_api';
12
11
  import { OverlaySettings } from '../services/public_api';
13
12
  import { IgxComboDropDownComponent } from './combo-dropdown.component';
14
13
  import { IgxComboAPIService } from './combo.api';
15
- import { IComboFilteringOptions, IComboItemAdditionEvent, IComboSearchInputEventArgs, IComboSelectionChangingEventArgs } from './public_api';
14
+ import { IComboFilteringOptions, IComboItemAdditionEvent, IComboSearchInputEventArgs } from './public_api';
16
15
  export declare const IGX_COMBO_COMPONENT: InjectionToken<IgxComboBase>;
17
16
  /** @hidden @internal TODO: Evaluate */
18
17
  export interface IgxComboBase {
@@ -40,8 +39,7 @@ export interface IgxComboBase {
40
39
  isItemSelected(itemID: any): boolean;
41
40
  select(item: any): void;
42
41
  select(itemIDs: any[], clearSelection?: boolean, event?: Event): void;
43
- deselect(item: any): void;
44
- deselect(itemIDs: any[], event?: Event): void;
42
+ deselect(...args: [] | [itemIDs: any[], event?: Event]): void;
45
43
  }
46
44
  /** @hidden @internal */
47
45
  export declare enum DataTypes {
@@ -73,6 +71,20 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
73
71
  protected _displayDensityOptions: IDisplayDensityOptions;
74
72
  protected _inputGroupType: IgxInputGroupType;
75
73
  protected _injector: Injector;
74
+ /**
75
+ * Defines whether the caseSensitive icon should be shown in the search input
76
+ *
77
+ * ```typescript
78
+ * // get
79
+ * let myComboShowSearchCaseIcon = this.combo.showSearchCaseIcon;
80
+ * ```
81
+ *
82
+ * ```html
83
+ * <!--set-->
84
+ * <igx-combo [showSearchCaseIcon]='true'></igx-combo>
85
+ * ```
86
+ */
87
+ showSearchCaseIcon: boolean;
76
88
  /**
77
89
  * Set custom overlay settings that control how the combo's list of items is displayed.
78
90
  * Set:
@@ -251,6 +263,13 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
251
263
  * ```
252
264
  */
253
265
  get groupKey(): string;
266
+ /**
267
+ * An @Input property that enabled/disables filtering in the list. The default is `true`.
268
+ * ```html
269
+ * <igx-combo [filterable]="false">
270
+ * ```
271
+ */
272
+ filterable: boolean;
254
273
  /**
255
274
  * An @Input property that set aria-labelledby attribute
256
275
  * ```html
@@ -284,14 +303,6 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
284
303
  */
285
304
  get type(): IgxInputGroupType;
286
305
  set type(val: IgxInputGroupType);
287
- /**
288
- * Emitted when item selection is changing, before the selection completes
289
- *
290
- * ```html
291
- * <igx-combo (selectionChanging)='handleSelection()'></igx-combo>
292
- * ```
293
- */
294
- selectionChanging: EventEmitter<ISelectionEventArgs | IComboSelectionChangingEventArgs>;
295
306
  /**
296
307
  * Emitted before the dropdown is opened
297
308
  *
@@ -629,6 +640,7 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
629
640
  private _itemsMaxHeight;
630
641
  private _overlaySettings;
631
642
  abstract dropdown: IgxComboDropDownComponent;
643
+ abstract selectionChanging: EventEmitter<any>;
632
644
  constructor(elementRef: ElementRef, cdr: ChangeDetectorRef, selectionService: IgxSelectionAPIService, comboAPI: IgxComboAPIService, _iconService: IgxIconService, _displayDensityOptions: IDisplayDensityOptions, _inputGroupType: IgxInputGroupType, _injector: Injector);
633
645
  /** @hidden @internal */
634
646
  onArrowDown(event: Event): void;
@@ -714,6 +726,8 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
714
726
  onClick(event: Event): void;
715
727
  /** @hidden @internal */
716
728
  onBlur(): void;
729
+ /** @hidden @internal */
730
+ toggleCaseSensitive(): void;
717
731
  protected onStatusChanged: () => void;
718
732
  /** if there is a valueKey - map the keys to data items, else - just return the keys */
719
733
  protected convertKeysToItems(keys: any[]): any[];
@@ -735,8 +749,7 @@ export declare abstract class IgxComboBaseDirective extends DisplayDensityBase i
735
749
  abstract focusSearchInput(opening?: boolean): any;
736
750
  abstract select(newItem: any): void;
737
751
  abstract select(newItems: Array<any> | any, clearCurrentSelection?: boolean, event?: Event): void;
738
- abstract deselect(item: any): void;
739
- abstract deselect(items: Array<any>, event?: Event): void;
752
+ abstract deselect(...args: [] | [items: Array<any>, event?: Event]): void;
740
753
  abstract writeValue(value: any): void;
741
754
  protected abstract setSelection(newSelection: Set<any>, event?: Event): void;
742
755
  protected abstract createDisplayText(newSelection: any[], oldSelection: any[]): any;
@@ -1,4 +1,4 @@
1
- import { AfterViewInit, ChangeDetectorRef, ElementRef, OnInit, OnDestroy, Injector } from '@angular/core';
1
+ import { AfterViewInit, ChangeDetectorRef, ElementRef, OnInit, OnDestroy, Injector, EventEmitter } from '@angular/core';
2
2
  import { ControlValueAccessor } from '@angular/forms';
3
3
  import { IgxSelectionAPIService } from '../core/selection';
4
4
  import { IBaseEventArgs, IBaseCancelableEventArgs, CancelableEventArgs } from '../core/utils';
@@ -69,20 +69,6 @@ export declare class IgxComboComponent extends IgxComboBaseDirective implements
69
69
  protected _displayDensityOptions: IDisplayDensityOptions;
70
70
  protected _inputGroupType: IgxInputGroupType;
71
71
  protected _injector: Injector;
72
- /**
73
- * Defines whether the caseSensitive icon should be shown in the search input
74
- *
75
- * ```typescript
76
- * // get
77
- * let myComboShowSearchCaseIcon = this.combo.showSearchCaseIcon;
78
- * ```
79
- *
80
- * ```html
81
- * <!--set-->
82
- * <igx-combo [showSearchCaseIcon]='true'></igx-combo>
83
- * ```
84
- */
85
- showSearchCaseIcon: boolean;
86
72
  /**
87
73
  * An @Input property that controls whether the combo's search box
88
74
  * should be focused after the `opened` event is called
@@ -110,6 +96,14 @@ export declare class IgxComboComponent extends IgxComboBaseDirective implements
110
96
  * ```
111
97
  */
112
98
  searchPlaceholder: string;
99
+ /**
100
+ * Emitted when item selection is changing, before the selection completes
101
+ *
102
+ * ```html
103
+ * <igx-combo (selectionChanging)='handleSelection()'></igx-combo>
104
+ * ```
105
+ */
106
+ selectionChanging: EventEmitter<IComboSelectionChangingEventArgs>;
113
107
  /** @hidden @internal */
114
108
  dropdown: IgxComboDropDownComponent;
115
109
  /**
@@ -211,10 +205,6 @@ export declare class IgxComboComponent extends IgxComboBaseDirective implements
211
205
  * ```
212
206
  */
213
207
  setSelectedItem(itemID: any, select?: boolean, event?: Event): void;
214
- /**
215
- * @hidden @internal
216
- */
217
- toggleCaseSensitive(): void;
218
208
  /** @hidden @internal */
219
209
  handleOpened(): void;
220
210
  /** @hidden @internal */
@@ -0,0 +1,4 @@
1
+ export interface IActionStripResourceStrings {
2
+ igx_action_strip_button_more_title?: string;
3
+ }
4
+ export declare const ActionStripResourceStringsEN: IActionStripResourceStrings;
@@ -9,7 +9,8 @@ import { IListResourceStrings } from './list-resources';
9
9
  import { ICalendarResourceStrings } from './calendar-resources';
10
10
  import { IInputResourceStrings } from './input-resources';
11
11
  import { ITreeResourceStrings } from './tree-resources';
12
- export interface IResourceStrings extends IGridResourceStrings, ITimePickerResourceStrings, ICalendarResourceStrings, ICarouselResourceStrings, IChipResourceStrings, IInputResourceStrings, IDatePickerResourceStrings, IDateRangePickerResourceStrings, IListResourceStrings, IPaginatorResourceStrings, ITreeResourceStrings {
12
+ import { IActionStripResourceStrings } from './action-strip-resources';
13
+ export interface IResourceStrings extends IGridResourceStrings, ITimePickerResourceStrings, ICalendarResourceStrings, ICarouselResourceStrings, IChipResourceStrings, IInputResourceStrings, IDatePickerResourceStrings, IDateRangePickerResourceStrings, IListResourceStrings, IPaginatorResourceStrings, ITreeResourceStrings, IActionStripResourceStrings {
13
14
  }
14
15
  /**
15
16
  * @hidden
@@ -35,6 +36,7 @@ export declare const CurrentResourceStrings: {
35
36
  ListResStrings: any;
36
37
  InputResStrings: any;
37
38
  TreeResStrings: any;
39
+ ActionStripResourceStrings: any;
38
40
  };
39
41
  /**
40
42
  * Changes the resource strings for all components in the application
@@ -1,5 +1,9 @@
1
1
  import { AnimationReferenceMetadata } from '@angular/animations';
2
2
  import { Observable } from 'rxjs';
3
+ /**
4
+ * @hidden
5
+ */
6
+ export declare const showMessage: (message: string, isMessageShown: boolean) => boolean;
3
7
  export declare const mkenum: <T extends {
4
8
  [index: string]: U;
5
9
  }, U extends string>(x: T) => T;
@@ -78,10 +78,10 @@ export declare class IgxRadioGroupDirective implements AfterContentInit, Control
78
78
  get required(): boolean;
79
79
  set required(value: boolean);
80
80
  /**
81
- * An @Input property that allows you to disable the radio group. By default it's false.
82
- *
83
81
  * @deprecated in version 12.2.0
84
82
  *
83
+ * An input property that allows you to disable the radio group. By default it's false.
84
+ *
85
85
  * @example
86
86
  * ```html
87
87
  * <igx-radio-group disabled></igx-radio-group>
@@ -90,10 +90,10 @@ export declare class IgxRadioGroupDirective implements AfterContentInit, Control
90
90
  get disabled(): boolean;
91
91
  set disabled(value: boolean);
92
92
  /**
93
- * Sets/gets the position of the `label` in the child radio buttons.
94
- *
95
93
  * @deprecated in version 12.2.0
96
94
  *
95
+ * Sets/gets the position of the `label` in the child radio buttons.
96
+ *
97
97
  * @remarks
98
98
  * If not set, `labelPosition` will have value `"after"`.
99
99
  *
@@ -382,15 +382,6 @@ export declare class IgxGridCellComponent implements OnInit, OnChanges, OnDestro
382
382
  private _cellSelection;
383
383
  private _vIndex;
384
384
  constructor(selectionService: IgxGridSelectionService, gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>, cdr: ChangeDetectorRef, element: ElementRef, zone: NgZone, touchManager: HammerGesturesManager, platformUtil: PlatformUtil);
385
- /**
386
- * @deprecated
387
- * Gets whether the cell is selected.
388
- * ```typescript
389
- * let isCellSelected = thid.cell.isCellSelected();
390
- * ```
391
- * @memberof IgxGridCellComponent
392
- */
393
- isCellSelected(): boolean;
394
385
  /**
395
386
  * @hidden
396
387
  * @internal
@@ -131,9 +131,10 @@ export declare class IgxColumnActionsComponent implements DoCheck {
131
131
  private _id;
132
132
  constructor(differs: IterableDiffers);
133
133
  /**
134
+ * @deprecated Use grid input instead.
135
+ *
134
136
  * Gets the grid columns to provide an action for.
135
137
  *
136
- * @deprecated
137
138
  * @example
138
139
  * ```typescript
139
140
  * let gridColumns = this.columnActions.columns;
@@ -301,7 +301,8 @@ export declare class IgxGridComponent extends IgxGridBaseDirective implements Gr
301
301
  set dropAreaMessage(value: string);
302
302
  get dropAreaMessage(): string;
303
303
  /**
304
- * @deprecated
304
+ * @deprecated in version 12.1.0. Use `getCellByColumn` or `getCellByKey` instead
305
+ *
305
306
  * Returns a `CellType` object that matches the conditions.
306
307
  *
307
308
  * @example
@@ -171,9 +171,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
171
171
  */
172
172
  gridScroll: EventEmitter<IGridScrollEventArgs>;
173
173
  /**
174
+ * @deprecated in version 12.1.0. Use the corresponding output exposed by the `igx-paginator` component instead
175
+ *
174
176
  * Emitted after the current page is changed.
175
177
  *
176
- * @deprecated in version 12.1.0
177
178
  * @example
178
179
  * ```html
179
180
  * <igx-grid (pageChange)="onPageChange($event)"></igx-grid>
@@ -186,10 +187,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
186
187
  */
187
188
  pageChange: EventEmitter<number>;
188
189
  /**
190
+ * @deprecated in version 12.1.0. Use the corresponding output exposed by the `igx-paginator` component instead
191
+ *
189
192
  * Emitted when `perPage` property value of the grid is changed.
190
193
  *
191
- * @deprecated in version 12.1.0
192
- * @example
193
194
  * ```html
194
195
  * <igx-grid #grid (perPageChange)="onPerPageChange($event)" [autoGenerate]="true"></igx-grid>
195
196
  * ```
@@ -206,6 +207,8 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
206
207
  */
207
208
  class: string;
208
209
  /**
210
+ * @deprecated in version 12.2.0. We suggest using `rowClasses` property instead
211
+ *
209
212
  * Gets/Sets the styling classes applied to all even `IgxGridRowComponent`s in the grid.
210
213
  *
211
214
  * @example
@@ -215,6 +218,8 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
215
218
  */
216
219
  evenRowCSS: string;
217
220
  /**
221
+ * @deprecated in version 12.2.0. We suggest using `rowClasses` property instead
222
+ *
218
223
  * Gets/Sets the styling classes applied to all odd `IgxGridRowComponent`s in the grid.
219
224
  *
220
225
  * @example
@@ -511,9 +516,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
511
516
  */
512
517
  filteringDone: EventEmitter<IFilteringExpressionsTree>;
513
518
  /**
519
+ * @deprecated in version 12.1.0. Use the corresponding output exposed by the `igx-paginator` component instead
520
+ *
514
521
  * Emitted after paging is performed.
515
522
  *
516
- * @deprecated in version 12.1.x
517
523
  * @remarks
518
524
  * Returns an object consisting of the previous and next pages.
519
525
  * @example
@@ -1024,9 +1030,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1024
1030
  get pagingMode(): GridPagingMode;
1025
1031
  set pagingMode(val: GridPagingMode);
1026
1032
  /**
1033
+ * @deprecated in version 12.1.0. Use the corresponding method exposed by the `igx-paginator`
1034
+ *
1027
1035
  * Gets/Sets whether the paging feature is enabled.
1028
1036
  *
1029
- * @deprecated in version 12.1.x
1030
1037
  * @remarks
1031
1038
  * The default state is disabled (false).
1032
1039
  * @example
@@ -1039,9 +1046,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1039
1046
  get paging(): boolean;
1040
1047
  set paging(value: boolean);
1041
1048
  /**
1049
+ * @deprecated in version 12.1.0. Use `page` property form `paginator` component instead
1050
+ *
1042
1051
  * Gets/Sets the current page index.
1043
1052
  *
1044
- * @deprecated in version 12.1.x
1045
1053
  * @example
1046
1054
  * ```html
1047
1055
  * <igx-grid #grid [data]="Data" [autoGenerate]="true">
@@ -1054,9 +1062,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1054
1062
  get page(): number;
1055
1063
  set page(val: number);
1056
1064
  /**
1065
+ * @deprecated in version 12.1.0. Use `perPage` property from `paginator` component instead
1066
+ *
1057
1067
  * Gets/Sets the number of visible items per page.
1058
1068
  *
1059
- * @deprecated in version 12.1.x
1060
1069
  * @remarks
1061
1070
  * The default is 15.
1062
1071
  * @example
@@ -1069,9 +1078,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1069
1078
  get perPage(): number;
1070
1079
  set perPage(val: number);
1071
1080
  /**
1081
+ * @deprecated in version 10.1.0
1082
+ *
1072
1083
  * Gets/Sets whether the column hiding UI is enabled.
1073
1084
  *
1074
- * @deprecated
1075
1085
  * @remarks
1076
1086
  * By default it is disabled (false). In order for the UI to work, you need to enable the toolbar as shown in the example below.
1077
1087
  * @example
@@ -1220,9 +1230,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1220
1230
  set emptyFilteredGridMessage(value: string);
1221
1231
  get emptyFilteredGridMessage(): string;
1222
1232
  /**
1223
- * Gets/Sets the title to be displayed in the built-in column hiding UI.
1233
+ * @deprecated in version 10.1.0
1224
1234
  *
1225
- * @deprecated
1235
+ * Gets/Sets the title to be displayed in the built-in column hiding UI.
1226
1236
  *
1227
1237
  * @example
1228
1238
  * ```html
@@ -1247,9 +1257,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1247
1257
  get pinning(): IPinningConfig;
1248
1258
  set pinning(value: IPinningConfig);
1249
1259
  /**
1250
- * Gets/Sets if the built-in column pinning UI should be shown in the toolbar.
1260
+ * @deprecated in version 10.1.0
1251
1261
  *
1252
- * @deprecated
1262
+ * Gets/Sets if the built-in column pinning UI should be shown in the toolbar.
1253
1263
  *
1254
1264
  * @example
1255
1265
  * ```html
@@ -1259,9 +1269,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1259
1269
  get columnPinning(): boolean;
1260
1270
  set columnPinning(value: boolean);
1261
1271
  /**
1262
- * Gets/Sets the title to be displayed in the UI of the column pinning.
1272
+ * @deprecated in version 10.1.0
1263
1273
  *
1264
- * @deprecated
1274
+ * Gets/Sets the title to be displayed in the UI of the column pinning.
1265
1275
  *
1266
1276
  * @example
1267
1277
  * ```html
@@ -1524,9 +1534,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1524
1534
  */
1525
1535
  get pinnedColumnsCount(): number;
1526
1536
  /**
1527
- * Gets/Sets the text to be displayed inside the toggle button.
1537
+ * @deprecated in version 10.1.0
1528
1538
  *
1529
- * @deprecated
1539
+ * Gets/Sets the text to be displayed inside the toggle button.
1530
1540
  *
1531
1541
  * @remarks
1532
1542
  * Used for the built-in column hiding UI of the`IgxColumnComponent`.
@@ -1538,9 +1548,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1538
1548
  get hiddenColumnsText(): string;
1539
1549
  set hiddenColumnsText(value: string);
1540
1550
  /**
1541
- * Gets/Sets the text to be displayed inside the toggle button.
1551
+ * @deprecated in version 10.1.0
1542
1552
  *
1543
- * @deprecated
1553
+ * Gets/Sets the text to be displayed inside the toggle button.
1544
1554
  *
1545
1555
  * @remarks
1546
1556
  * Used for the built-in column pinning UI of the`IgxColumnComponent`.
@@ -1579,9 +1589,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1579
1589
  */
1580
1590
  get currencyPositionLeft(): boolean;
1581
1591
  /**
1582
- * Gets/Sets whether the toolbar is shown.
1592
+ * @deprecated in version 11.0.0
1583
1593
  *
1584
- * @deprecated
1594
+ * Gets/Sets whether the toolbar is shown.
1585
1595
  *
1586
1596
  * @example
1587
1597
  * ```html
@@ -1591,9 +1601,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1591
1601
  get showToolbar(): boolean;
1592
1602
  set showToolbar(newValue: boolean);
1593
1603
  /**
1594
- * Gets/Sets the toolbar's title.
1604
+ * @deprecated in version 11.0.0
1595
1605
  *
1596
- * @deprecated
1606
+ * Gets/Sets the toolbar's title.
1597
1607
  *
1598
1608
  * @example
1599
1609
  * ```html
@@ -1603,9 +1613,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1603
1613
  get toolbarTitle(): string;
1604
1614
  set toolbarTitle(newValue: string);
1605
1615
  /**
1606
- * Gets/Sets whether exporting to MS Excel is enabled or disabled.
1616
+ * @deprecated `exportExcel` is deprecated
1607
1617
  *
1608
- * @deprecated
1618
+ * Gets/Sets whether exporting to MS Excel is enabled or disabled.
1609
1619
  *
1610
1620
  * @example
1611
1621
  * ```html
@@ -1615,9 +1625,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1615
1625
  get exportExcel(): boolean;
1616
1626
  set exportExcel(newValue: boolean);
1617
1627
  /**
1618
- * Gets/Sets whether the option for exporting to CSV is enabled or disabled.
1628
+ * @deprecated `exportCsv` is deprecated
1619
1629
  *
1620
- * @deprecated
1630
+ * Gets/Sets whether the option for exporting to CSV is enabled or disabled.
1621
1631
  *
1622
1632
  * ```html
1623
1633
  * <igx-grid [data]="localData" [showToolbar]="true" [autoGenerate]="true" [exportCsv]="true"></igx-grid>
@@ -1626,9 +1636,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1626
1636
  get exportCsv(): boolean;
1627
1637
  set exportCsv(newValue: boolean);
1628
1638
  /**
1629
- * Gets/Sets the textual content for the main export button.
1639
+ * @deprecated `exportText` is deprecated
1630
1640
  *
1631
- * @deprecated
1641
+ * Gets/Sets the textual content for the main export button.
1632
1642
  *
1633
1643
  * @example
1634
1644
  * ```html
@@ -1638,9 +1648,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1638
1648
  get exportText(): string;
1639
1649
  set exportText(newValue: string);
1640
1650
  /**
1641
- * Gets/Sets the textual content for the MS Excel export button.
1651
+ * @deprecated `exportExcelText` is deprecated
1642
1652
  *
1643
- * @deprecated
1653
+ * Gets/Sets the textual content for the MS Excel export button.
1644
1654
  *
1645
1655
  * ```html
1646
1656
  * <igx-grid [exportExcelText]="'My Excel Exporter" [showToolbar]="true" [exportText]="'My Exporter'" [exportCsv]="true"></igx-grid>
@@ -1649,9 +1659,9 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
1649
1659
  get exportExcelText(): string;
1650
1660
  set exportExcelText(newValue: string);
1651
1661
  /**
1652
- * Gets/Sets the textual content for the CSV export button.
1662
+ * @deprecated `exportCsvText` is deprecated
1653
1663
  *
1654
- * @deprecated
1664
+ * Gets/Sets the textual content for the CSV export button.
1655
1665
  *
1656
1666
  * @example
1657
1667
  * ```html
@@ -2400,9 +2410,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2400
2410
  */
2401
2411
  get visibleColumns(): IgxColumnComponent[];
2402
2412
  /**
2413
+ * @deprecated in version 12.1.0. Use the corresponding property exposed by the `igx-paginator`
2414
+ *
2403
2415
  * Gets the total number of pages.
2404
2416
  *
2405
- * @deprecated in version 12.1.0
2406
2417
  * @example
2407
2418
  * ```typescript
2408
2419
  * const totalPages = this.grid.totalPages;
@@ -2410,9 +2421,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2410
2421
  */
2411
2422
  get totalPages(): number;
2412
2423
  /**
2424
+ * @deprecated in version 12.1.0. Use the corresponding property exposed by the `igx-paginator`
2425
+ *
2413
2426
  * Gets if the current page is the first page.
2414
2427
  *
2415
- * @deprecated in version 12.1.0
2416
2428
  * @example
2417
2429
  * ```typescript
2418
2430
  * const firstPage = this.grid.isFirstPage;
@@ -2420,9 +2432,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2420
2432
  */
2421
2433
  get isFirstPage(): boolean;
2422
2434
  /**
2435
+ * @deprecated in version 12.1.0. Use the corresponding method exposed by the `igx-paginator`
2436
+ *
2423
2437
  * Goes to the next page, if the grid is not already at the last page.
2424
2438
  *
2425
- * @deprecated in version 12.1.0
2426
2439
  * @example
2427
2440
  * ```typescript
2428
2441
  * this.grid1.nextPage();
@@ -2430,9 +2443,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2430
2443
  */
2431
2444
  nextPage(): void;
2432
2445
  /**
2446
+ * @deprecated in version 12.1.0. Use the corresponding method exposed by the `igx-paginator`
2447
+ *
2433
2448
  * Goes to the previous page, if the grid is not already at the first page.
2434
2449
  *
2435
- * @deprecated in version 12.1.0
2436
2450
  * @example
2437
2451
  * ```typescript
2438
2452
  * this.grid1.previousPage();
@@ -2452,9 +2466,10 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2452
2466
  get totalRecords(): number;
2453
2467
  set totalRecords(total: number);
2454
2468
  /**
2469
+ * @deprecated in version 12.1.0. Use the corresponding property exposed by the `igx-paginator`
2470
+ *
2455
2471
  * Returns if the current page is the last page.
2456
2472
  *
2457
- * @deprecated in version 12.1.0
2458
2473
  * @example
2459
2474
  * ```typescript
2460
2475
  * const lastPage = this.grid.isLastPage;
@@ -2495,6 +2510,8 @@ export declare abstract class IgxGridBaseDirective extends DisplayDensityBase im
2495
2510
  */
2496
2511
  moveColumn(column: IgxColumnComponent, target: IgxColumnComponent, pos?: DropPosition): void;
2497
2512
  /**
2513
+ * @deprecated in version 12.1.0. Use the corresponding method exposed by the `igx-paginator`
2514
+ *
2498
2515
  * Goes to the desired page index.
2499
2516
  *
2500
2517
  * @example
@@ -38,14 +38,13 @@ declare abstract class BaseRow implements RowType {
38
38
  */
39
39
  get data(): any;
40
40
  /**
41
- * @deprecated Use 'data' instead.
41
+ * @deprecated Use 'data' instead
42
42
  *
43
43
  * The data record that populates the row
44
44
  */
45
45
  get rowData(): any;
46
46
  /**
47
- * @deprecated Use 'key' instead.
48
- *
47
+ * @deprecated Use 'key' instead
49
48
  */
50
49
  get rowID(): any;
51
50
  /**
@@ -149,7 +149,8 @@ export declare class IgxHierarchicalGridComponent extends IgxHierarchicalGridBas
149
149
  */
150
150
  get expandChildren(): boolean;
151
151
  /**
152
- * @deprecated
152
+ * @deprecated in version 12.1.0. Use `getCellByColumn` or `getCellByKey` instead
153
+ *
153
154
  * Returns a `CellType` object that matches the conditions.
154
155
  *
155
156
  * @example
@@ -271,7 +271,8 @@ export declare class IgxTreeGridComponent extends IgxGridBaseDirective implement
271
271
  private get _gridAPI();
272
272
  constructor(selectionService: IgxGridSelectionService, colResizingService: IgxColumnResizingService, gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>, transactionFactory: IgxHierarchicalTransactionFactory, _elementRef: ElementRef<HTMLElement>, _zone: NgZone, document: any, cdr: ChangeDetectorRef, resolver: ComponentFactoryResolver, differs: IterableDiffers, viewRef: ViewContainerRef, navigation: IgxGridNavigationService, filteringService: IgxFilteringService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, _displayDensityOptions: IDisplayDensityOptions, localeId: string, platform: PlatformUtil, _diTransactions?: HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>);
273
273
  /**
274
- * @deprecated
274
+ * @deprecated in version 12.1.0. Use `getCellByColumn` or `getCellByKey` instead
275
+ *
275
276
  * Returns a `CellType` object that matches the conditions.
276
277
  *
277
278
  * @example
@@ -67,9 +67,9 @@ export declare class IgxIconComponent implements OnInit, OnDestroy {
67
67
  */
68
68
  active: boolean;
69
69
  /**
70
- * An @Input property that allows you to change the `color` of the icon.
70
+ * @deprecated in version 11.1.0. `color` is deprecated
71
71
  *
72
- * * @deprecated
72
+ * An @Input property that allows you to change the `color` of the icon.
73
73
  *
74
74
  * @example
75
75
  * ```html
@@ -54,7 +54,8 @@ export interface OutOfViewPort {
54
54
  }
55
55
  export interface PositionSettings {
56
56
  /**
57
- * @deprecated Set the target point/element in the overlay settings instead.
57
+ * @deprecated in version 10.2.0. Set the target point/element in the overlay settings instead
58
+ *
58
59
  * Attaching target for the component to show
59
60
  */
60
61
  target?: Point | HTMLElement;