Deprecate `ThemeData.dialogBackgroundColor` in favor of `DialogThemeData.backgroundColor` #155072

TahaTesser · 2024-09-12T08:16:46Z

Related to ☂️ Material Theme System Updates

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

packages/flutter/test_fixes/widgets/widgets.dart

packages/flutter/lib/src/material/theme_data.dart

packages/flutter/test_fixes/material/theme_data.dart

TahaTesser · 2024-09-12T16:51:46Z

Filed flutter/cocoon#3901 to remove ThemeData.dialogBackgroundColor usage in the dashboard to fix CI here.

QuncCccccc · 2024-09-24T21:26:39Z

packages/flutter/lib/fix_data/fix_material/fix_theme_data.yaml

+            name: 'dialogTheme'
+            style: optional_named
+            argumentValue:
+              expression: 'DialogTheme(backgroundColor: {% dialogBackgroundColor %})'


The type of ThemeData.dialogTheme will be changed from DialogTheme to DialogThemeData soon(#155129) to follow the component theme convention. This dart fix might also need some update:)

Thanks for sharing. I'll wait for #155129 to land so I'm yet to write the migration guide for this deprecation.

Related flutter/flutter#155072

TahaTesser · 2024-10-03T15:20:18Z

Blocked by flutter/tests#413

Updated the PR to use the new DialogThemeData and filed flutter/tests#413 to unblock this PR (it fails to test the latest flutter_cocoon commit for the removal of ThemeData.dialogBackgroundColor in the dashboard)

Piinks · 2024-10-16T15:23:05Z

Rebasing after flutter/tests#413 landed

TahaTesser · 2024-10-21T14:21:19Z

Fix some issues in test_fixes and unresolved doc references.

QuncCccccc

LGTM with one minor comment:) Thanks for contributing the issue #91772

QuncCccccc · 2024-10-21T20:43:19Z

packages/flutter/lib/fix_data/fix_material/fix_theme_data.yaml

+          - kind: 'removeParameter'
+            name: 'dialogBackgroundColor'
+          - kind: 'addParameter'
+            index: 135


Just a question for my learning, how do we determine the index here?

From what i know. adding or removing parameter action uses the index value to determine where to add its arguments. Here i added 135 randomly, it uses the this index value to add DialogTheme, for instance.

There is more info here

QuncCccccc · 2024-10-21T20:49:23Z

packages/flutter/test_fixes/material/theme_data.dart

+
+  // Changes made in https://github.com/flutter/flutter/pull/155072
+  ThemeData themeData = ThemeData();
+  themeData = ThemeData(dialogBackgroundColor: Colors.orange);


I see the dart fix also provide a case when both dialogBackgroundColor and dialogTheme are not null. Maybe we can also provide a test case here:)

Great catch!

TahaTesser · 2024-10-22T15:25:39Z

I'm preparing a migration guide for flutter/website for this. Please don't land it till then.

