Skip to content

Commit 9fc3051

Browse files
mmalerbammalerba
committed
fix(material/legacy-snack-bar): deprecate all ts symbols
1 parent cfadfc0 commit 9fc3051

File tree

9 files changed

+86
-7
lines changed

9 files changed

+86
-7
lines changed

‎src/material/legacy-snack-bar/public-api.ts

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,75 @@ export {MatLegacySnackBar} from './snack-bar';
1111
export {MatLegacySnackBarContainer} from './snack-bar-container';
1212
export {LegacySimpleSnackBar} from './simple-snack-bar';
1313
export {
14+
/**
15+
* @deprecated Use `MAT_SNACK_BAR_DATA` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
16+
* @breaking-change 17.0.0
17+
*/
1418
MAT_SNACK_BAR_DATA as MAT_LEGACY_SNACK_BAR_DATA,
19+
20+
/**
21+
* @deprecated Use `MatSnackBarHorizontalPosition` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
22+
* @breaking-change 17.0.0
23+
*/
1524
MatSnackBarHorizontalPosition as MatLegacySnackBarHorizontalPosition,
25+
26+
/**
27+
* @deprecated Use `MatSnackBarVerticalPosition` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
28+
* @breaking-change 17.0.0
29+
*/
1630
MatSnackBarVerticalPosition as MatLegacySnackBarVerticalPosition,
31+
32+
/**
33+
* @deprecated Use `MatSnackBarConfig` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
34+
* @breaking-change 17.0.0
35+
*/
1736
MatSnackBarConfig as MatLegacySnackBarConfig,
37+
38+
/**
39+
* @deprecated Use `MatSnackBarDismiss` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
40+
* @breaking-change 17.0.0
41+
*/
1842
MatSnackBarDismiss as MatLegacySnackBarDismiss,
43+
44+
/**
45+
* @deprecated Use `MatSnackBarRef` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
46+
* @breaking-change 17.0.0
47+
*/
1948
MatSnackBarRef as MatLegacySnackBarRef,
49+
50+
/**
51+
* @deprecated Use `MAT_SNACK_BAR_DEFAULT_OPTIONS` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
52+
* @breaking-change 17.0.0
53+
*/
2054
MAT_SNACK_BAR_DEFAULT_OPTIONS as MAT_LEGACY_SNACK_BAR_DEFAULT_OPTIONS,
55+
56+
/**
57+
* @deprecated Use `MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
58+
* @breaking-change 17.0.0
59+
*/
2160
MAT_SNACK_BAR_DEFAULT_OPTIONS_FACTORY as MAT_LEGACY_SNACK_BAR_DEFAULT_OPTIONS_FACTORY,
61+
62+
/**
63+
* @deprecated Use `TextOnlySnackBar` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
64+
* @breaking-change 17.0.0
65+
*/
2266
TextOnlySnackBar as LegacyTextOnlySnackBar,
67+
68+
/**
69+
* @deprecated Use `matSnackBarAnimations` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
70+
* @breaking-change 17.0.0
71+
*/
2372
matSnackBarAnimations as matLegacySnackBarAnimations,
73+
74+
/**
75+
* @deprecated Use `_MatSnackBarContainerBase` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
76+
* @breaking-change 17.0.0
77+
*/
2478
_MatSnackBarContainerBase as _MatLegacySnackBarContainerBase,
79+
80+
/**
81+
* @deprecated Use `_MatSnackBarBase` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
82+
* @breaking-change 17.0.0
83+
*/
2584
_MatSnackBarBase as _MatLegacySnackBarBase,
2685
} from '@angular/material/snack-bar';

