Skip to content

Commit 13d8524

Browse files
committed
fix(material/legacy-slide-toggle): deprecate all ts symbols
1 parent 4bb3554 commit 13d8524

File tree

8 files changed

+69
-13
lines changed

8 files changed

+69
-13
lines changed

src/material/legacy-slide-toggle/public-api.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,27 @@ export {
1717
MAT_LEGACY_SLIDE_TOGGLE_DEFAULT_OPTIONS,
1818
} from './slide-toggle-config';
1919
export {
20+
/**
21+
* @deprecated Use `_MatSlideToggleBase` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
22+
* @breaking-change 17.0.0
23+
*/
2024
_MatSlideToggleBase as _MatLegacySlideToggleBase,
25+
26+
/**
27+
* @deprecated Use `_MatSlideToggleRequiredValidatorModule` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
28+
* @breaking-change 17.0.0
29+
*/
2130
_MatSlideToggleRequiredValidatorModule as _MatLegacySlideToggleRequiredValidatorModule,
31+
32+
/**
33+
* @deprecated Use `MAT_SLIDE_TOGGLE_REQUIRED_VALIDATOR` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
34+
* @breaking-change 17.0.0
35+
*/
2236
MAT_SLIDE_TOGGLE_REQUIRED_VALIDATOR as MAT_LEGACY_SLIDE_TOGGLE_REQUIRED_VALIDATOR,
37+
38+
/**
39+
* @deprecated Use `MatSlideToggleRequiredValidator` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
40+
* @breaking-change 17.0.0
41+
*/
2342
MatSlideToggleRequiredValidator as MatLegacySlideToggleRequiredValidator,
2443
} from '@angular/material/slide-toggle';

src/material/legacy-slide-toggle/slide-toggle-config.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
import {InjectionToken} from '@angular/core';
99
import {ThemePalette} from '@angular/material/core';
1010

