Skip to content

Commit b6f9d66

Browse files
committed
fix(material/legacy-paginator): deprecate all ts symbols
1 parent 4e56db6 commit b6f9d66

File tree

7 files changed

+64
-8
lines changed

7 files changed

+64
-8
lines changed

src/material/legacy-paginator/paginator-module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ import {MatLegacyTooltipModule} from '@angular/material/legacy-tooltip';
1515
import {MatLegacyPaginator} from './paginator';
1616
import {MAT_PAGINATOR_INTL_PROVIDER} from '@angular/material/paginator';
1717

18+
/**
19+
* @deprecated Use `MatPaginatorModule` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
20+
* @breaking-change 17.0.0
21+
*/
1822
@NgModule({
1923
imports: [
2024
CommonModule,

src/material/legacy-paginator/paginator.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ import {
1818
import {MatLegacyFormFieldAppearance} from '@angular/material/legacy-form-field';
1919
import {_MatPaginatorBase, MatPaginatorIntl} from '@angular/material/paginator';
2020

21-
/** Object that can be used to configure the default options for the paginator module. */
21+
/**
22+
* Object that can be used to configure the default options for the paginator module.
23+
* @deprecated Use `MatPaginatorDefaultOptions` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
24+
* @breaking-change 17.0.0
25+
*/
2226
export interface MatLegacyPaginatorDefaultOptions {
2327
/** Number of items to display on a page. By default set to 50. */
2428
pageSize?: number;
@@ -36,14 +40,20 @@ export interface MatLegacyPaginatorDefaultOptions {
3640
formFieldAppearance?: MatLegacyFormFieldAppearance;
3741
}
3842

39-
/** Injection token that can be used to provide the default options for the paginator module. */
43+
/**
44+
* Injection token that can be used to provide the default options for the paginator module.
45+
* @deprecated Use `MAT_PAGINATOR_DEFAULT_OPTIONS` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
46+
* @breaking-change 17.0.0
47+
*/
4048
export const MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS =
4149
new InjectionToken<MatLegacyPaginatorDefaultOptions>('MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS');
4250

4351
/**
4452
* Component to provide navigation between paged information. Displays the size of the current
4553
* page, user-selectable options to change that size, what items are being shown, and
4654
* navigational button to go to the previous or next page.
55+
* @deprecated Use `MatPaginator` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
56+
* @breaking-change 17.0.0
4757
*/
4858
@Component({
4959
selector: 'mat-paginator',

src/material/legacy-paginator/public-api.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,39 @@ export {
1313
MatLegacyPaginator,
1414
} from './paginator';
1515
export {
16+
/**
17+
* @deprecated Use `MatPaginatorIntl` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
18+
* @breaking-change 17.0.0
19+
*/
1620
MatPaginatorIntl as MatLegacyPaginatorIntl,
21+
22+
/**
23+
* @deprecated Use `MAT_PAGINATOR_INTL_PROVIDER_FACTORY` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
24+
* @breaking-change 17.0.0
25+
*/
1726
MAT_PAGINATOR_INTL_PROVIDER_FACTORY as MAT_LEGACY_PAGINATOR_INTL_PROVIDER_FACTORY,
27+
28+
/**
29+
* @deprecated Use `MAT_PAGINATOR_INTL_PROVIDER` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
30+
* @breaking-change 17.0.0
31+
*/
1832
MAT_PAGINATOR_INTL_PROVIDER as MAT_LEGACY_PAGINATOR_INTL_PROVIDER,
33+
34+
/**
35+
* @deprecated Use `PageEvent` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
36+
* @breaking-change 17.0.0
37+
*/
1938
PageEvent as LegacyPageEvent,
39+
40+
/**
41+
* @deprecated Use `MatPaginatorSelectConfig` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
42+
* @breaking-change 17.0.0
43+
*/
2044
MatPaginatorSelectConfig as MatLegacyPaginatorSelectConfig,
45+
46+
/**
47+
* @deprecated Use `_MatPaginatorBase` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
48+
* @breaking-change 17.0.0
49+
*/
2150
_MatPaginatorBase as _MatLegacyPaginatorBase,
2251
} from '@angular/material/paginator';

src/material/legacy-paginator/testing/paginator-harness.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ import {
1313
PaginatorHarnessFilters,
1414
} from '@angular/material/paginator/testing';
1515

16-
/** Harness for interacting with a standard mat-paginator in tests. */
16+
/**
17+
* Harness for interacting with a standard mat-paginator in tests.
18+
* @deprecated Use `MatPaginatorHarness` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
19+
* @breaking-change 17.0.0
20+
*/
1721
export class MatLegacyPaginatorHarness extends _MatPaginatorHarnessBase {
1822
/** Selector used to find paginator instances. */
1923
static hostSelector = '.mat-paginator';

src/material/legacy-paginator/testing/public-api.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88

99
export {MatLegacyPaginatorHarness} from './paginator-harness';
1010
export {
11+
/**
12+
* @deprecated Use `_MatPaginatorHarnessBase` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
13+
* @breaking-change 17.0.0
14+
*/
1115
_MatPaginatorHarnessBase as _MatLegacyPaginatorHarnessBase,
16+
17+
/**
18+
* @deprecated Use `PaginatorHarnessFilters` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
19+
* @breaking-change 17.0.0
20+
*/
1221
PaginatorHarnessFilters as LegacyPaginatorHarnessFilters,
1322
} from '@angular/material/paginator/testing';

tools/public_api_guard/material/legacy-paginator-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { TestElement } from '@angular/cdk/testing';
1313

1414
export { LegacyPaginatorHarnessFilters }
1515

16-
// @public
16+
// @public @deprecated
1717
export class MatLegacyPaginatorHarness extends _MatLegacyPaginatorHarnessBase {
1818
// (undocumented)
1919
protected _firstPageButton: AsyncFactoryFn<TestElement | null>;

tools/public_api_guard/material/legacy-paginator.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ import { MatPaginatorSelectConfig as MatLegacyPaginatorSelectConfig } from '@ang
2222

2323
export { LegacyPageEvent }
2424

25-
// @public
25+
// @public @deprecated
2626
export const MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS: InjectionToken<MatLegacyPaginatorDefaultOptions>;
2727

2828
export { MAT_LEGACY_PAGINATOR_INTL_PROVIDER }
2929

3030
export { MAT_LEGACY_PAGINATOR_INTL_PROVIDER_FACTORY }
3131

32-
// @public
32+
// @public @deprecated
3333
export class MatLegacyPaginator extends _MatLegacyPaginatorBase<MatLegacyPaginatorDefaultOptions> {
3434
constructor(intl: MatLegacyPaginatorIntl, changeDetectorRef: ChangeDetectorRef, defaults?: MatLegacyPaginatorDefaultOptions);
3535
_formFieldAppearance?: MatLegacyFormFieldAppearance;
@@ -41,7 +41,7 @@ export class MatLegacyPaginator extends _MatLegacyPaginatorBase<MatLegacyPaginat
4141

4242
export { _MatLegacyPaginatorBase }
4343

44-
// @public
44+
// @public @deprecated
4545
export interface MatLegacyPaginatorDefaultOptions {
4646
formFieldAppearance?: MatLegacyFormFieldAppearance;
4747
hidePageSize?: boolean;
@@ -52,7 +52,7 @@ export interface MatLegacyPaginatorDefaultOptions {
5252

5353
export { MatLegacyPaginatorIntl }
5454

55-
// @public (undocumented)
55+
// @public @deprecated (undocumented)
5656
export class MatLegacyPaginatorModule {
5757
// (undocumented)
5858
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyPaginatorModule, never>;

0 commit comments

Comments
 (0)