‎src/material/legacy-snack-bar/simple-snack-bar.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import {TextOnlySnackBar, MatSnackBarRef, MAT_SNACK_BAR_DATA} from '@angular/mat
1212
/**
1313
* A component used to open as the default snack bar, matching material spec.
1414
* This should only be used internally by the snack bar service.
15+
* @deprecated Use `SimpleSnackBar` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
16+
* @breaking-change 17.0.0
1517
*/
1618
@Component({
1719
selector: 'simple-snack-bar',

‎src/material/legacy-snack-bar/snack-bar-container.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import {_MatSnackBarContainerBase, matSnackBarAnimations} from '@angular/materia
1212
/**
1313
* Internal component that wraps user-provided snack bar content.
1414
* @docs-private
15+
* @deprecated Use `MatSnackBarContainer` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
16+
* @breaking-change 17.0.0
1517
*/
1618
@Component({
1719
selector: 'snack-bar-container',

‎src/material/legacy-snack-bar/snack-bar-module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ import {MatLegacyButtonModule} from '@angular/material/legacy-button';
1515
import {LegacySimpleSnackBar} from './simple-snack-bar';
1616
import {MatLegacySnackBarContainer} from './snack-bar-container';
1717

18+
/**
19+
* @deprecated Use `MatSnackBarModule` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
20+
* @breaking-change 17.0.0
21+
*/
1822
@NgModule({
1923
imports: [OverlayModule, PortalModule, CommonModule, MatLegacyButtonModule, MatCommonModule],
2024
exports: [MatLegacySnackBarContainer, MatCommonModule],

‎src/material/legacy-snack-bar/snack-bar.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import {MatLegacySnackBarModule} from './snack-bar-module';
2121

2222
/**
2323
* Service to dispatch Material Design snack bar messages.
24+
* @deprecated Use `MatSnackBar` from `@angular/material/snack-bar` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
25+
* @breaking-change 17.0.0
2426
*/
2527
@Injectable({providedIn: MatLegacySnackBarModule})
2628
export class MatLegacySnackBar extends _MatSnackBarBase {

‎src/material/legacy-snack-bar/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 {MatLegacySnackBarHarness} from './snack-bar-harness';
10-
export {SnackBarHarnessFilters as LegacySnackBarHarnessFilters} from '@angular/material/snack-bar/testing';
10+
export {
11+
/**
12+
* @deprecated Use `SnackBarHarnessFilters` from `@angular/material/snack-bar/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
13+
* @breaking-change 17.0.0
14+
*/
15+
SnackBarHarnessFilters as LegacySnackBarHarnessFilters,
16+
} from '@angular/material/snack-bar/testing';

‎src/material/legacy-snack-bar/testing/snack-bar-harness.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
import {HarnessPredicate} from '@angular/cdk/testing';
99
import {_MatSnackBarHarnessBase, SnackBarHarnessFilters} from '@angular/material/snack-bar/testing';
1010

11-
/** Harness for interacting with a standard mat-snack-bar in tests. */
11+
/**
12+
* Harness for interacting with a standard mat-snack-bar in tests.
13+
* @deprecated Use `MatSnackBarHarness` from `@angular/material/snack-bar/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
14+
* @breaking-change 17.0.0
15+
*/
1216
export class MatLegacySnackBarHarness extends _MatSnackBarHarnessBase {
1317
// Developers can provide a custom component or template for the snackbar. The canonical snack-bar
1418
// parent is the "MatSnackBarContainer". We use `:not([mat-exit])` to exclude snack bars that

‎tools/public_api_guard/material/legacy-snack-bar-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { _MatSnackBarHarnessBase } from '@angular/material/snack-bar/testing';
1010

1111
export { LegacySnackBarHarnessFilters }
1212

13-
// @public
13+
// @public @deprecated
1414
export class MatLegacySnackBarHarness extends _MatSnackBarHarnessBase {
1515
// (undocumented)
1616
protected _actionButtonSelector: string;

‎tools/public_api_guard/material/legacy-snack-bar.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { MatSnackBarRef as MatLegacySnackBarRef } from '@angular/material/snack-
2727
import { MatSnackBarVerticalPosition as MatLegacySnackBarVerticalPosition } from '@angular/material/snack-bar';
2828
import { Overlay } from '@angular/cdk/overlay';
2929

30-
// @public
30+
// @public @deprecated
3131
export class LegacySimpleSnackBar implements LegacyTextOnlySnackBar {
3232
constructor(snackBarRef: MatLegacySnackBarRef<LegacySimpleSnackBar>, data: any);
3333
action(): void;
@@ -52,7 +52,7 @@ export { MAT_LEGACY_SNACK_BAR_DEFAULT_OPTIONS }
5252

5353
export { MAT_LEGACY_SNACK_BAR_DEFAULT_OPTIONS_FACTORY }
5454

55-
// @public
55+
// @public @deprecated
5656
export class MatLegacySnackBar extends _MatLegacySnackBarBase {
5757
constructor(overlay: Overlay, live: LiveAnnouncer, injector: Injector, breakpointObserver: BreakpointObserver, parentSnackBar: MatLegacySnackBar, defaultConfig: MatLegacySnackBarConfig);
5858
// (undocumented)
@@ -73,7 +73,7 @@ export { _MatLegacySnackBarBase }
7373

7474
export { MatLegacySnackBarConfig }
7575

76-
// @public
76+
// @public @deprecated
7777
export class MatLegacySnackBarContainer extends _MatLegacySnackBarContainerBase {
7878
// (undocumented)
7979
protected _afterPortalAttached(): void;
@@ -89,7 +89,7 @@ export { MatLegacySnackBarDismiss }
8989

9090
export { MatLegacySnackBarHorizontalPosition }
9191

92-
// @public (undocumented)
92+
// @public @deprecated (undocumented)
9393
export class MatLegacySnackBarModule {
9494
// (undocumented)
9595
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacySnackBarModule, never>;

0 commit comments

Comments
 (0)