Skip to content

fix(tokens): add readme for the @material/web/tokens/versions folder #5866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Nov 24, 2025
+26 −0
Merged

fix(tokens): add readme for the @material/web/tokens/versions folder #5866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions tokens/versions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
This folder contains auto-generated files for Material Design token versions.

> **WARNING: These files may unexpectedly change across different non-major
> versions of `@material/web`.**
>
> Most users should ignore this folder and use other APIs provided by
> `@material/web/tokens`.
`@material/web/tokens/versions` is useful for custom implementations of or
experimentations with the Material Design system.

To avoid unexpected breakages when using these files, save the *exact version*
of `@material/web` instead of a version range (e.g. `@2.0.0` instead of
`@^2.0.0`).

```
Example of a minor breaking change:
<!-- v2.0.0 - add tokens v5 -->
@material/[email protected]/tokens/version/v5_0/_md-sys-color.scss
The path to this file may break in a typically non-breaking minor version bump.
<!-- v2.1.0 - update v5 tokens to include a new component -->
@material/[email protected]/tokens/version/v5_1/_md-sys-color.scss
```
Loading