From b6f9d66b81e033451eb2a7caff9497a00bdd4948 Mon Sep 17 00:00:00 2001 From: Miles Malerba Date: Tue, 6 Sep 2022 19:04:22 +0000 Subject: [PATCH] fix(material/legacy-paginator): deprecate all ts symbols --- .../legacy-paginator/paginator-module.ts | 4 +++ src/material/legacy-paginator/paginator.ts | 14 +++++++-- src/material/legacy-paginator/public-api.ts | 29 +++++++++++++++++++ .../testing/paginator-harness.ts | 6 +++- .../legacy-paginator/testing/public-api.ts | 9 ++++++ .../material/legacy-paginator-testing.md | 2 +- .../material/legacy-paginator.md | 8 ++--- 7 files changed, 64 insertions(+), 8 deletions(-) diff --git a/src/material/legacy-paginator/paginator-module.ts b/src/material/legacy-paginator/paginator-module.ts index 49c6e30c1b31..3c84ee56ccc1 100644 --- a/src/material/legacy-paginator/paginator-module.ts +++ b/src/material/legacy-paginator/paginator-module.ts @@ -15,6 +15,10 @@ import {MatLegacyTooltipModule} from '@angular/material/legacy-tooltip'; import {MatLegacyPaginator} from './paginator'; import {MAT_PAGINATOR_INTL_PROVIDER} from '@angular/material/paginator'; +/** + * @deprecated Use `MatPaginatorModule` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ @NgModule({ imports: [ CommonModule, diff --git a/src/material/legacy-paginator/paginator.ts b/src/material/legacy-paginator/paginator.ts index ef6130bc75a2..41e293f4b5d5 100644 --- a/src/material/legacy-paginator/paginator.ts +++ b/src/material/legacy-paginator/paginator.ts @@ -18,7 +18,11 @@ import { import {MatLegacyFormFieldAppearance} from '@angular/material/legacy-form-field'; import {_MatPaginatorBase, MatPaginatorIntl} from '@angular/material/paginator'; -/** Object that can be used to configure the default options for the paginator module. */ +/** + * Object that can be used to configure the default options for the paginator module. + * @deprecated Use `MatPaginatorDefaultOptions` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ export interface MatLegacyPaginatorDefaultOptions { /** Number of items to display on a page. By default set to 50. */ pageSize?: number; @@ -36,7 +40,11 @@ export interface MatLegacyPaginatorDefaultOptions { formFieldAppearance?: MatLegacyFormFieldAppearance; } -/** Injection token that can be used to provide the default options for the paginator module. */ +/** + * Injection token that can be used to provide the default options for the paginator module. + * @deprecated Use `MAT_PAGINATOR_DEFAULT_OPTIONS` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ export const MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS = new InjectionToken('MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS'); @@ -44,6 +52,8 @@ export const MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS = * Component to provide navigation between paged information. Displays the size of the current * page, user-selectable options to change that size, what items are being shown, and * navigational button to go to the previous or next page. + * @deprecated Use `MatPaginator` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 */ @Component({ selector: 'mat-paginator', diff --git a/src/material/legacy-paginator/public-api.ts b/src/material/legacy-paginator/public-api.ts index 84c7867d5490..ff069074f7b3 100644 --- a/src/material/legacy-paginator/public-api.ts +++ b/src/material/legacy-paginator/public-api.ts @@ -13,10 +13,39 @@ export { MatLegacyPaginator, } from './paginator'; export { + /** + * @deprecated Use `MatPaginatorIntl` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ MatPaginatorIntl as MatLegacyPaginatorIntl, + + /** + * @deprecated Use `MAT_PAGINATOR_INTL_PROVIDER_FACTORY` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ MAT_PAGINATOR_INTL_PROVIDER_FACTORY as MAT_LEGACY_PAGINATOR_INTL_PROVIDER_FACTORY, + + /** + * @deprecated Use `MAT_PAGINATOR_INTL_PROVIDER` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ MAT_PAGINATOR_INTL_PROVIDER as MAT_LEGACY_PAGINATOR_INTL_PROVIDER, + + /** + * @deprecated Use `PageEvent` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ PageEvent as LegacyPageEvent, + + /** + * @deprecated Use `MatPaginatorSelectConfig` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ MatPaginatorSelectConfig as MatLegacyPaginatorSelectConfig, + + /** + * @deprecated Use `_MatPaginatorBase` from `@angular/material/paginator` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ _MatPaginatorBase as _MatLegacyPaginatorBase, } from '@angular/material/paginator'; diff --git a/src/material/legacy-paginator/testing/paginator-harness.ts b/src/material/legacy-paginator/testing/paginator-harness.ts index 2692ea4d1628..260d95502985 100644 --- a/src/material/legacy-paginator/testing/paginator-harness.ts +++ b/src/material/legacy-paginator/testing/paginator-harness.ts @@ -13,7 +13,11 @@ import { PaginatorHarnessFilters, } from '@angular/material/paginator/testing'; -/** Harness for interacting with a standard mat-paginator in tests. */ +/** + * Harness for interacting with a standard mat-paginator in tests. + * @deprecated Use `MatPaginatorHarness` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ export class MatLegacyPaginatorHarness extends _MatPaginatorHarnessBase { /** Selector used to find paginator instances. */ static hostSelector = '.mat-paginator'; diff --git a/src/material/legacy-paginator/testing/public-api.ts b/src/material/legacy-paginator/testing/public-api.ts index 0b8a2e82015e..b12b61505e30 100644 --- a/src/material/legacy-paginator/testing/public-api.ts +++ b/src/material/legacy-paginator/testing/public-api.ts @@ -8,6 +8,15 @@ export {MatLegacyPaginatorHarness} from './paginator-harness'; export { + /** + * @deprecated Use `_MatPaginatorHarnessBase` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ _MatPaginatorHarnessBase as _MatLegacyPaginatorHarnessBase, + + /** + * @deprecated Use `PaginatorHarnessFilters` from `@angular/material/paginator/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating. + * @breaking-change 17.0.0 + */ PaginatorHarnessFilters as LegacyPaginatorHarnessFilters, } from '@angular/material/paginator/testing'; diff --git a/tools/public_api_guard/material/legacy-paginator-testing.md b/tools/public_api_guard/material/legacy-paginator-testing.md index 539266ad5737..771a026d0dea 100644 --- a/tools/public_api_guard/material/legacy-paginator-testing.md +++ b/tools/public_api_guard/material/legacy-paginator-testing.md @@ -13,7 +13,7 @@ import { TestElement } from '@angular/cdk/testing'; export { LegacyPaginatorHarnessFilters } -// @public +// @public @deprecated export class MatLegacyPaginatorHarness extends _MatLegacyPaginatorHarnessBase { // (undocumented) protected _firstPageButton: AsyncFactoryFn; diff --git a/tools/public_api_guard/material/legacy-paginator.md b/tools/public_api_guard/material/legacy-paginator.md index 57264173884e..a72b12d40ab1 100644 --- a/tools/public_api_guard/material/legacy-paginator.md +++ b/tools/public_api_guard/material/legacy-paginator.md @@ -22,14 +22,14 @@ import { MatPaginatorSelectConfig as MatLegacyPaginatorSelectConfig } from '@ang export { LegacyPageEvent } -// @public +// @public @deprecated export const MAT_LEGACY_PAGINATOR_DEFAULT_OPTIONS: InjectionToken; export { MAT_LEGACY_PAGINATOR_INTL_PROVIDER } export { MAT_LEGACY_PAGINATOR_INTL_PROVIDER_FACTORY } -// @public +// @public @deprecated export class MatLegacyPaginator extends _MatLegacyPaginatorBase { constructor(intl: MatLegacyPaginatorIntl, changeDetectorRef: ChangeDetectorRef, defaults?: MatLegacyPaginatorDefaultOptions); _formFieldAppearance?: MatLegacyFormFieldAppearance; @@ -41,7 +41,7 @@ export class MatLegacyPaginator extends _MatLegacyPaginatorBase;