Skip to content

Commit 3240a50

Browse files
authored
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
1 parent e7a3f68 commit 3240a50

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
@@ -13,30 +13,59 @@ Amy Sorto, Andrew Seguin, Jeremy Elbourn, Kristiyan Kostadinov, Paul Gschwendtne
1313
# 13.0.0 "fir-valise" (2021-11-03)
1414
## Breaking Changes
1515
### cdk
16-
- * `CKD_COPY_TO_CLIPBOARD_CONFIG` has been removed. Use `CDK_COPY_TO_CLIPBOARD_CONFIG` instead.
1716

18-
- * `ConnectedPositionStrategy` has been removed. Use `FlexibleConnectedPositionStrategy` instead.
17+
If your application imports styles from `~@angular/cdk`, the `@import`/`@use` statements need to
18+
be updated to omit the tilde. The tilde syntax is deprecated within the webpack `sass-loader` and
19+
does not work with [APF v13](https://v13.angular.io/guide/angular-package-format).
20+
21+
```scss
22+
// before
23+
@use '~@angular/cdk' as cdk;
24+
25+
// after
26+
@use '@angular/cdk' as cdk;
27+
```
28+
29+
The Angular CLI will automatically migrate your application with: `ng update @angular/cdk`.
30+
31+
Additional breaking changes:
32+
* `CKD_COPY_TO_CLIPBOARD_CONFIG` has been removed. Use `CDK_COPY_TO_CLIPBOARD_CONFIG` instead.
33+
* `ConnectedPositionStrategy` has been removed. Use `FlexibleConnectedPositionStrategy` instead.
1934
* `OverlayPositionBuilder.connectedTo` has been removed. Use `OverlayPositionBuilder.flexibleConnectedTo` instead.
35+
2036
### material
21-
- * `CanColorCtor` is no longer necessary and has been removed.
37+
38+
If your application imports styles from `~@angular/material`, the `@import`/`@use` statements need to
39+
be updated to omit the tilde. The tilde syntax is deprecated within the webpack `sass-loader` and
40+
does not work with [APF v13](https://v13.angular.io/guide/angular-package-format).
41+
42+
```scss
43+
// before
44+
@use '~@angular/material' as mat;
45+
46+
// after
47+
@use '@angular/material' as mat;
48+
```
49+
50+
The Angular CLI will automatically migrate your application with: `ng update @angular/material`.
51+
52+
Additionally, the following breaking changes have been made:
53+
54+
* The minimum version of Sass has been bumped to `1.34.0`. Version `1.38.0` is recommended.
55+
* `CanColorCtor` is no longer necessary and has been removed.
2256
* `CanDisableRippleCtor` is no longer necessary and has been removed.
2357
* `CanDisableCtor` is no longer necessary and has been removed.
2458
* `CanUpdateErrorStateCtor` is no longer necessary and has been removed.
2559
* `HasInitializedCtor` is no longer necessary and has been removed.
2660
* `HasTabIndexCtor` is no longer necessary and has been removed.
27-
28-
- * Material now requires at least version 1.34.0 of Sass. Version 1.38.0 is recommended.
29-
30-
- * The `_document` and `_dialog` parameters have been removed from the `MatDatepicker` and `MatDateRangePicker` constructors.
31-
32-
- * `MatFormFieldHarness.getHarnessLoaderForPrefix` has been removed. Use `MatFormFieldHarness.getPrefixText` instead.
61+
* The `_document` and `_dialog` parameters have been removed from the `MatDatepicker` and `MatDateRangePicker` constructors.
62+
* `MatFormFieldHarness.getHarnessLoaderForPrefix` has been removed. Use `MatFormFieldHarness.getPrefixText` instead.
3363
* `MatFormFieldHarness.getHarnessLoaderForSuffix` has been removed. Use `MatFormFieldHarness.getSuffixText` instead.
3464
* The `_labelOptions` parameter of the `MatFormField` constructor has been removed.
3565
* `MatFormField.underlineRef` has been removed.
66+
* `matTextareaAutosize` has been removed. Use `cdkTextareaAutosize` from the `@angular/cdk/text-field` module instead.
67+
* `MatTabHarness.getHarnessLoaderForContent` has been removed. Use `MatTabHarness.getRootHarnessLoader` instead.
3668

37-
- * `matTextareaAutosize` has been removed. Use `cdkTextareaAutosize` from the `@angular/cdk/text-field` module instead.
38-
39-
- * `MatTabHarness.getHarnessLoaderForContent` has been removed. Use `MatTabHarness.getRootHarnessLoader` instead.
4069
### youtube-player
4170
- * `YouTubePlayer.createEventsBoundInZone` has been removed.
4271
### material-date-fns-adapter
@@ -5237,4 +5266,4 @@ You can view a beta version of the docs at https://beta-angular-material-io.fire
52375266

52385267
# Changes Prior to 7.0.0
52395268

5240-
To view changes that occurred prior to 7.0.0, see [CHANGELOG_ARCHIVE.md](https://github.com/angular/components/blob/master/CHANGELOG_ARCHIVE.md).
5269+
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)