Skip to content

Migration guide for M3 token update #11480

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.

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
merged 5 commits into from
Dec 11, 2024
Merged

Conversation

QuncCccccc
Copy link
Contributor

@QuncCccccc QuncCccccc commented Dec 9, 2024

This PR is to add a breaking change page for the Material 3 token change in the material library(flutter/flutter#153722, flutter/flutter#153385).

Presubmit checklist

  • This PR is marked as draft with an explanation if not meant to land until a future stable release.
  • This PR doesn’t contain automatically generated corrections (Grammarly or similar).
  • This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
  • This PR uses semantic line breaks of 80 characters or fewer.

@QuncCccccc QuncCccccc requested review from sfshaza2, parlough and a team as code owners December 9, 2024 23:56
@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Dec 10, 2024

Visit the preview URL for this PR (updated for commit b74eb2a):

https://flutter-docs-prod--pr11480-token-update-breaking-chang-78jehnpj.web.app

@QuncCccccc QuncCccccc requested a review from Piinks December 10, 2024 00:01
Landed in version: 3.26.0-0.0.pre<br>
In stable release: not yet

## References
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be good to include some API references like in other migration guides. ColorScheme, Theme, and Chip classes look relevant to include here.

Widgets that have been using these roles with their default value might look
different.

Additionally, the Material 3 tokens also updated the border color of Chips from
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Additionally, the Material 3 tokens also updated the border color of Chips from
Additionally, the Material 3 tokens updated the border color of Chips from

Additionally + also can be redundant, I do this all the time myself 😅

Comment on lines 11 to 12
mode) to be more visually appealing while retaining accessible contrast. There
are not any breakages identified in Flutter testing of this change, which
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
mode) to be more visually appealing while retaining accessible contrast. There
are not any breakages identified in Flutter testing of this change, which
mode) to be more visually appealing while retaining accessible contrast.
Testing identified this change as non-breaking in Flutter, but some customers
may notice this small change.

Maybe we should also have non-breaking link to the breaking changes policy?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, replace "may" with might in line 13.

The Material Design tokens updated the mapping of 4 color roles (only in Light
mode) to be more visually appealing while retaining accessible contrast. There
are not any breakages identified in Flutter testing of this change, which
applied to the following color properties:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
applied to the following color properties:
The update affected the following color properties:


## Migration guide

The differences in the mappings of the color roles are small. Using
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The differences in the mappings of the color roles are small. Using
The differences in the mappings of the color roles are small. Use

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for all the suggestions!

@Piinks
Copy link
Contributor

Piinks commented Dec 10, 2024

Thanks for writing this!

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kate did a great review! I'll lgtm this PR, but please make those changes and then you can land.

@sfshaza2 sfshaza2 added the review.await-update Awaiting Updates after Edits label Dec 10, 2024
@QuncCccccc
Copy link
Contributor Author

Is there a way to double check whether the links I provided work? Not very sure if I formatted them correctly.

@Piinks
Copy link
Contributor

Piinks commented Dec 11, 2024

Is there a way to double check whether the links I provided work? Not very sure if I formatted them correctly.

I think CI would fail if a link was broken. :)

Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@QuncCccccc QuncCccccc merged commit 4e5c7d2 into main Dec 11, 2024
9 checks passed
@QuncCccccc QuncCccccc deleted the token_update_breaking_changes branch December 11, 2024 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review.await-update Awaiting Updates after Edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants