Add M3E migration guideline - #192519
Open
QuncCccccc wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive Material 3 Expressive component migration checklist to the ecosystem documentation and updates the main README index to link to it. The review feedback suggests running Dart scripts and tests from the package directory rather than the repository root to ensure correct dependency resolution, and correcting an example path to match the structure of the flutter/packages repository.
11 tasks
Piinks
reviewed
Sep 11, 2026
Piinks
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this @QuncCccccc!
Here are a few suggestions and minor discrepancies to consider before landing:
- Section 2 - Template Skeleton
- In
packages/material_ui/tool/gen_defaults/templates/template.dart,TokenTemplate.generateFileasserts that the output ofgenerateContentscontainsclass $className. Returning only a comment triggers anAssertionError. Includingclass $className { ... }in the skeleton avoids this.
- In
- Section 12 - Generator Tests
- Running
dart run test testintool/gen_defaultson a clean checkout requiresflutter pub getfirst becausegen_defaultshas a dependency on the Flutter SDK (flutter: sdk: flutter). Usingflutter testdirectly avoids this dependency resolution issue.
- Running
- Section 10 - Example Doc Pattern:
- In
packages/material_ui, doc samples currently use<callout-box>,{@macro material_ui.dartpad_guide}, and{@example /example/lib/...#body}, rather than{@tool dartpad}andSee code in .... Updating the snippet to reflect that pattern will keep new docs consistent.
- In
- Section 11 - Pending Changelog Terms
- For manual YAML creation, the version bump values are
major,minor,patch, orskip. The valuesbugfixandnextare CLI options forflutter_plugin_tools update-release-info. Clarifying this distinction avoids invalid entries likeversion: bugfixin manual YAML files.
- For manual YAML creation, the version bump values are
- Section 6 - Reference Link
- Mentioning that the
IconButtonmigration in flutter/packages#12832 is the concrete reference implementation forButtonStyle.sizeVariantand the button variants provides great context for contributors while that PR is in flight.
- Mentioning that the
- Section 4 - Theme Data
- Add
copyWithto the list of methods to update when addingvariantto component theme data classes.
- Add
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is to add a m3e migration guide to
docs/ecosystem/material_ui.Related to Bring Material 3 Expressive to Flutter
Followup: create a skill that point to this doc to help agent during migration: flutter/packages#12818
Pre-launch Checklist
///).