Skip to content

Commit 3659b5e

Browse files
devversionamysorto
authored andcommitted
docs: add detailed breaking change note for Sass tilde change (#23910)
* docs: add detailed breaking change note for Sass tilde change Adds a detailed breaking change note for the Sass tilde change, and cleans up some other auto-generated notes. * fixup! docs: add detailed breaking change note for Sass tilde change use permalink (cherry picked from commit 3240a50)
1 parent ca1e29e commit 3659b5e

File tree

1 file changed

+42
-13
lines changed

1 file changed

+42
-13
lines changed

CHANGELOG.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,59 @@
22
# 13.0.0 "fir-valise" (2021-11-03)
33
## Breaking Changes
44
### cdk
5-
- * `CKD_COPY_TO_CLIPBOARD_CONFIG` has been removed. Use `CDK_COPY_TO_CLIPBOARD_CONFIG` instead.
65

7-
- * `ConnectedPositionStrategy` has been removed. Use `FlexibleConnectedPositionStrategy` instead.
6+
If your application imports styles from `~@angular/cdk`, the `@import`/`@use` statements need to
7+
be updated to omit the tilde. The tilde syntax is deprecated within the webpack `sass-loader` and
8+
does not work with [APF v13](https://v13.angular.io/guide/angular-package-format).
9+
10+
```scss
11+
// before
12+
@use '~@angular/cdk' as cdk;
13+
14+
// after
15+
@use '@angular/cdk' as cdk;
16+
```
17+
18+
The Angular CLI will automatically migrate your application with: `ng update @angular/cdk`.
19+
20+
Additional breaking changes:
21+
* `CKD_COPY_TO_CLIPBOARD_CONFIG` has been removed. Use `CDK_COPY_TO_CLIPBOARD_CONFIG` instead.
22+
* `ConnectedPositionStrategy` has been removed. Use `FlexibleConnectedPositionStrategy` instead.
823
* `OverlayPositionBuilder.connectedTo` has been removed. Use `OverlayPositionBuilder.flexibleConnectedTo` instead.
24+
925
### material
10-
- * `CanColorCtor` is no longer necessary and has been removed.
26+
27+
If your application imports styles from `~@angular/material`, the `@import`/`@use` statements need to
28+
be updated to omit the tilde. The tilde syntax is deprecated within the webpack `sass-loader` and
29+
does not work with [APF v13](https://v13.angular.io/guide/angular-package-format).
30+
31+
```scss
32+
// before
33+
@use '~@angular/material' as mat;
34+
35+
// after
36+
@use '@angular/material' as mat;
37+
```
38+
39+
The Angular CLI will automatically migrate your application with: `ng update @angular/material`.
40+
41+
Additionally, the following breaking changes have been made:
42+
43+
* The minimum version of Sass has been bumped to `1.34.0`. Version `1.38.0` is recommended.
44+
* `CanColorCtor` is no longer necessary and has been removed.
1145
* `CanDisableRippleCtor` is no longer necessary and has been removed.
1246
* `CanDisableCtor` is no longer necessary and has been removed.
1347
* `CanUpdateErrorStateCtor` is no longer necessary and has been removed.
1448
* `HasInitializedCtor` is no longer necessary and has been removed.
1549
* `HasTabIndexCtor` is no longer necessary and has been removed.
16-
17-
- * Material now requires at least version 1.34.0 of Sass. Version 1.38.0 is recommended.
18-
19-
- * The `_document` and `_dialog` parameters have been removed from the `MatDatepicker` and `MatDateRangePicker` constructors.
20-
21-
- * `MatFormFieldHarness.getHarnessLoaderForPrefix` has been removed. Use `MatFormFieldHarness.getPrefixText` instead.
50+
* The `_document` and `_dialog` parameters have been removed from the `MatDatepicker` and `MatDateRangePicker` constructors.
51+
* `MatFormFieldHarness.getHarnessLoaderForPrefix` has been removed. Use `MatFormFieldHarness.getPrefixText` instead.
2252
* `MatFormFieldHarness.getHarnessLoaderForSuffix` has been removed. Use `MatFormFieldHarness.getSuffixText` instead.
2353
* The `_labelOptions` parameter of the `MatFormField` constructor has been removed.
2454
* `MatFormField.underlineRef` has been removed.
55+
* `matTextareaAutosize` has been removed. Use `cdkTextareaAutosize` from the `@angular/cdk/text-field` module instead.
56+
* `MatTabHarness.getHarnessLoaderForContent` has been removed. Use `MatTabHarness.getRootHarnessLoader` instead.
2557

26-
- * `matTextareaAutosize` has been removed. Use `cdkTextareaAutosize` from the `@angular/cdk/text-field` module instead.
27-
28-
- * `MatTabHarness.getHarnessLoaderForContent` has been removed. Use `MatTabHarness.getRootHarnessLoader` instead.
2958
### youtube-player
3059
- * `YouTubePlayer.createEventsBoundInZone` has been removed.
3160
### material-date-fns-adapter
@@ -5138,4 +5167,4 @@ You can view a beta version of the docs at https://beta-angular-material-io.fire
51385167

51395168
# Changes Prior to 7.0.0
51405169

5141-
To view changes that occurred prior to 7.0.0, see [CHANGELOG_ARCHIVE.md](https://github.com/angular/components/blob/master/CHANGELOG_ARCHIVE.md).
5170+
To view changes that occurred prior to 7.0.0, see [CHANGELOG_ARCHIVE.md](https://github.com/angular/components/blob/master/CHANGELOG_ARCHIVE.md).

0 commit comments

Comments
 (0)