Skip to content

Commit a7ba471

Browse files
asynclizcopybara-github
authored andcommitted
fix(tokens): add readme for the @material/web/tokens/versions folder
PiperOrigin-RevId: 836373118
1 parent 81a7e2b commit a7ba471

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

tokens/versions/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
This folder contains auto-generated files for Material Design token versions.
2+
3+
> **WARNING: These files may unexpectedly change across different non-major
4+
> versions of `@material/web`.**
5+
>
6+
> Most users should ignore this folder and use other APIs provided by
7+
> `@material/web/tokens`.
8+
9+
`@material/web/tokens/versions` is useful for custom implementations of or
10+
experimentations with the Material Design system.
11+
12+
To avoid unexpected breakages when using these files, save the *exact version*
13+
of `@material/web` instead of a version range (e.g. `@2.0.0` instead of
14+
`@^2.0.0`).
15+
16+
```
17+
Example of a minor breaking change:
18+
19+
<!-- v2.0.0 - add tokens v5 -->
20+
@material/[email protected]/tokens/version/v5_0/_md-sys-color.scss
21+
22+
The path to this file may break in a typically non-breaking minor version bump.
23+
24+
<!-- v2.1.0 - update v5 tokens to include a new component -->
25+
@material/[email protected]/tokens/version/v5_1/_md-sys-color.scss
26+
```

0 commit comments

Comments
 (0)