Skip to content

Commit 10cddd2

Browse files
committed
docs(grid): Expose paging event emitters #7229
1 parent 44b2675 commit 10cddd2

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

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

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,16 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
456456
}
457457

458458
/**
459-
* @hidden @internal
459+
* Emitted after the current page is changed.
460+
* @example
461+
* ```html
462+
* <igx-grid (pageChange)="onPageChange($event)"></igx-grid>
463+
* ```
464+
* ```typescript
465+
* public onPageChange(page: number) {
466+
* this.currentPage = page;
467+
* }
468+
* ```
460469
*/
461470
@Output()
462471
public pageChange = new EventEmitter<number>();
@@ -488,7 +497,16 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
488497
}
489498

490499
/**
491-
* @hidden @internal
500+
* Emitted when `perPage` property value of the grid is changed.
501+
* @example
502+
* ```html
503+
* <igx-grid #grid (perPageChange)="onPerPageChange($event)" [autoGenerate]="true"></igx-grid>
504+
* ```
505+
* ```typescript
506+
* public onPerPageChange(perPage: number) {
507+
* this.perPage = perPage;
508+
* }
509+
* ```
492510
*/
493511
@Output()
494512
public perPageChange = new EventEmitter<number>();

projects/igniteui-angular/src/lib/paginator/paginator.component.ts

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,31 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
202202
public prepositionPage = CurrentResourceStrings.PaginatorResStrings.igx_paginator_pager_text;
203203

204204
/**
205-
* An event that is emitted when the select in the `IgxPaginatorComponent` changes its value.
205+
* Emitted when `perPage` property value of the paginator is changed.
206+
* @example
207+
* ```html
208+
* <igx-paginator (perPageChange)="onPerPageChange($event)"></igx-paginator>
209+
* ```
210+
* ```typescript
211+
* public onPerPageChange(perPage: number) {
212+
* this.perPage = perPage;
213+
* }
214+
* ```
206215
*/
207216
@Output()
208217
public perPageChange = new EventEmitter<number>();
209218

210219
/**
211-
* An event that is emitted when the paginating is used.
220+
* Emitted after the current page is changed.
221+
* @example
222+
* ```html
223+
* <igx-paginator (pageChange)="onPageChange($event)"></igx-paginator>
224+
* ```
225+
* ```typescript
226+
* public onPageChange(page: number) {
227+
* this.currentPage = page;
228+
* }
229+
* ```
212230
*/
213231
@Output()
214232
public pageChange = new EventEmitter<number>();

0 commit comments

Comments
 (0)