Merge pull request #8976 from IgniteUI/enrich-deprecation-msgs-m

handle deprecation messages for paging

Author: zdrawku

projects/igniteui-angular/src/lib/grids/grid-base.directive.ts

@@ -168,6 +168,7 @@ const MIN_ROW_EDITING_COUNT_THRESHOLD = 2;
 
 export const IgxGridTransaction = new InjectionToken<string>('IgxGridTransaction');
 
+
 @Directive()
 export abstract class IgxGridBaseDirective extends DisplayDensityBase implements GridType,
     OnInit, DoCheck, OnDestroy, AfterContentInit, AfterViewInit {
@@ -289,10 +290,13 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     @Output()
     public onScroll = new EventEmitter<IGridScrollEventArgs>();
 
+    /* eslint-disable max-len */
     /**
-     * @deprecated Use `IgxPaginator` corresponding output instead.
      * Emitted after the current page is changed.
      *
+     * @deprecated `pageChange` is deprecated. Use the `pageChange` output exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```html
      * <igx-grid (pageChange)="onPageChange($event)"></igx-grid>
@@ -303,14 +307,16 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
      * }
      * ```
      */
-    @DeprecateProperty('Use the corresponding output exposed by the `igx-paginator`.')
+    @DeprecateProperty('`pageChange` is deprecated. Use the `pageChange` output exposed by the `IgxPaginator`.')
     @Output()
     public pageChange = new EventEmitter<number>();
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding output instead.
      * Emitted when `perPage` property value of the grid is changed.
      *
+     * @deprecated `perPageChange` is deprecated. Use the `perPageChange` output exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```html
      * <igx-grid #grid (perPageChange)="onPerPageChange($event)" [autoGenerate]="true"></igx-grid>
@@ -321,9 +327,10 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
      * }
      * ```
      */
-    @DeprecateProperty('Use the corresponding output exposed by the `igx-paginator`.')
+    @DeprecateProperty('`perPageChange` is deprecated. Use the `perPageChange` output exposed by the `IgxPaginator`.')
     @Output()
     public perPageChange = new EventEmitter<number>();
+    /* eslint-enable max-len */
 
     /**
      * Gets/Sets a custom `ng-template` for the pagination UI of the grid.
@@ -1421,18 +1428,21 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
         this.notifyChanges(true);
     }
 
+    /* eslint-disable max-len */
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Gets/Sets the current page index.
      *
+     * @deprecated `page` is deprecated. Use the `page` input exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```html
      *  <igx-grid #grid [data]="Data" [paging]="true" [(page)]="model.page" [autoGenerate]="true"></igx-grid>
      * ```
      * @remarks
      * Supports two-way binding.
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    @DeprecateProperty('`page` is deprecated. Use the `page` input exposed by the `IgxPaginator`.')
     @Input()
     public get page(): number {
         return this._page;
@@ -1450,17 +1460,20 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     }
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Gets/Sets the number of visible items per page.
      *
+     * @deprecated `perPage` is deprecated. Use the `perPage` input exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @remarks
      * The default is 15.
      * @example
      * ```html
      * <igx-grid #grid [data]="Data" [paging]="true" [(perPage)]="model.perPage" [autoGenerate]="true"></igx-grid>
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    /* eslint-enable max-len */
+    @DeprecateProperty('`perPage` is deprecated. Use the `perPage` input exposed by the `IgxPaginator`.')
     @Input()
     public get perPage(): number {
         return this._perPage;
@@ -3089,17 +3102,20 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
         this.cdr.detach();
     }
 
+    /* eslint-disable max-len */
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Goes to the desired page index.
      *
+     * @deprecated `paginate` is deprecated. Use the `paginate` method exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * this.grid1.paginate(1);
      * ```
      * @param val
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    @DeprecateProperty('`paginate` is deprecated. Use the `paginate` method exposed by the `IgxPaginator`.')
     public paginate(val: number): void {
         if (val < 0 || val > this.totalPages - 1) {
             return;
@@ -3109,31 +3125,36 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     }
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Goes to the next page, if the grid is not already at the last page.
      *
+     * @deprecated `nextPage` is deprecated. Use the `nextPage` method exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * this.grid1.nextPage();
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    @DeprecateProperty('`nextPage` is deprecated. Use the `nextPage` method exposed by the `IgxPaginator`.')
     public nextPage(): void {
         if (!this.isLastPage) {
             this.page += 1;
         }
     }
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Goes to the previous page, if the grid is not already at the first page.
      *
+     * @deprecated `previousPage` is deprecated. Use the `previousPage` method exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * this.grid1.previousPage();
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    /* eslint-enable max-len */
+    @DeprecateProperty('`previousPage` is deprecated. Use the `previousPage` method exposed by the `IgxPaginator`.')
     public previousPage(): void {
         if (!this.isFirstPage) {
             this.page -= 1;
@@ -4170,16 +4191,19 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
         return this.gridAPI.get_cell_by_key(rowSelector, columnField);
     }
 
+    /* eslint-disable max-len */
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Gets the total number of pages.
      *
+     * @deprecated `totalPages` is deprecated. Use the `totalPages` getter exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * const totalPages = this.grid.totalPages;
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    @DeprecateProperty('`totalPages` is deprecated. Use the `totalPages` getter exposed by the `IgxPaginator`.')
     public get totalPages(): number {
         if (this.pagingState) {
             return this.pagingState.metadata.countPages;
@@ -4188,15 +4212,17 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     }
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Gets if the current page is the first page.
      *
+     * @deprecated `isFirstPage` is deprecated. Use the `isFirstPage` getter exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * const firstPage = this.grid.isFirstPage;
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    @DeprecateProperty('`isFirstPage` is deprecated. Use the `isFirstPage` getter exposed by the `IgxPaginator`.')
     public get isFirstPage(): boolean {
         return this.page === 0;
     }
@@ -4225,15 +4251,18 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     }
 
     /**
-     * @deprecated Use `IgxPaginator` corresponding method instead.
      * Returns if the current page is the last page.
      *
+     * @deprecated `isLastPage` is deprecated. Use the `isLastPage` output exposed by the `IgxPaginator`.
+     * See [Paging with custom template](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/remote-data-operations#remote-paging-with-custom-template) for more info.
+     *
      * @example
      * ```typescript
      * const lastPage = this.grid.isLastPage;
      * ```
      */
-    @DeprecateProperty('Use the corresponding method exposed by the `igx-paginator`.')
+    /* eslint-enable max-len */
+    @DeprecateProperty('`isLastPage` is deprecated. Use the `isLastPage` getter exposed by the `IgxPaginator`.')
     public get isLastPage(): boolean {
         return this.page + 1 >= this.totalPages;
     }