Migration guide for IconData

[dcharkes]

A migration guide for:

• Breaking Change: Marking class IconData as final flutter#181342
• Marking IconData's constructor parameters as @mustBeConst flutter#181344

Breaking change PR:

• Mark IconData final and @mustBeConst flutter#181345

[gemini-code-assist]

Summary of Changes

Hello @dcharkes, I'm Gemini Code Assist¹! 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. ↩

[gemini-code-assist]

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]

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

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

[ditman]

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?