Skip to content

Migration guide for IconData#13005

Open
dcharkes wants to merge 1 commit intomainfrom
migration-guide-icondata
Open

Migration guide for IconData#13005
dcharkes wants to merge 1 commit intomainfrom
migration-guide-icondata

Conversation

@dcharkes
Copy link
Contributor

@dcharkes dcharkes commented Jan 28, 2026

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Jan 28, 2026

Summary of Changes

Hello @dcharkes, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new migration guide to document a significant breaking change in Flutter: the IconData class is now marked as final. This modification is crucial for the ongoing development of a generalized tree-shaking mechanism for assets and native code. The guide aims to provide developers with clear instructions and practical code examples to update their applications, ensuring a smooth transition for any custom icon implementations.

Highlights

  • IconData class marked as final: The IconData class is now marked as final, preventing it from being extended or implemented. This change is part of an effort to generalize the mechanism for tree-shaking assets and native code.
  • Migration guide provided: A comprehensive migration guide has been added, detailing how to adapt code that previously implemented or extended IconData. It suggests using wrapper classes with static const instances and provides code examples for custom icon types.
  • Guidance on mustBeConst lint: The guide includes instructions on how to ignore the mustBeConst lint for IconData parameters if a non-const instance is required, acknowledging that this will forego tree-shaking for that specific icon.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@dcharkes dcharkes mentioned this pull request Jan 28, 2026
Open
gemini-code-assist[bot]
gemini-code-assist bot reviewed Jan 28, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive migration guide for the IconData class being marked as final. The new documentation clearly explains the breaking change, its background, and provides practical code examples for migrating custom icon types. The index.md file has been correctly updated to include a reference to this new guide. The changes are well-documented and provide valuable information for developers adapting to this breaking change.

@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Jan 28, 2026 •
edited
Loading

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

https://flutter-docs-prod--pr13005-migration-guide-icondata-0vthcqx6.web.app

ditman
ditman reviewed Jan 29, 2026
View reviewed changes
src/content/release/breaking-changes/icondata-class-marked-final.md

## Summary

The `IconData` class is now marked as `final`, which prevents it from being
Copy link
Member

@ditman ditman Jan 29, 2026

Choose a reason for hiding this comment

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

now marked marked as final

I think this should specify the version of Flutter that introduced this change (when it's known): "Since Flutter 3.XX, the IconData class is marked as final..." or similar?

Copy link
Contributor

@Piinks Piinks Mar 19, 2026

Choose a reason for hiding this comment

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

This is usually specified at the bottom, and updated when the change actually reaches stable so that the release tag is more accurate.

@dcharkes dcharkes mentioned this pull request Mar 2, 2026
Merged
@sfshaza2
Copy link
Contributor

sfshaza2 commented Mar 2, 2026

@dcharkes, where are we on this PR?

@dcharkes
Copy link
Contributor Author

dcharkes commented Mar 3, 2026

Hi @sfshaza2,

I'm in the process of helping some users prepare for the breaking change (such as fluttercommunity/font_awesome_flutter#297). After that, I can rebase flutter/flutter#181345 to land the breaking change and this PR to land a migration guide.

I am assuming that we don't want to land a migration guide on the website for a breaking change that hasn't gone in yet.

@dcharkes dcharkes mentioned this pull request Mar 19, 2026
Open
@dcharkes dcharkes force-pushed the migration-guide-icondata branch from efe4358 to e6b92be Compare March 19, 2026 18:04
@dcharkes dcharkes marked this pull request as ready for review March 19, 2026 18:05
@dcharkes dcharkes requested review from a team and sfshaza2 as code owners March 19, 2026 18:05
gemini-code-assist[bot]
gemini-code-assist bot reviewed Mar 19, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a migration guide for the breaking change where IconData is marked as final. The guide is well-written and provides a clear migration path with code examples. I've added a couple of suggestions to improve clarity in the guide and to maintain consistency in the breaking changes index file.

@dcharkes dcharkes force-pushed the migration-guide-icondata branch from e6b92be to 9565054 Compare March 19, 2026 18:22
Piinks
Piinks approved these changes Mar 19, 2026
View reviewed changes
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ditman ditman ditman left review comments

@Piinks Piinks Piinks approved these changes

@sfshaza2 sfshaza2 Awaiting requested review from sfshaza2 sfshaza2 is a code owner

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@dcharkes @flutter-website-bot @sfshaza2 @ditman @Piinks