Skip to content

Commit de5d41b

Browse files
mmalerbammalerba
committed
fix(material/legacy-tooltip): deprecate all ts symbols
1 parent 8fb62e5 commit de5d41b

File tree

8 files changed

+82
-7
lines changed

8 files changed

+82
-7
lines changed

‎src/material/legacy-tooltip/public-api.ts

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,69 @@ export {MatLegacyTooltip, LegacyTooltipComponent} from './tooltip';
1111
export {matLegacyTooltipAnimations} from './tooltip-animations';
1212

1313
export {
14+
/**
15+
* @deprecated Use `getMatTooltipInvalidPositionError` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
16+
* @breaking-change 17.0.0
17+
*/
1418
getMatTooltipInvalidPositionError as getMatLegacyTooltipInvalidPositionError,
19+
20+
/**
21+
* @deprecated Use `MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
22+
* @breaking-change 17.0.0
23+
*/
1524
MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY as MAT_LEGACY_TOOLTIP_SCROLL_STRATEGY_FACTORY,
25+
26+
/**
27+
* @deprecated Use `MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
28+
* @breaking-change 17.0.0
29+
*/
1630
MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY as MAT_LEGACY_TOOLTIP_DEFAULT_OPTIONS_FACTORY,
31+
32+
/**
33+
* @deprecated Use `TooltipPosition` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
34+
* @breaking-change 17.0.0
35+
*/
1736
TooltipPosition as LegacyTooltipPosition,
37+
38+
/**
39+
* @deprecated Use `TooltipTouchGestures` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
40+
* @breaking-change 17.0.0
41+
*/
1842
TooltipTouchGestures as LegacyTooltipTouchGestures,
43+
44+
/**
45+
* @deprecated Use `TooltipVisibility` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
46+
* @breaking-change 17.0.0
47+
*/
1948
TooltipVisibility as LegacyTooltipVisibility,
49+
50+
/**
51+
* @deprecated Use `SCROLL_THROTTLE_MS` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
52+
* @breaking-change 17.0.0
53+
*/
2054
SCROLL_THROTTLE_MS as LEGACY_SCROLL_THROTTLE_MS,
55+
56+
/**
57+
* @deprecated Use `MAT_TOOLTIP_SCROLL_STRATEGY` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
58+
* @breaking-change 17.0.0
59+
*/
2160
MAT_TOOLTIP_SCROLL_STRATEGY as MAT_LEGACY_TOOLTIP_SCROLL_STRATEGY,
61+
62+
/**
63+
* @deprecated Use `MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
64+
* @breaking-change 17.0.0
65+
*/
2266
MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER as MAT_LEGACY_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER,
67+
68+
/**
69+
* @deprecated Use `MatTooltipDefaultOptions` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
70+
* @breaking-change 17.0.0
71+
*/
2372
MatTooltipDefaultOptions as MatLegacyTooltipDefaultOptions,
73+
74+
/**
75+
* @deprecated Use `MAT_TOOLTIP_DEFAULT_OPTIONS` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
76+
* @breaking-change 17.0.0
77+
*/
2478
MAT_TOOLTIP_DEFAULT_OPTIONS as MAT_LEGACY_TOOLTIP_DEFAULT_OPTIONS,
2579
} from '@angular/material/tooltip';

‎src/material/legacy-tooltip/testing/public-api.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@
77
*/
88

99
export {MatLegacyTooltipHarness} from './tooltip-harness';
10-
export {TooltipHarnessFilters as LegacyTooltipHarnessFilters} from '@angular/material/tooltip/testing';
10+
export {
11+
/**
12+
* @deprecated Use `TooltipHarnessFilters` from `@angular/material/tooltip/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
13+
* @breaking-change 17.0.0
14+
*/
15+
TooltipHarnessFilters as LegacyTooltipHarnessFilters,
16+
} from '@angular/material/tooltip/testing';

‎src/material/legacy-tooltip/testing/tooltip-harness.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@
99
import {HarnessPredicate} from '@angular/cdk/testing';
1010
import {_MatTooltipHarnessBase, TooltipHarnessFilters} from '@angular/material/tooltip/testing';
1111

