-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Improve Container color/decoration error message clarity #178823
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
Improve Container color/decoration error message clarity #178823
Conversation
There was a problem hiding this 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 improves the clarity of an error message in the Container widget. The assertion message for when both color and decoration are provided has been rewritten to be more explanatory and less confusing. A corresponding test case has been added to verify that the new, clearer error message is thrown as expected. The changes are correct and improve the developer experience.
The previous assertion message was confusing because it stated 'Cannot provide both' but then suggested 'To provide both, use...', which contradicted the restriction. This confused developers about the actual requirement. Updated the message to clearly explain: - The color parameter is a shorthand for decoration: BoxDecoration(color: color) - Developers should use either color OR decoration, not both - To use both color and other decoration properties, set the color within BoxDecoration Fixes flutter#119484
d420480 to
db3b47e
Compare
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group. |
justinmc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍 . Thanks for improving this! From the issue it looks like indeed this was tripping people up.
dkwingsmt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great writeup. Thanks!
Roll Flutter from 60d8165 to 13b2b91 (34 revisions) flutter/flutter@60d8165...13b2b91 2026-01-03 engine-flutter-autoroll@skia.org Roll Skia from 229239fde9e9 to 2f257bbea23a (1 revision) (flutter/flutter#180461) 2026-01-03 engine-flutter-autoroll@skia.org Roll Dart SDK from be125a188f41 to 8e711d05b844 (1 revision) (flutter/flutter#180460) 2026-01-03 engine-flutter-autoroll@skia.org Roll Dart SDK from 0e6419d14382 to be125a188f41 (1 revision) (flutter/flutter#180454) 2026-01-02 engine-flutter-autoroll@skia.org Roll Dart SDK from 5e4b7dc3a134 to 0e6419d14382 (4 revisions) (flutter/flutter#180449) 2026-01-02 engine-flutter-autoroll@skia.org Roll Skia from 5a8d480365e2 to 229239fde9e9 (9 revisions) (flutter/flutter#180448) 2026-01-02 47866232+chunhtai@users.noreply.github.com Relands "Feat: Add a11y for loading indicators (#165173)" (flutter/flutter#178402) 2026-01-02 bungeman@chromium.org Add SK_SUPPORT_LEGACY_UNSPANNED_GRADIENTS to SkUserConfig.h (flutter/flutter#180443) 2026-01-02 jmccandless@google.com Some cleanup of cross library test imports (flutter/flutter#177029) 2026-01-02 engine-flutter-autoroll@skia.org Roll Dart SDK from df175c998021 to 5e4b7dc3a134 (1 revision) (flutter/flutter#180366) 2026-01-02 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from nzgy72aZ9kvHxTDM6... to 1pPgo5DrQ5ITdz3Uy... (flutter/flutter#180438) 2026-01-01 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from 23suNuzNQCwRbDrys... to nzgy72aZ9kvHxTDM6... (flutter/flutter#180424) 2025-12-31 srawlins@google.com Remove @OverRide annotations from things which are not overrides (flutter/flutter#180417) 2025-12-31 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from t1eBl_kzKGV5K28OU... to 23suNuzNQCwRbDrys... (flutter/flutter#180409) 2025-12-31 engine-flutter-autoroll@skia.org Roll Skia from 8851d5318c9d to 5a8d480365e2 (1 revision) (flutter/flutter#180400) 2025-12-31 ahmedsameha1@gmail.com Make sure that a DecoratedBox doesn't crash in 0x0 environment (flutter/flutter#180329) 2025-12-31 engine-flutter-autoroll@skia.org Roll Skia from d0e12d575173 to 8851d5318c9d (2 revisions) (flutter/flutter#180399) 2025-12-31 iliyazelenkog@gmail.com Improve Container color/decoration error message clarity (flutter/flutter#178823) 2025-12-30 ahmedsameha1@gmail.com Make sure that a CheckedModeBanner doesn't crash in 0x0 environment (flutter/flutter#180280) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from 32c27424accb to d0e12d575173 (1 revision) (flutter/flutter#180394) 2025-12-30 dkwingsmt@users.noreply.github.com [Framework] iOS style blurring and `ImageFilterConfig` (flutter/flutter#175473) 2025-12-30 evanwall@buffalo.edu Fix issue with getUniformFloat crashing with hot reload (flutter/flutter#180138) 2025-12-30 jmccandless@google.com Test cross import lint (flutter/flutter#178693) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from d64da765cee6 to 32c27424accb (1 revision) (flutter/flutter#180393) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from 4c438e0537fc to d64da765cee6 (1 revision) (flutter/flutter#180390) 2025-12-30 engine-flutter-autoroll@skia.org Roll Packages from b3c3ca8 to 30dd810 (1 revision) (flutter/flutter#180388) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from 27b587c4b160 to 4c438e0537fc (1 revision) (flutter/flutter#180384) 2025-12-30 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from DdllqZRZYriOd7Q8v... to t1eBl_kzKGV5K28OU... (flutter/flutter#180378) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from 11690456a90d to 27b587c4b160 (1 revision) (flutter/flutter#180377) 2025-12-30 evanwall@buffalo.edu Allow setting vector uniforms by name. (flutter/flutter#179927) 2025-12-30 engine-flutter-autoroll@skia.org Roll Skia from 7abf754bce14 to 11690456a90d (6 revisions) (flutter/flutter#180374) 2025-12-29 logic@deltaq.org Add support for Shift-Delete, Ctrl-Insert and Shift-Insert (flutter/flutter#178561) 2025-12-29 engine-flutter-autoroll@skia.org Roll Skia from c85d3e2b12d7 to 7abf754bce14 (1 revision) (flutter/flutter#180371) 2025-12-29 engine-flutter-autoroll@skia.org Roll Packages from 2164da9 to b3c3ca8 (2 revisions) (flutter/flutter#180365) 2025-12-29 engine-flutter-autoroll@skia.org Roll Skia from c29a475066f5 to c85d3e2b12d7 (1 revision) (flutter/flutter#180363) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 ...
Description
This PR improves the clarity of the error message shown when developers provide both
coloranddecorationparameters to aContainerwidget.Problem
The previous assertion message was confusing and contradictory:
This message stated "Cannot provide both" but then suggested "To provide both, use...", which confused developers about the actual requirement. The suggestion appeared to offer a workaround to use both parameters together, when in fact it was explaining how to migrate from using
colorto usingdecorationexclusively.Solution
Updated the assertion message to clearly explain:
colorparameter is a shorthand fordecoration: BoxDecoration(color: color)colorORdecoration, not bothBoxDecorationinsteadNew message:
Related Issues
Fixes #119484
Pre-launch Checklist
///).