Skip to content

Commit 36a54d3

Browse files
committed
fix(material/legacy-progress-spinner): deprecate all ts symbols
1 parent c3684db commit 36a54d3

File tree

6 files changed

+44
-14
lines changed

6 files changed

+44
-14
lines changed

src/material/legacy-progress-spinner/progress-spinner-module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import {CommonModule} from '@angular/common';
1010
import {MatCommonModule} from '@angular/material/core';
1111
import {MatLegacyProgressSpinner} from './progress-spinner';
1212

13+
/**
14+
* @deprecated Use `MatProgressSpinnerModule` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
15+
* @breaking-change 17.0.0
16+
*/
1317
@NgModule({
1418
imports: [MatCommonModule, CommonModule],
1519
exports: [MatLegacyProgressSpinner, MatCommonModule],

src/material/legacy-progress-spinner/progress-spinner.ts

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ import {CanColor, mixinColor, ThemePalette} from '@angular/material/core';
2828
import {ANIMATION_MODULE_TYPE} from '@angular/platform-browser/animations';
2929
import {Subscription} from 'rxjs';
3030

31-
/** Possible mode for a progress spinner. */
31+
/**
32+
* Possible mode for a progress spinner.
33+
* @deprecated Use `ProgressSpinnerMode` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
34+
* @breaking-change 17.0.0
35+
*/
3236
export type LegacyProgressSpinnerMode = 'determinate' | 'indeterminate';
3337

3438
/**
@@ -52,7 +56,11 @@ const _MatProgressSpinnerBase = mixinColor(
5256
'primary',
5357
);
5458

55-
/** Default `mat-progress-spinner` options that can be overridden. */
59+
/**
60+
* Default `mat-progress-spinner` options that can be overridden.
61+
* @deprecated Use `MatProgressSpinnerDefaultOptions` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
62+
* @breaking-change 17.0.0
63+
*/
5664
export interface MatLegacyProgressSpinnerDefaultOptions {
5765
/** Default color of the spinner. */
5866
color?: ThemePalette;
@@ -67,7 +75,11 @@ export interface MatLegacyProgressSpinnerDefaultOptions {
6775
_forceAnimations?: boolean;
6876
}
6977

70-
/** Injection token to be used to override the default options for `mat-progress-spinner`. */
78+
/**
79+
* Injection token to be used to override the default options for `mat-progress-spinner`.
80+
* @deprecated Use `MAT_PROGRESS_SPINNER_DEFAULT_OPTIONS` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
81+
* @breaking-change 17.0.0
82+
*/
7183
export const MAT_LEGACY_PROGRESS_SPINNER_DEFAULT_OPTIONS =
7284
new InjectionToken<MatLegacyProgressSpinnerDefaultOptions>(
7385
'mat-progress-spinner-default-options',
@@ -77,7 +89,11 @@ export const MAT_LEGACY_PROGRESS_SPINNER_DEFAULT_OPTIONS =
7789
},
7890
);
7991

80-
/** @docs-private */
92+
/**
93+
* @docs-private
94+
* @deprecated Use `MAT_PROGRESS_SPINNER_DEFAULT_OPTIONS_FACTORY` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
95+
* @breaking-change 17.0.0
96+
*/
8197
export function MAT_LEGACY_PROGRESS_SPINNER_DEFAULT_OPTIONS_FACTORY(): MatLegacyProgressSpinnerDefaultOptions {
8298
return {diameter: BASE_SIZE};
8399
}
@@ -112,6 +128,8 @@ const INDETERMINATE_ANIMATION_TEMPLATE = `
112128

113129
/**
114130
* `<mat-progress-spinner>` component.
131+
* @deprecated Use `MatProgressSpinner` from `@angular/material/progress-spinner` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
132+
* @breaking-change 17.0.0
115133
*/
116134
@Component({
117135
selector: 'mat-progress-spinner, mat-spinner',

src/material/legacy-progress-spinner/testing/progress-spinner-harness-filters.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@
88

99
import {BaseHarnessFilters} from '@angular/cdk/testing';
1010

11-
/** A set of criteria that can be used to filter a list of `MatProgressSpinnerHarness` instances. */
11+
/**
12+
* A set of criteria that can be used to filter a list of `MatProgressSpinnerHarness` instances.
13+
* @deprecated Use `ProgressSpinnerHarnessFilters` from `@angular/material/progress-spinner/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
14+
* @breaking-change 17.0.0
15+
*/
1216
export interface LegacyProgressSpinnerHarnessFilters extends BaseHarnessFilters {}

src/material/legacy-progress-spinner/testing/progress-spinner-harness.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
1111
import {LegacyProgressSpinnerMode} from '@angular/material/legacy-progress-spinner';
1212
import {LegacyProgressSpinnerHarnessFilters} from './progress-spinner-harness-filters';
1313

14-
/** Harness for interacting with a standard mat-progress-spinner in tests. */
14+
/**
15+
* Harness for interacting with a standard mat-progress-spinner in tests.
16+
* @deprecated Use `MatProgressSpinnerHarness` from `@angular/material/progress-spinner/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
17+
* @breaking-change 17.0.0
18+
*/
1519
export class MatLegacyProgressSpinnerHarness extends ComponentHarness {
1620
/** The selector for the host element of a Progress Spinner instance. */
1721
static hostSelector = '.mat-progress-spinner';

tools/public_api_guard/material/legacy-progress-spinner-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import { ComponentHarness } from '@angular/cdk/testing';
99
import { HarnessPredicate } from '@angular/cdk/testing';
1010
import { LegacyProgressSpinnerMode } from '@angular/material/legacy-progress-spinner';
1111

12-
// @public
12+
// @public @deprecated
1313
export interface LegacyProgressSpinnerHarnessFilters extends BaseHarnessFilters {
1414
}
1515

16-
// @public
16+
// @public @deprecated
1717
export class MatLegacyProgressSpinnerHarness extends ComponentHarness {
1818
getMode(): Promise<LegacyProgressSpinnerMode>;
1919
getValue(): Promise<number | null>;

tools/public_api_guard/material/legacy-progress-spinner.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ import { Platform } from '@angular/cdk/platform';
2121
import { ThemePalette } from '@angular/material/core';
2222
import { ViewportRuler } from '@angular/cdk/scrolling';
2323

24-
// @public
24+
// @public @deprecated
2525
export type LegacyProgressSpinnerMode = 'determinate' | 'indeterminate';
2626

27-
// @public
27+
// @public @deprecated
2828
export const MAT_LEGACY_PROGRESS_SPINNER_DEFAULT_OPTIONS: InjectionToken<MatLegacyProgressSpinnerDefaultOptions>;
2929

30-
// @public
30+
// @public @deprecated
3131
export function MAT_LEGACY_PROGRESS_SPINNER_DEFAULT_OPTIONS_FACTORY(): MatLegacyProgressSpinnerDefaultOptions;
3232

33-
// @public
33+
// @public @deprecated
3434
export class MatLegacyProgressSpinner extends _MatProgressSpinnerBase implements OnInit, OnDestroy, CanColor {
3535
constructor(elementRef: ElementRef<HTMLElement>, _platform: Platform, _document: any, animationMode: string, defaults?: MatLegacyProgressSpinnerDefaultOptions,
3636
changeDetectorRef?: ChangeDetectorRef, viewportRuler?: ViewportRuler, ngZone?: NgZone);
@@ -59,15 +59,15 @@ export class MatLegacyProgressSpinner extends _MatProgressSpinnerBase implements
5959
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyProgressSpinner, [null, null, { optional: true; }, { optional: true; }, null, null, null, null]>;
6060
}
6161

62-
// @public
62+
// @public @deprecated
6363
export interface MatLegacyProgressSpinnerDefaultOptions {
6464
color?: ThemePalette;
6565
diameter?: number;
6666
_forceAnimations?: boolean;
6767
strokeWidth?: number;
6868
}
6969

70-
// @public (undocumented)
70+
// @public @deprecated (undocumented)
7171
export class MatLegacyProgressSpinnerModule {
7272
// (undocumented)
7373
static ɵfac: i0.ɵɵFactoryDeclaration<MatLegacyProgressSpinnerModule, never>;

0 commit comments

Comments
 (0)