fix(material/legacy-menu): deprecate all ts symbols

angular · Sep 7, 2022 · 4e56db6 · 4e56db6
1 parent e67e493
commit 4e56db6
Show file tree

Hide file tree

Showing 10 changed files with 98 additions and 11 deletions.
diff --git a/src/material/legacy-menu/menu-content.ts b/src/material/legacy-menu/menu-content.ts
@@ -11,6 +11,8 @@ import {MAT_MENU_CONTENT, _MatMenuContentBase} from '@angular/material/menu';
 
 /**
  * Menu content that will be rendered lazily once the menu is opened.
+ * @deprecated Use `MatMenuContent` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: 'ng-template[matMenuContent]',

diff --git a/src/material/legacy-menu/menu-item.ts b/src/material/legacy-menu/menu-item.ts
@@ -11,6 +11,8 @@ import {MatMenuItem as BaseMatMenuItem} from '@angular/material/menu';
 
 /**
  * Single item inside of a `mat-menu`. Provides the menu item styling and accessibility treatment.
+ * @deprecated Use `MatMenuItem` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Component({
   selector: '[mat-menu-item]',

diff --git a/src/material/legacy-menu/menu-module.ts b/src/material/legacy-menu/menu-module.ts
@@ -17,6 +17,10 @@ import {MatLegacyMenuContent} from './menu-content';
 import {MatLegacyMenuItem} from './menu-item';
 import {MatLegacyMenuTrigger} from './menu-trigger';
 
+/**
+ * @deprecated Use `MatMenuModule` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @NgModule({
   imports: [CommonModule, MatCommonModule, MatRippleModule, OverlayModule],
   exports: [

diff --git a/src/material/legacy-menu/menu-trigger.ts b/src/material/legacy-menu/menu-trigger.ts
@@ -11,7 +11,11 @@ import {_MatMenuTriggerBase} from '@angular/material/menu';
 
 // TODO(andrewseguin): Remove the kebab versions in favor of camelCased attribute selectors
 
-/** Directive applied to an element that should trigger a `mat-menu`. */
+/**
+ * Directive applied to an element that should trigger a `mat-menu`.
+ * @deprecated Use `MatMenuTrigger` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Directive({
   selector: `[mat-menu-trigger-for], [matMenuTriggerFor]`,
   host: {

diff --git a/src/material/legacy-menu/menu.ts b/src/material/legacy-menu/menu.ts
@@ -23,7 +23,11 @@ import {
   MatMenuDefaultOptions,
 } from '@angular/material/menu';
 
-/** @docs-public MatMenu */
+/**
+ * @docs-public MatMenu
+ * @deprecated Use `MatMenu` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Component({
   selector: 'mat-menu',
   templateUrl: 'menu.html',

diff --git a/src/material/legacy-menu/public-api.ts b/src/material/legacy-menu/public-api.ts
@@ -13,15 +13,69 @@ export {MatLegacyMenuModule} from './menu-module';
 export {MatLegacyMenuContent} from './menu-content';
 
 export {
+  /**
+   * @deprecated Use `fadeInItems` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   fadeInItems as fadeInLegacyItems,
+
+  /**
+   * @deprecated Use `MAT_MENU_DEFAULT_OPTIONS` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MAT_MENU_DEFAULT_OPTIONS as MAT_LEGACY_MENU_DEFAULT_OPTIONS,
+
+  /**
+   * @deprecated Use `MAT_MENU_PANEL` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MAT_MENU_PANEL as MAT_LEGACY_MENU_PANEL,
+
+  /**
+   * @deprecated Use `MAT_MENU_SCROLL_STRATEGY` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MAT_MENU_SCROLL_STRATEGY as MAT_LEGACY_MENU_SCROLL_STRATEGY,
+
+  /**
+   * @deprecated Use `matMenuAnimations` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   matMenuAnimations as matLegacyMenuAnimations,
+
+  /**
+   * @deprecated Use `MatMenuDefaultOptions` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatMenuDefaultOptions as MatLegacyMenuDefaultOptions,
+
+  /**
+   * @deprecated Use `MatMenuPanel` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatMenuPanel as MatLegacyMenuPanel,
+
+  /**
+   * @deprecated Use `MenuPositionX` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MenuPositionX as LegacyMenuPositionX,
+
+  /**
+   * @deprecated Use `MenuPositionY` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MenuPositionY as LegacyMenuPositionY,
+
+  /**
+   * @deprecated Use `transformMenu` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   transformMenu as transformLegacyMenu,
+
+  /**
+   * @deprecated Use `MAT_MENU_CONTENT` from `@angular/material/menu` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MAT_MENU_CONTENT as MAT_LEGACY_MENU_CONTENT,
 } from '@angular/material/menu';
diff --git a/src/material/legacy-menu/testing/menu-harness.ts b/src/material/legacy-menu/testing/menu-harness.ts
@@ -14,7 +14,11 @@ import {
   _MatMenuItemHarnessBase,
 } from '@angular/material/menu/testing';
 
-/** Harness for interacting with a standard mat-menu in tests. */
+/**
+ * Harness for interacting with a standard mat-menu in tests.
+ * @deprecated Use `MatMenuHarness` from `@angular/material/menu/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyMenuHarness extends _MatMenuHarnessBase<
   typeof MatLegacyMenuItemHarness,
   MatLegacyMenuItemHarness,
@@ -39,7 +43,11 @@ export class MatLegacyMenuHarness extends _MatMenuHarnessBase<
   }
 }
 
-/** Harness for interacting with a standard mat-menu-item in tests. */
+/**
+ * Harness for interacting with a standard mat-menu-item in tests.
+ * @deprecated Use `MatMenuItemHarness` from `@angular/material/menu/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyMenuItemHarness extends _MatMenuItemHarnessBase<
   typeof MatLegacyMenuHarness,
   MatLegacyMenuHarness

diff --git a/src/material/legacy-menu/testing/public-api.ts b/src/material/legacy-menu/testing/public-api.ts
@@ -8,6 +8,15 @@
 
 export {MatLegacyMenuHarness, MatLegacyMenuItemHarness} from './menu-harness';
 export {
+  /**
+   * @deprecated Use `MenuHarnessFilters` from `@angular/material/menu/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MenuHarnessFilters as LegacyMenuHarnessFilters,
+
+  /**
+   * @deprecated Use `MenuItemHarnessFilters` from `@angular/material/menu/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MenuItemHarnessFilters as LegacyMenuItemHarnessFilters,
 } from '@angular/material/menu/testing';
diff --git a/tools/public_api_guard/material/legacy-menu-testing.md b/tools/public_api_guard/material/legacy-menu-testing.md
@@ -14,15 +14,15 @@ export { LegacyMenuHarnessFilters }
 
 export { LegacyMenuItemHarnessFilters }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenuHarness extends _MatMenuHarnessBase<typeof MatLegacyMenuItemHarness, MatLegacyMenuItemHarness, LegacyMenuItemHarnessFilters> {
     static hostSelector: string;
     // (undocumented)
     protected _itemClass: typeof MatLegacyMenuItemHarness;
     static with(options?: LegacyMenuHarnessFilters): HarnessPredicate<MatLegacyMenuHarness>;
 }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenuItemHarness extends _MatMenuItemHarnessBase<typeof MatLegacyMenuHarness, MatLegacyMenuHarness> {
     static hostSelector: string;
     // (undocumented)

diff --git a/tools/public_api_guard/material/legacy-menu.md b/tools/public_api_guard/material/legacy-menu.md
@@ -41,7 +41,7 @@ export { MAT_LEGACY_MENU_PANEL }
 
 export { MAT_LEGACY_MENU_SCROLL_STRATEGY }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenu extends _MatMenuBase {
     // @deprecated
     constructor(elementRef: ElementRef<HTMLElement>, ngZone: NgZone, defaultOptions: MatLegacyMenuDefaultOptions);
@@ -57,7 +57,7 @@ export class MatLegacyMenu extends _MatMenuBase {
 
 export { matLegacyMenuAnimations }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenuContent extends _MatMenuContentBase {
     // (undocumented)
     static ɵdir: i0.ɵɵDirectiveDeclaration<MatLegacyMenuContent, "ng-template[matMenuContent]", never, {}, {}, never, never, false>;
@@ -67,15 +67,15 @@ export class MatLegacyMenuContent extends _MatMenuContentBase {
 
 export { MatLegacyMenuDefaultOptions }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenuItem extends MatMenuItem {
     // (undocumented)
     static ɵcmp: i0.ɵɵComponentDeclaration<MatLegacyMenuItem, "[mat-menu-item]", ["matMenuItem"], { "disabled": "disabled"; "disableRipple": "disableRipple"; }, {}, never, ["*"], false>;
     // (undocumented)
     static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyMenuItem, never>;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export class MatLegacyMenuModule {
     // (undocumented)
     static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyMenuModule, never>;
@@ -87,7 +87,7 @@ export class MatLegacyMenuModule {
 
 export { MatLegacyMenuPanel }
 
-// @public
+// @public @deprecated
 export class MatLegacyMenuTrigger extends _MatMenuTriggerBase {
     // (undocumented)
     static ɵdir: i0.ɵɵDirectiveDeclaration<MatLegacyMenuTrigger, "[mat-menu-trigger-for], [matMenuTriggerFor]", ["matMenuTrigger"], {}, {}, never, never, false>;