…ata.backgroundColor`

TahaTesser · 2024-10-23T14:26:01Z

@QuncCccccc Filed a migration guide flutter/website#11309

Piinks · 2024-10-24T15:22:21Z

packages/flutter/lib/src/material/theme_data.dart

+    'Use DialogThemeData.backgroundColor instead. '
+    'This feature was deprecated after v3.27.0-0.1.pre.',
+  )
+  Color? get dialogBackgroundColor => _dialogBackgroundColor;


Since this is made nullable where it previously was not, customer code in the google testing shard will not compile where is was previously Color, and now is Color? and in need of a null check.

Ahh...Thanks! Usually we made the deprecated property nullable in ThemeData.raw . I did same for button bar just above this. Just updated the PR to revert this to be non-nullable.

Perfect thank you! There were over a thousand failures. If there were less I would have tried to migrate the customers, but this one clearly has a big impact. :)

Piinks

LGTM

…1309) Related to flutter/flutter#155072 ## Presubmit checklist - [x] This PR is marked as draft with an explanation if not meant to land until a future stable release. - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <44418985+sfshaza2@users.noreply.github.com>

…ogThemeData.backgroundColor` (flutter/flutter#155072)

Roll Flutter from 4faa4a4 to 5a11904 (67 revisions) flutter/flutter@4faa4a4...5a11904 2024-10-26 30870216+gaaclarke@users.noreply.github.com Relands "Wide gamut framework gradient test (#153976)" (flutter/flutter#157643) 2024-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7c5c5fe5c84d to c9b8ac96f6ce (3 revisions) (flutter/flutter#157662) 2024-10-26 32538273+ValentinVignal@users.noreply.github.com Add test for `navigator_state.restorable_push_and_remove_until.0.dart` (flutter/flutter#157595) 2024-10-26 matanlurey@users.noreply.github.com Tighten up `throwToolExit`, explain when to use it. (flutter/flutter#157561) 2024-10-26 matanlurey@users.noreply.github.com Remove extraneous `throw`. (flutter/flutter#157658) 2024-10-26 32538273+ValentinVignal@users.noreply.github.com Add tests for `navigator.restorable_push.0.dart` (flutter/flutter#157492) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 43e4d9a30666 to 7c5c5fe5c84d (1 revision) (flutter/flutter#157644) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 5061358e255f to 43e4d9a30666 (1 revision) (flutter/flutter#157637) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from eb867e055790 to 5061358e255f (2 revisions) (flutter/flutter#157623) 2024-10-25 polinach@google.com Create flutter specific leak troubleshooting guidance. (flutter/flutter#157396) 2024-10-25 katelovett@google.com Update CupertinoNavigationBar to support large layout (flutter/flutter#157133) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 38e9be1f74fa to eb867e055790 (3 revisions) (flutter/flutter#157613) 2024-10-25 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Wide gamut framework gradient test (#153976)" (flutter/flutter#157615) 2024-10-25 30870216+gaaclarke@users.noreply.github.com Wide gamut framework gradient test (flutter/flutter#153976) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from b413d9996c86 to 38e9be1f74fa (2 revisions) (flutter/flutter#157604) 2024-10-25 engine-flutter-autoroll@skia.org Roll Packages from a556f0f to e0c4f55 (2 revisions) (flutter/flutter#157605) 2024-10-25 jonahwilliams@google.com Support backdrop key in flutter framework. (flutter/flutter#157278) 2024-10-25 reidbaker@google.com Add 3.24.4 changelog to master (flutter/flutter#157600) 2024-10-25 mohellebiabdessalem@gmail.com Update flutter.groovy to catch unknown task exception when finding api task (flutter/flutter#157282) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from c4b0184c8783 to b413d9996c86 (1 revision) (flutter/flutter#157580) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from b1c2ba8c4d52 to c4b0184c8783 (1 revision) (flutter/flutter#157578) 2024-10-25 32538273+ValentinVignal@users.noreply.github.com Add test for `build_owner.0.dart` (flutter/flutter#157499) 2024-10-25 32538273+ValentinVignal@users.noreply.github.com Add tests for `focusable_action_detector.0.dart` (flutter/flutter#157575) 2024-10-25 32538273+ValentinVignal@users.noreply.github.com Add test for `navigator.restorable_push_and_remove_until.0.dart` (flutter/flutter#157487) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 29440ed1e225 to b1c2ba8c4d52 (1 revision) (flutter/flutter#157572) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 88716d804aef to 29440ed1e225 (1 revision) (flutter/flutter#157569) 2024-10-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from b8b28c80a737 to 88716d804aef (2 revisions) (flutter/flutter#157567) 2024-10-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from 48ff670d256b to b8b28c80a737 (2 revisions) (flutter/flutter#157564) 2024-10-24 matanlurey@users.noreply.github.com Use discenrable characters (replace `' ð�� ð�� '` in error logs) (flutter/flutter#157548) 2024-10-24 matanlurey@users.noreply.github.com Remove unused `PubDependenciesProjectValidator`. (flutter/flutter#157516) 2024-10-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Upgrade tests to AGP 8.7/Gradle 8.10.2/Kotlin 1.8.10 (#157032)" (flutter/flutter#157559) 2024-10-24 jonahwilliams@google.com Mark mac impeller as bringup. (flutter/flutter#157551) 2024-10-24 tessertaha@gmail.com Deprecate `ThemeData.dialogBackgroundColor` in favor of `DialogThemeData.backgroundColor` (flutter/flutter#155072) 2024-10-24 34871572+gmackall@users.noreply.github.com Upgrade tests to AGP 8.7/Gradle 8.10.2/Kotlin 1.8.10 (flutter/flutter#157032) 2024-10-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from 246344f26edc to 48ff670d256b (2 revisions) (flutter/flutter#157544) 2024-10-24 matanlurey@users.noreply.github.com Allow opting out of `.flutter-plugins`, opt-out in `refreshPluginsList`. (flutter/flutter#157527) 2024-10-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Reverts "Added a warning if `flutter.groovy` uses a `.flutter-plugins` file. (#157388)" (#157541)" (flutter/flutter#157549) 2024-10-24 50643541+Mairramer@users.noreply.github.com Changes the offset computation to first item for RenderSliverMainAxisGroup (flutter/flutter#154688) 2024-10-24 engine-flutter-autoroll@skia.org Roll Packages from 5e03bb1 to a556f0f (7 revisions) (flutter/flutter#157539) 2024-10-24 737941+loic-sharma@users.noreply.github.com Add partial test for flutter build ios-framework on non-module (flutter/flutter#157482) 2024-10-24 737941+loic-sharma@users.noreply.github.com Add example to SafeArea docs (flutter/flutter#157228) 2024-10-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Added a warning if `flutter.groovy` uses a `.flutter-plugins` file. (#157388)" (flutter/flutter#157541) 2024-10-24 matanlurey@users.noreply.github.com Added a warning if `flutter.groovy` uses a `.flutter-plugins` file. (flutter/flutter#157388) 2024-10-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from be56084344d1 to 246344f26edc (2 revisions) (flutter/flutter#157504) 2024-10-24 104349824+huycozy@users.noreply.github.com Add ability to disable CupertinoSegmentedControl (flutter/flutter#152813) 2024-10-24 tessertaha@gmail.com Update `Tab.height` parameter doc for tab height lower than default (flutter/flutter#157443) ...

Related to flutter/flutter#155072 PR deprecating `ThemeData.indicatorColor` flutter/flutter#160024 ## Presubmit checklist - [x] This PR is marked as draft with an explanation if not meant to land until a future stable release. - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour (ignore Sfshaza) <44418985+sfshaza2@users.noreply.github.com>

…ogThemeData.backgroundColor` (flutter/flutter#155072)

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. c: tech-debt Technical debt, code quality, testing, etc. labels Sep 12, 2024

TahaTesser mentioned this pull request Sep 12, 2024

Removed deprecated NavigatorState.focusScopeNode #139260

Merged

8 tasks

TahaTesser commented Sep 12, 2024

View reviewed changes

packages/flutter/test_fixes/widgets/widgets.dart Outdated Show resolved Hide resolved

Piinks reviewed Sep 12, 2024

View reviewed changes

packages/flutter/lib/src/material/theme_data.dart Outdated Show resolved Hide resolved

packages/flutter/test_fixes/material/theme_data.dart Show resolved Hide resolved

TahaTesser mentioned this pull request Sep 12, 2024

Remove ThemeData.dialogBackgroundColor usage flutter/cocoon#3901

Merged

8 tasks

QuncCccccc reviewed Sep 24, 2024

View reviewed changes

auto-submit bot pushed a commit to flutter/cocoon that referenced this pull request Sep 24, 2024

Remove ThemeData.dialogBackgroundColor usage (#3901)

f21b10f

Related flutter/flutter#155072

TahaTesser mentioned this pull request Oct 3, 2024

Update flutter_cocoon test flutter/tests#413

Merged

8 tasks

TahaTesser requested review from Piinks and QuncCccccc October 21, 2024 14:20

QuncCccccc approved these changes Oct 21, 2024

View reviewed changes

QuncCccccc mentioned this pull request Oct 21, 2024

☂️ Material Theme System Updates #91772

Open

43 tasks

TahaTesser changed the title ~~Deprecate ThemeData.dialogBackgroundColor in favor of DialogTheme.backgroundColor~~ Deprecate ThemeData.dialogBackgroundColor in favor of DialogThemeData.backgroundColor Oct 23, 2024

TahaTesser added 3 commits October 23, 2024 16:01

Deprecate ThemeData.dialogBackgroundColor in favor of `DialogThemeD…

d82a73c

…ata.backgroundColor`

Address feedback

0ce845a

Update version tag

316da37

TahaTesser mentioned this pull request Oct 23, 2024

Migration guide for ThemeData.dialogBackgroundColor deprecation flutter/website#11309

Merged

4 tasks

Piinks reviewed Oct 24, 2024

View reviewed changes

Address feedback

881aaab

TahaTesser requested a review from Piinks October 24, 2024 15:56

TahaTesser added 2 commits October 24, 2024 19:29

Revert ThemeData.raw fix

ced4b5b

Kick tests

52afde8

Piinks approved these changes Oct 24, 2024

View reviewed changes

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 24, 2024

auto-submit bot merged commit cdf4a2d into flutter:master Oct 24, 2024

TahaTesser deleted the deprecate_dialogBackgroundColor branch October 25, 2024 07:06

engine-flutter-autoroll mentioned this pull request Oct 25, 2024

Roll Flutter from 4faa4a415ec9 to 7e2a06657c1c (49 revisions) flutter/packages#7929

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 25, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

5d51eec

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll mentioned this pull request Oct 25, 2024

Roll Flutter from 4faa4a415ec9 to 23274284a7b5 (50 revisions) flutter/packages#7931

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 25, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

291c592

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll mentioned this pull request Oct 25, 2024

Roll Flutter from 4faa4a415ec9 to c4c545215ad9 (51 revisions) flutter/packages#7932

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 25, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

388965c

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll mentioned this pull request Oct 25, 2024

Roll Flutter from 4faa4a415ec9 to add7e81f4f5c (55 revisions) flutter/packages#7933

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 25, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

cc9a690

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll mentioned this pull request Oct 25, 2024

Roll Flutter from 4faa4a415ec9 to 6337eb1a3925 (56 revisions) flutter/packages#7934

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 25, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

c74cc64

…ogThemeData.backgroundColor` (flutter/flutter#155072)

Piinks mentioned this pull request Oct 25, 2024

Flutter Framework Team: Notable Commits #121415

Closed

engine-flutter-autoroll mentioned this pull request Oct 26, 2024

Roll Flutter from 4faa4a415ec9 to 9327c24d8086 (66 revisions) flutter/packages#7936

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 26, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

6490759

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll mentioned this pull request Oct 26, 2024

Roll Flutter from 4faa4a415ec9 to 5a11904383d1 (67 revisions) flutter/packages#7937

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 26, 2024

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

652dd15

…ogThemeData.backgroundColor` (flutter/flutter#155072)

TahaTesser mentioned this pull request Dec 10, 2024

Migration guide for ThemeData.indicatorColor deprecation flutter/website#11481

Merged

4 tasks

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

3766bec

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

53166a3

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

97f8320

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

243c295

…ogThemeData.backgroundColor` (flutter/flutter#155072)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025

cdf4a2d Deprecate ThemeData.dialogBackgroundColor in favor of `Dial…

2293aed

…ogThemeData.backgroundColor` (flutter/flutter#155072)

Deprecate ThemeData.dialogBackgroundColor in favor of DialogThemeData.backgroundColor #155072

Deprecate ThemeData.dialogBackgroundColor in favor of DialogThemeData.backgroundColor #155072

Uh oh!

Conversation

TahaTesser commented Sep 12, 2024

Pre-launch Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TahaTesser commented Sep 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TahaTesser commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Piinks commented Oct 16, 2024

Uh oh!

TahaTesser commented Oct 21, 2024

Uh oh!

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TahaTesser commented Oct 22, 2024

Uh oh!

TahaTesser commented Oct 23, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TahaTesser Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Deprecate `ThemeData.dialogBackgroundColor` in favor of `DialogThemeData.backgroundColor` #155072

Deprecate `ThemeData.dialogBackgroundColor` in favor of `DialogThemeData.backgroundColor` #155072

TahaTesser commented Oct 3, 2024 •

edited

Loading

TahaTesser Oct 24, 2024 •

edited

Loading