11-
/** Default `mat-slide-toggle` options that can be overridden. */
11+
/**
12+
* Default `mat-slide-toggle` options that can be overridden.
13+
* @deprecated Use `MatSlideToggleDefaultOptions` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
14+
* @breaking-change 17.0.0
15+
*/
1216
export interface MatLegacySlideToggleDefaultOptions {
1317
/** Whether toggle action triggers value changes in slide toggle. */
1418
disableToggleValue?: boolean;
@@ -17,7 +21,11 @@ export interface MatLegacySlideToggleDefaultOptions {
1721
color?: ThemePalette;
1822
}
1923

20-
/** Injection token to be used to override the default options for `mat-slide-toggle`. */
24+
/**
25+
* Injection token to be used to override the default options for `mat-slide-toggle`
26+
* @deprecated Use `MAT_SLIDE_TOGGLE_DEFAULT_OPTIONS` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
27+
* @breaking-change 17.0.0
28+
*/
2129
export const MAT_LEGACY_SLIDE_TOGGLE_DEFAULT_OPTIONS =
2230
new InjectionToken<MatLegacySlideToggleDefaultOptions>('mat-slide-toggle-default-options', {
2331
providedIn: 'root',

src/material/legacy-slide-toggle/slide-toggle-module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ import {MatCommonModule, MatRippleModule} from '@angular/material/core';
1212
import {MatLegacySlideToggle} from './slide-toggle';
1313
import {_MatSlideToggleRequiredValidatorModule} from '@angular/material/slide-toggle';
1414

15+
/**
16+
* @deprecated Use `MatSlideToggleModule` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
17+
* @breaking-change 17.0.0
18+
*/
1519
@NgModule({
1620
imports: [
1721
_MatSlideToggleRequiredValidatorModule,

src/material/legacy-slide-toggle/slide-toggle.ts

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,22 @@ import {
2727
} from './slide-toggle-config';
2828
import {_MatSlideToggleBase} from '@angular/material/slide-toggle';
2929

30-
/** @docs-private */
30+
/**
31+
* @docs-private
32+
* @deprecated Use `MAT_SLIDE_TOGGLE_VALUE_ACCESSOR` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
33+
* @breaking-change 17.0.0
34+
*/
3135
export const MAT_LEGACY_SLIDE_TOGGLE_VALUE_ACCESSOR = {
3236
provide: NG_VALUE_ACCESSOR,
3337
useExisting: forwardRef(() => MatLegacySlideToggle),
3438
multi: true,
3539
};
3640

37-
/** Change event object emitted by a slide toggle. */
41+
/**
42+
* Change event object emitted by a slide toggle.
43+
* @deprecated Use `MatSlideToggleChange` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
44+
* @breaking-change 17.0.0
45+
*/
3846
export class MatLegacySlideToggleChange {
3947
constructor(
4048
/** The source slide toggle of the event. */
@@ -44,7 +52,11 @@ export class MatLegacySlideToggleChange {
4452
) {}
4553
}
4654

47-
/** Represents a slidable "switch" toggle that can be moved between on and off. */
55+
/**
56+
* Represents a slidable "switch" toggle that can be moved between on and off.
57+
* @deprecated Use `MatSlideToggle` from `@angular/material/slide-toggle` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
58+
* @breaking-change 17.0.0
59+
*/
4860
@Component({
4961
selector: 'mat-slide-toggle',
5062
exportAs: 'matSlideToggle',

src/material/legacy-slide-toggle/testing/public-api.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88

99
export {MatLegacySlideToggleHarness} from './slide-toggle-harness';
1010
export {
11+
/**
12+
* @deprecated Use `_MatSlideToggleHarnessBase` from `@angular/material/slide-toggle/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
13+
* @breaking-change 17.0.0
14+
*/
1115
_MatSlideToggleHarnessBase as _MatLegacySlideToggleHarnessBase,
16+
17+
/**
18+
* @deprecated Use `SlideToggleHarnessFilters` from `@angular/material/slide-toggle/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
19+
* @breaking-change 17.0.0
20+
*/
1221
SlideToggleHarnessFilters as LegacySlideToggleHarnessFilters,
1322
} from '@angular/material/slide-toggle/testing';

src/material/legacy-slide-toggle/testing/slide-toggle-harness.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ import {
1313
SlideToggleHarnessFilters,
1414
} from '@angular/material/slide-toggle/testing';
1515

16-
/** Harness for interacting with a standard mat-slide-toggle in tests. */
16+
/**
17+
* Harness for interacting with a standard mat-slide-toggle in tests.
18+
* @deprecated Use `MatSlideToggleHarness` from `@angular/material/slide-toggle/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
19+
* @breaking-change 17.0.0
20+
*/
1721
export class MatLegacySlideToggleHarness extends _MatSlideToggleHarnessBase {
1822
private _inputContainer = this.locatorFor('.mat-slide-toggle-bar');
1923
protected _nativeElement = this.locatorFor('input');

tools/public_api_guard/material/legacy-slide-toggle-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 { LegacySlideToggleHarnessFilters }
1414

15-
// @public
15+
// @public @deprecated
1616
export class MatLegacySlideToggleHarness extends _MatLegacySlideToggleHarnessBase {
1717
static hostSelector: string;
1818
isChecked(): Promise<boolean>;

tools/public_api_guard/material/legacy-slide-toggle.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ import { _MatSlideToggleRequiredValidatorModule as _MatLegacySlideToggleRequired
2121
import { ThemePalette } from '@angular/material/core';
2222
import { Type } from '@angular/core';
2323

24-
// @public
24+
// @public @deprecated
2525
export const MAT_LEGACY_SLIDE_TOGGLE_DEFAULT_OPTIONS: InjectionToken<MatLegacySlideToggleDefaultOptions>;
2626

2727
export { MAT_LEGACY_SLIDE_TOGGLE_REQUIRED_VALIDATOR }
2828

29-
// @public
29+
// @public @deprecated
3030
export const MAT_LEGACY_SLIDE_TOGGLE_VALUE_ACCESSOR: {
3131
provide: InjectionToken<readonly ControlValueAccessor[]>;
3232
useExisting: Type<any>;
3333
multi: boolean;
3434
};
3535

36-
// @public
36+
// @public @deprecated
3737
export class MatLegacySlideToggle extends _MatLegacySlideToggleBase<MatLegacySlideToggleChange> {
3838
constructor(elementRef: ElementRef, focusMonitor: FocusMonitor, changeDetectorRef: ChangeDetectorRef, tabIndex: string, defaults: MatLegacySlideToggleDefaultOptions, animationMode?: string);
3939
// (undocumented)
@@ -51,7 +51,7 @@ export class MatLegacySlideToggle extends _MatLegacySlideToggleBase<MatLegacySli
5151

5252
export { _MatLegacySlideToggleBase }
5353

54-
// @public
54+
// @public @deprecated
5555
export class MatLegacySlideToggleChange {
5656
constructor(
5757
source: MatLegacySlideToggle,
@@ -60,13 +60,13 @@ export class MatLegacySlideToggleChange {
6060
source: MatLegacySlideToggle;
6161
}
6262

63-
// @public
63+
// @public @deprecated
6464
export interface MatLegacySlideToggleDefaultOptions {
6565
color?: ThemePalette;
6666
disableToggleValue?: boolean;
6767
}
6868

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

0 commit comments

Comments
 (0)