Skip to content

Commit 814b440

Browse files
committed
docs(grid): Expose paging event emitters #7229
1 parent ff96b4d commit 814b440

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

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

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { IgxSelectModule } from '../select/index';
77
import { IgxIconModule } from '../icon/index';
88
import { IgxButtonModule } from '../directives/button/button.directive';
99
import { IgxRippleModule } from '../directives/ripple/ripple.directive';
10+
import { DeprecateProperty } from '../core/deprecateDecorators';
1011

1112
@Component({
1213
selector: 'igx-paginator',
@@ -169,13 +170,41 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
169170
public selectLabel = CurrentResourceStrings.PaginatorResStrings.igx_paginator_label;
170171

171172
/**
172-
*An event that is emitted when the select in the `IgxPaginatorComponent` changes its value.
173-
*/
173+
* @deprecated Use 'resourceStrings' instead.
174+
* An @Input property, sets a preposition between the current page and total pages.
175+
* The default is 'of' localized string.
176+
* @memberof IgxPaginatorComponent
177+
*/
178+
@DeprecateProperty(`'prepositionPage' property is deprecated. Use 'resourceStrings' instead.`)
179+
@Input()
180+
public prepositionPage = CurrentResourceStrings.PaginatorResStrings.igx_paginator_pager_text;
181+
182+
/**
183+
* Emitted when `perPage` property value of the paginator is changed.
184+
* @example
185+
* ```html
186+
* <igx-paginator (perPageChange)="onPerPageChange($event)"></igx-paginator>
187+
* ```
188+
* ```typescript
189+
* public onPerPageChange(perPage: number) {
190+
* this.perPage = perPage;
191+
* }
192+
* ```
193+
*/
174194
@Output()
175195
public perPageChange = new EventEmitter<number>();
176196
/**
177-
*An event that is emitted when the paginating is used.
178-
*/
197+
* Emitted after the current page is changed.
198+
* @example
199+
* ```html
200+
* <igx-paginator (pageChange)="onPageChange($event)"></igx-paginator>
201+
* ```
202+
* ```typescript
203+
* public onPageChange(page: number) {
204+
* this.currentPage = page;
205+
* }
206+
* ```
207+
*/
179208
@Output()
180209
public pageChange = new EventEmitter<number>();
181210

0 commit comments

Comments
 (0)