Skip to content

document StaticIconProvider #120935

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

Jump to bottom
Merged
auto-submit merged 8 commits into from
Apr 8, 2023
Merged

document StaticIconProvider #120935

auto-submit merged 8 commits into from
Apr 8, 2023

Conversation

@christopherfujino
Copy link
Contributor

@christopherfujino christopherfujino commented Feb 17, 2023 •
edited
Loading

Fixes #120459

@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Feb 17, 2023
@goderbauer
Copy link
Member

goderbauer commented Feb 28, 2023

(triage) @christopherfujino Do you still have plans to finish this one up? Would be awesome to have better documentation on this!

@christopherfujino
Copy link
Contributor Author

christopherfujino commented Feb 28, 2023

(triage) @christopherfujino Do you still have plans to finish this one up? Would be awesome to have better documentation on this!

Yup, thanks for the ping!

@christopherfujino
Copy link
Contributor Author

christopherfujino commented Mar 21, 2023

ping @christopherfujino please land this.

@christopherfujino christopherfujino marked this pull request as ready for review March 21, 2023 23:48
@christopherfujino
Copy link
Contributor Author

christopherfujino commented Mar 23, 2023

@goderbauer this is my first framework doc PR, does this align with our style?

goderbauer
goderbauer reviewed Mar 23, 2023
View reviewed changes
packages/flutter/lib/src/widgets/icon_data.dart Outdated
Comment on lines 112 to 113
Copy link
Member

@goderbauer goderbauer Mar 23, 2023

Choose a reason for hiding this comment

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

nit: I would rephrase this, instead of saying "should" I would say, tree shaking only works if you do this. Otherwise your binary will be larger than necessary (or whatever the failure mode is).

Copy link
Contributor Author

@christopherfujino christopherfujino Apr 7, 2023

Choose a reason for hiding this comment

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

updated, WDYT?

goderbauer
goderbauer approved these changes Apr 7, 2023
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

christopherfujino
christopherfujino commented Apr 7, 2023
View reviewed changes
@christopherfujino christopherfujino added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 7, 2023
@auto-submit auto-submit bot merged commit 3ea2d72 into flutter:master Apr 8, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 8, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 8, 2023
@engine-flutter-autoroll
3ea2d72 document StaticIconProvider (flutter/flutter#120935)
3d467b2
exaby73 pushed a commit to exaby73/flutter_nevercode that referenced this pull request Apr 17, 2023
@christopherfujino @exaby73
document StaticIconProvider (flutter#120935)
53f507c 
document StaticIconProvider
@slavap
Copy link

slavap commented Jul 25, 2023

Reading comment added for StaticIconProvider still does not answer the question - "How to make tree shaking working for custom font?". I have custom icon font added to assests and declared:

@staticIconProvider
abstract final class MyIcons { ... }

but don't see tree shaking works for my custom font. What should I do to make it work?

@christopherfujino christopherfujino deleted the document-icon-data branch July 25, 2023 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@goderbauer goderbauer goderbauer approved these changes

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document the @staticIconProvider annotation in the IconData class dartdoc

3 participants

@christopherfujino @goderbauer @slavap