12-
/** Harness for interacting with a standard mat-tooltip in tests. */
12+
/**
13+
* Harness for interacting with a standard mat-tooltip in tests.
14+
* @deprecated Use `MatTooltipHarness` from `@angular/material/tooltip/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
15+
* @breaking-change 17.0.0
16+
*/
1317
export class MatLegacyTooltipHarness extends _MatTooltipHarnessBase {
1418
protected _optionalPanel = this.documentRootLocatorFactory().locatorForOptional('.mat-tooltip');
1519
protected _hiddenClass = 'mat-tooltip-hide';

‎src/material/legacy-tooltip/tooltip-animations.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import {
1818
/**
1919
* Animations used by MatTooltip.
2020
* @docs-private
21+
* @deprecated Use `matTooltipAnimations` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
22+
* @breaking-change 17.0.0
2123
*/
2224
export const matLegacyTooltipAnimations: {
2325
readonly tooltipState: AnimationTriggerMetadata;

‎src/material/legacy-tooltip/tooltip-module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ import {CdkScrollableModule} from '@angular/cdk/scrolling';
1515
import {MatLegacyTooltip, LegacyTooltipComponent} from './tooltip';
1616
import {MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER} from '@angular/material/tooltip';
1717

18+
/**
19+
* @deprecated Use `MatTooltipModule` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
20+
* @breaking-change 17.0.0
21+
*/
1822
@NgModule({
1923
imports: [A11yModule, CommonModule, OverlayModule, MatCommonModule],
2024
exports: [MatLegacyTooltip, LegacyTooltipComponent, MatCommonModule, CdkScrollableModule],

‎src/material/legacy-tooltip/tooltip.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ import {
4040
* hiding of a tooltip provided position (defaults to below the element).
4141
*
4242
* https://material.io/design/components/tooltips.html
43+
*
44+
* @deprecated Use `MatTooltip` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
45+
* @breaking-change 17.0.0
4346
*/
4447
@Directive({
4548
selector: '[matTooltip]',
@@ -85,6 +88,8 @@ export class MatLegacyTooltip extends _MatTooltipBase<LegacyTooltipComponent> {
8588
/**
8689
* Internal component that wraps the tooltip's content.
8790
* @docs-private
91+
* @deprecated Use `TooltipComponent` from `@angular/material/tooltip` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
92+
* @breaking-change 17.0.0
8893
*/
8994
@Component({
9095
selector: 'mat-tooltip-component',

‎tools/public_api_guard/material/legacy-tooltip-testing.md

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

1313
export { LegacyTooltipHarnessFilters }
1414

15-
// @public
15+
// @public @deprecated
1616
export class MatLegacyTooltipHarness extends _MatTooltipHarnessBase {
1717
// (undocumented)
1818
protected _hiddenClass: string;

‎tools/public_api_guard/material/legacy-tooltip.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export { getMatLegacyTooltipInvalidPositionError }
4242

4343
export { LEGACY_SCROLL_THROTTLE_MS }
4444

45-
// @public
45+
// @public @deprecated
4646
export class LegacyTooltipComponent extends _TooltipComponentBase {
4747
constructor(changeDetectorRef: ChangeDetectorRef, _breakpointObserver: BreakpointObserver, animationMode?: string);
4848
// (undocumented)
@@ -74,7 +74,7 @@ export { MAT_LEGACY_TOOLTIP_SCROLL_STRATEGY_FACTORY }
7474

7575
export { MAT_LEGACY_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER }
7676

77-
// @public
77+
// @public @deprecated
7878
export class MatLegacyTooltip extends _MatTooltipBase<LegacyTooltipComponent> {
7979
constructor(overlay: Overlay, elementRef: ElementRef<HTMLElement>, scrollDispatcher: ScrollDispatcher, viewContainerRef: ViewContainerRef, ngZone: NgZone, platform: Platform, ariaDescriber: AriaDescriber, focusMonitor: FocusMonitor, scrollStrategy: any, dir: Directionality, defaultOptions: MatLegacyTooltipDefaultOptions, _document: any);
8080
// (undocumented)
@@ -85,14 +85,14 @@ export class MatLegacyTooltip extends _MatTooltipBase<LegacyTooltipComponent> {
8585
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyTooltip, [null, null, null, null, null, null, null, null, null, { optional: true; }, { optional: true; }, null]>;
8686
}
8787

88-
// @public
88+
// @public @deprecated
8989
export const matLegacyTooltipAnimations: {
9090
readonly tooltipState: AnimationTriggerMetadata;
9191
};
9292

9393
export { MatLegacyTooltipDefaultOptions }
9494

95-
// @public (undocumented)
95+
// @public @deprecated (undocumented)
9696
export class MatLegacyTooltipModule {
9797
// (undocumented)
9898
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyTooltipModule, never>;

0 commit comments

Comments
 (0)