Skip to content

Commit 329dc1c

Browse files
committed
chore(*): Add deprication config
1 parent dd8d43b commit 329dc1c

File tree

2 files changed

+85
-61
lines changed

2 files changed

+85
-61
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,10 @@ describe('IgxPaginator with custom settings', () => {
146146
const fix = TestBed.createComponent(CustomizedPaginatorComponent);
147147
fix.detectChanges();
148148
const paginator = fix.componentInstance.paginator;
149-
const selectLabel = paginator.selectLabel;
149+
paginator.resourceStrings.igx_paginator_label = 'Per page';
150150

151-
expect(selectLabel).toEqual('Per page');
151+
fix.detectChanges();
152+
expect(paginator.resourceStrings.igx_paginator_label).toEqual('Per page');
152153
});
153154

154155
it('should disable the dropdown and pager buttons if set to false through input', () => {
@@ -189,7 +190,6 @@ export class DefaultPaginatorComponent {
189190
}
190191
@Component({
191192
template: `<igx-paginator
192-
[selectLabel]="'Per page'"
193193
[totalRecords]="25"
194194
[selectOptions]="[3,10,25,40]"
195195
[perPage]="7"

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

Lines changed: 82 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { IgxButtonModule } from '../directives/button/button.directive';
99
import { IgxRippleModule } from '../directives/ripple/ripple.directive';
1010
import { IgxInputGroupModule } from '../input-group';
1111
import { IPaginatorResourceStrings } from '../core/i18n/paginator-resources';
12+
import { DeprecateProperty } from '../core/deprecateDecorators';
1213

1314
@Component({
1415
selector: 'igx-paginator',
@@ -46,14 +47,14 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
4647
return this.displayDensity === DisplayDensity.comfortable;
4748
}
4849

49-
/**
50-
* An @Input property, sets current page of the `IgxPaginatorComponent`.
51-
* The default is 0.
52-
* ```typescript
53-
* let page = this.paginator.page;
54-
* ```
55-
* @memberof IgxPaginatorComponent
56-
*/
50+
/**
51+
* An @Input property, sets current page of the `IgxPaginatorComponent`.
52+
* The default is 0.
53+
* ```typescript
54+
* let page = this.paginator.page;
55+
* ```
56+
* @memberof IgxPaginatorComponent
57+
*/
5758
@Input()
5859
public get page() {
5960
return this._page;
@@ -64,14 +65,14 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
6465
this.pageChange.emit(this._page);
6566
}
6667

67-
/**
68-
* An @Input property, sets number of visible items per page in the `IgxPaginatorComponent`.
69-
* The default is 15.
70-
* ```typescript
71-
* let itemsPerPage = this.paginator.perPage;
72-
* ```
73-
* @memberof IgxPaginatorComponent
74-
*/
68+
/**
69+
* An @Input property, sets number of visible items per page in the `IgxPaginatorComponent`.
70+
* The default is 15.
71+
* ```typescript
72+
* let itemsPerPage = this.paginator.perPage;
73+
* ```
74+
* @memberof IgxPaginatorComponent
75+
*/
7576
@Input()
7677
public get perPage() {
7778
return this._perPage;
@@ -87,13 +88,13 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
8788
}
8889
}
8990

90-
/**
91-
* An @Input property that sets the total records.
92-
* ```typescript
93-
* let totalRecords = this.paginator.totalRecords;
94-
* ```
95-
* @memberof IgxPaginatorComponent
96-
*/
91+
/**
92+
* An @Input property that sets the total records.
93+
* ```typescript
94+
* let totalRecords = this.paginator.totalRecords;
95+
* ```
96+
* @memberof IgxPaginatorComponent
97+
*/
9798
@Input()
9899
public get totalRecords() {
99100
return this._totalRecords;
@@ -104,13 +105,13 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
104105
this.totalPages = Math.ceil(this.totalRecords / this.perPage);
105106
}
106107

107-
/**
108-
* An @Input property that sets custom options in the select of the paginator
109-
* ```typescript
110-
* let options = this.paginator.selectOptions;
111-
* ```
112-
* @memberof IgxPaginatorComponent
113-
*/
108+
/**
109+
* An @Input property that sets custom options in the select of the paginator
110+
* ```typescript
111+
* let options = this.paginator.selectOptions;
112+
* ```
113+
* @memberof IgxPaginatorComponent
114+
*/
114115
@Input()
115116
public get selectOptions() {
116117
return this._selectOptions;
@@ -121,43 +122,43 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
121122
this.defaultSelectValues = [...value];
122123
}
123124

124-
/**
125-
* An @Input property that sets if the pager in the paginator should be enabled.
126-
* ```html
127-
* <igx-paginator [pagerEnabled]="true"></igx-paginator>
128-
* ```
129-
* @memberof IgxPaginatorComponent
130-
*/
125+
/**
126+
* An @Input property that sets if the pager in the paginator should be enabled.
127+
* ```html
128+
* <igx-paginator [pagerEnabled]="true"></igx-paginator>
129+
* ```
130+
* @memberof IgxPaginatorComponent
131+
*/
131132
@Input()
132133
public pagerEnabled = true;
133134

134-
/**
135-
* An @Input property that sets if the pager in the paginator should be hidden.
136-
* ```html
137-
* <igx-paginator [pagerHidden]="true"></igx-paginator>
138-
* ```
139-
* @memberof IgxPaginatorComponent
140-
*/
135+
/**
136+
* An @Input property that sets if the pager in the paginator should be hidden.
137+
* ```html
138+
* <igx-paginator [pagerHidden]="true"></igx-paginator>
139+
* ```
140+
* @memberof IgxPaginatorComponent
141+
*/
141142
@Input()
142143
public pagerHidden = false;
143144

144-
/**
145-
* An @Input property that sets if the dropdown in the paginator should be enabled.
146-
* ```html
147-
* <igx-paginator [dropdownEnabled]="true"></igx-paginator>
148-
* ```
149-
* @memberof IgxPaginatorComponent
150-
*/
145+
/**
146+
* An @Input property that sets if the dropdown in the paginator should be enabled.
147+
* ```html
148+
* <igx-paginator [dropdownEnabled]="true"></igx-paginator>
149+
* ```
150+
* @memberof IgxPaginatorComponent
151+
*/
151152
@Input()
152153
public dropdownEnabled = true;
153154

154-
/**
155-
* An @Input property that sets if the dropdown in the paginator should be hidden.
156-
* ```html
157-
* <igx-paginator [dropdownHidden]="true"></igx-paginator>
158-
* ```
159-
* @memberof IgxPaginatorComponent
160-
*/
155+
/**
156+
* An @Input property that sets if the dropdown in the paginator should be hidden.
157+
* ```html
158+
* <igx-paginator [dropdownHidden]="true"></igx-paginator>
159+
* ```
160+
* @memberof IgxPaginatorComponent
161+
*/
161162
@Input()
162163
public dropdownHidden = false;
163164

@@ -177,6 +178,29 @@ export class IgxPaginatorComponent extends DisplayDensityBase {
177178
return this._resourceStrings;
178179
}
179180

181+
/**
182+
* @deprecated Use 'resourceStrings' instead.
183+
* An @Input property, sets number of label of the select.
184+
* The default is 'Items per page' localized string.
185+
* ```html
186+
* <igx-paginator label="My custom label"></igx-paginator>
187+
* ```
188+
* @memberof IgxPaginatorComponent
189+
*/
190+
@DeprecateProperty(`'selectLabel' property is deprecated. Use 'resourceStrings' instead.`)
191+
@Input()
192+
public selectLabel = CurrentResourceStrings.PaginatorResStrings.igx_paginator_label;
193+
194+
/**
195+
* @deprecated Use 'resourceStrings' instead.
196+
* An @Input property, sets a preposition between the current page and total pages.
197+
* The default is 'of' localized string.
198+
* @memberof IgxPaginatorComponent
199+
*/
200+
@DeprecateProperty(`'prepositionPage' property is deprecated. Use 'resourceStrings' instead.`)
201+
@Input()
202+
public prepositionPage = CurrentResourceStrings.PaginatorResStrings.igx_paginator_pager_text;
203+
180204
/**
181205
* An event that is emitted when the select in the `IgxPaginatorComponent` changes its value.
182206
*/

0 commit comments

Comments
 (0)