Normalize Card theme #151914

QuncCccccc · 2024-07-17T20:47:15Z

This PR is to make preparations to make CardTheme conform to Flutter's conventions for component themes:

Added a CardThemeData class which defines overrides for the defaults for Card properties.
Added 2 CardTheme constructor parameters: CardThemeData? data and Widget? child. This is now the preferred way to configure a CardTheme:

CardTheme(
  data: CardThemeData(color: xxx, elevation: xxx, ...),
  child: Card(...)
)

These two properties are made nullable to not break existing apps which has customized ThemeData.cardTheme.

Changed the type of theme defaults from CardTheme to CardThemeData.

TODO:

Fix internal failures that may have breakages.
Change the type of ThemeData.cardTheme from CardTheme to CardThemeData. This may cause breaking changes, a migration guide will be created.

Addresses the "theme normalization" sub project within #91772

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.

TahaTesser

Great update for consistent API. LGTM!

guidezpl

Nice. I wonder if you can also introduce a fix now, for replacing individual properties

CardTheme(clipBehavior: ...) ⇒ CardTheme(data: CardThemeData(clipBehavior: ...))

guidezpl · 2024-07-26T06:17:55Z

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

+
+  /// Overrides the default value for [Card.clipBehavior].
+  ///
+  /// This property is obsolete: please use the [CardThemeData.clipBehavior]


here and below

Suggested change

/// This property is obsolete: please use the [CardThemeData.clipBehavior]

/// This property is obsolete and will be deprecated in a future release: please use the [CardThemeData.clipBehavior]

a fix

Dart fix can't help with this one unfortunately. We looked at it a bunch of ways, but since the class CardTheme itself will still exist undeprecated, we can't auto migrate it to CardThemeData.

guidezpl · 2024-07-26T06:18:21Z

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

+
+  /// Creates a copy of this object with the given fields replaced with the
+  /// new values.
+  CardTheme copyWith({


nit: add a mention that this will be deprecated

guidezpl · 2024-07-26T08:34:19Z

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

+  /// Linearly interpolate between two Card themes.
+  ///
+  /// {@macro dart.ui.shadow.lerp}
+  static CardTheme lerp(CardTheme? a, CardTheme? b, double t) {


nit: add a note that this will be deprecated

Manual roll requested by [email protected] flutter/flutter@9d5ede0...85960d2 2024-07-30 [email protected] Fix Shortcut label for CharacterActivator does not include modifiers (flutter/flutter#152233) 2024-07-30 [email protected] [wiki] Remove text saying wiki edits do not get code reviewed (flutter/flutter#152530) 2024-07-30 [email protected] Roll Flutter Engine from cb96743cc955 to c58d87d62c20 (1 revision) (flutter/flutter#152527) 2024-07-30 [email protected] Add `find.backButton` finder and `StandardComponentType` enum to find components in tests. (flutter/flutter#149349) 2024-07-30 [email protected] Roll Flutter Engine from 49324cd0b678 to cb96743cc955 (4 revisions) (flutter/flutter#152524) 2024-07-30 [email protected] [devicelab] remove Skia specific and unused devicelab metrics. (flutter/flutter#152523) 2024-07-30 [email protected] Add Dimil Kalathiya to authors (flutter/flutter#152491) 2024-07-29 [email protected] Roll Flutter Engine from 240fb460675d to 49324cd0b678 (4 revisions) (flutter/flutter#152521) 2024-07-29 [email protected] Stop CupertinoScrollbar's track from paging the scroll view on tap (flutter/flutter#152197) 2024-07-29 [email protected] Roll Flutter Engine from 4ef0f0d988ec to 240fb460675d (1 revision) (flutter/flutter#152507) 2024-07-29 [email protected] Roll Flutter Engine from a0219f7a429c to 4ef0f0d988ec (1 revision) (flutter/flutter#152505) 2024-07-29 [email protected] [flutter_tools] remove raster stats CLI option. (flutter/flutter#152501) 2024-07-29 [email protected] Shift some mac Android tests to Mokey devices in staging (flutter/flutter#152499) 2024-07-29 [email protected] [devicelab] enable impeller in external texture test. (flutter/flutter#152502) 2024-07-29 [email protected] Roll Flutter Engine from d1995f302c4d to a0219f7a429c (2 revisions) (flutter/flutter#152500) 2024-07-29 [email protected] Roll Flutter Engine from d803bb16c8b0 to d1995f302c4d (4 revisions) (flutter/flutter#152496) 2024-07-29 [email protected] Normalize Card theme (flutter/flutter#151914) 2024-07-29 [email protected] Roll Flutter Engine from 2db47a1f3d0d to d803bb16c8b0 (1 revision) (flutter/flutter#152489) 2024-07-29 [email protected] Roll Packages from 3d358d9 to 247fb5f (8 revisions) (flutter/flutter#152488) 2024-07-29 [email protected] Update New-Android-version.md (flutter/flutter#152395) 2024-07-29 [email protected] Roll Flutter Engine from 510f19a7e629 to 2db47a1f3d0d (1 revision) (flutter/flutter#152485) 2024-07-29 [email protected] Roll Flutter Engine from 87cbf33b9028 to 510f19a7e629 (1 revision) (flutter/flutter#152473) 2024-07-29 [email protected] Roll Flutter Engine from 2cf3986cae52 to 87cbf33b9028 (2 revisions) (flutter/flutter#152469) 2024-07-29 [email protected] Add tests for deletable_chip_attributes.on_deleted.0.dart (flutter/flutter#152361) 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 [email protected],[email protected] 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 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

This PR is to make preparations to make `CardTheme` conform to Flutter's conventions for component themes: * Added a `CardThemeData` class which defines overrides for the defaults for `Card` properties. * Added 2 `CardTheme` constructor parameters: `CardThemeData? data` and `Widget? child`. This is now the preferred way to configure a `CardTheme`: ```dart CardTheme( data: CardThemeData(color: xxx, elevation: xxx, ...), child: Card(...) ) ``` These two properties are made nullable to not break existing apps which has customized `ThemeData.cardTheme`. * Changed the type of theme defaults from `CardTheme` to `CardThemeData`. TODO: * Fix internal failures that may have breakages. * Change the type of `ThemeData.cardTheme` from `CardTheme` to `CardThemeData`. This may cause breaking changes, a migration guide will be created. Addresses the "theme normalization" sub project within flutter#91772

@deprecated

Following #151914, this PR is to normalize `ThemeData.cardTheme`; change the `CardTheme cardTheme` property to `CardThemeData cardTheme` in `ThemeData`. In `ThemeData()` and `ThemeData.copyWith()`, the `cardTheme` parameter type is changed to `Object?` to accept both `CardTheme` and `CardThemeData` so that we won't cause immediate breaking change and make sure rolling is smooth. Once all component themes are normalized, these `Object?` types should be changed to `xxxThemeData`. There's no way to create a dart fix because we can't add a "@deprecated" label for `CardTheme` because `CardTheme` is a new InheritedWidget subclass now. Addresses the "theme normalization" sub project within #91772

QuncCccccc force-pushed the normalize_card_theme branch from 1fabdb3 to dd7b041 Compare July 22, 2024 17:19

QuncCccccc mentioned this pull request Jul 22, 2024

☂️ Material Theme System Updates #91772

Open

42 tasks

QuncCccccc force-pushed the normalize_card_theme branch 2 times, most recently from 9605643 to ef8f64b Compare July 25, 2024 19:07

QuncCccccc requested review from Piinks, guidezpl and TahaTesser July 25, 2024 20:01

QuncCccccc marked this pull request as ready for review July 25, 2024 20:01

TahaTesser approved these changes Jul 26, 2024

View reviewed changes

guidezpl reviewed Jul 26, 2024

View reviewed changes

QuncCccccc added 2 commits July 28, 2024 17:33

Add CardThemeData and make CardTheme subclass of InheritedWidget

f91d378

Fix PR comments

f16e813

QuncCccccc force-pushed the normalize_card_theme branch from 3986622 to f16e813 Compare July 29, 2024 00:33

QuncCccccc requested a review from guidezpl July 29, 2024 06:18

guidezpl approved these changes Jul 29, 2024

View reviewed changes

QuncCccccc added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 29, 2024

auto-submit bot merged commit 2e7fa83 into flutter:master Jul 29, 2024
132 checks passed

engine-flutter-autoroll mentioned this pull request Jul 29, 2024

Roll Flutter from 031dc3d156b9 to 2e7fa83f6776 (33 revisions) flutter/packages#7251

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

a4aa194

engine-flutter-autoroll mentioned this pull request Jul 29, 2024

Roll Flutter from 031dc3d156b9 to 634ff77381c2 (34 revisions) flutter/packages#7252

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

02a125a

engine-flutter-autoroll mentioned this pull request Jul 30, 2024

Roll Flutter from 031dc3d156b9 to 85960d24b9d2 (49 revisions) flutter/packages#7254

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

7e5de41

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Flutter from 031dc3d156b9 to 27e53c813c13 (68 revisions) flutter/packages#7261

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

30ba129

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Flutter from 031dc3d156b9 to 14a607cbabb1 (69 revisions) flutter/packages#7262

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

7e22bbb

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Flutter from 031dc3d156b9 to 86a4c939971a (70 revisions) flutter/packages#7263

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

4d5c14f

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Flutter from 031dc3d156b9 to fdb8ebfeacf8 (71 revisions) flutter/packages#7264

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

eee83f9

engine-flutter-autoroll mentioned this pull request Jul 31, 2024

Roll Flutter from 031dc3d156b9 to 836e794b466a (72 revisions) flutter/packages#7265

Closed

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

e92fbb6

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

bce7253

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

e1009e0

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

3c96601

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

c6eaf7e

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

4a6f531

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

5b723d9

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

5ced1f8

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

7f1b128

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

e005f38

engine-flutter-autoroll mentioned this pull request Aug 2, 2024

Manual roll Flutter from 9d5ede0f5ae5 to 85960d24b9d2 (24 revisions) flutter/packages#7295

Merged

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

88c4a13

QuncCccccc mentioned this pull request Aug 12, 2024

Normalize ThemeData.cardTheme #153254

Merged

9 tasks

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

8e0b9f9

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

2e7fa83 Normalize Card theme (flutter/flutter#151914)

e6dcfe7

FMorschel mentioned this pull request May 8, 2025

New annotations for enforcing types dart-lang/sdk#60693

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Normalize Card theme #151914

Normalize Card theme #151914

QuncCccccc commented Jul 17, 2024 •

edited

Loading

TahaTesser left a comment

guidezpl left a comment

guidezpl Jul 26, 2024

Piinks Jul 26, 2024

guidezpl Jul 26, 2024

guidezpl Jul 26, 2024

	/// This property is obsolete: please use the [CardThemeData.clipBehavior]
	/// This property is obsolete and will be deprecated in a future release: please use the [CardThemeData.clipBehavior]

Normalize Card theme #151914

Normalize Card theme #151914

Conversation

QuncCccccc commented Jul 17, 2024 • edited Loading

Pre-launch Checklist

TahaTesser left a comment

Choose a reason for hiding this comment

guidezpl left a comment

Choose a reason for hiding this comment

guidezpl Jul 26, 2024

Choose a reason for hiding this comment

Piinks Jul 26, 2024

Choose a reason for hiding this comment

guidezpl Jul 26, 2024

Choose a reason for hiding this comment

guidezpl Jul 26, 2024

Choose a reason for hiding this comment

QuncCccccc commented Jul 17, 2024 •

edited

Loading