Normalize BottomAppBarTheme #168586

huycozy · 2025-05-09T07:58:45Z

This PR is to make BottomAppBarTheme conform to Flutter Material's conventions for component themes:

Added a BottomAppBarThemeData class which defines overrides for the defaults for BottomAppBar properties.
Added BottomAppBarTheme constructor parameters: BottomAppBarThemeData? data and Widget? child. This is now the preferred way to configure a BottomAppBarTheme:

BottomAppBarTheme(
	data: BottomAppBarThemeData(
	    color: xxx,
	    height: xxx,
	    elevation: xxx,
	    shape: xxx,
	    ...
	  ),
  	child: const BottomAppBar()
)

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

Update BottomAppBarTheme to be an InheritedWidget subclass.
Changed the type of component theme defaults from BottomAppBarTheme to BottomAppBarThemeData.
Changed the BottomAppBarTheme bottomAppBarTheme property to BottomAppBarThemeData bottomAppBarTheme in ThemeData and ThemeData.copyWith(). This may cause breaking changes, a migration guide will be created on website repo.
Add new tests for BottomAppBarThemeData and update the existing BottomAppBarTheme tests. And also turn to true for useMaterial3 (along with usages accordingly) at the common method _withTheme() since useMaterial3 is true by default.
Addresses the "theme normalization" sub-project within ☂️ Material Theme System Updates #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.

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

QuncCccccc

Thank you so much for helping make some progress on the theme system cleanup!! This looks great! Just left some comments.

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

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

Signed-off-by: huycozy <[email protected]>

…pBarTheme Signed-off-by: huycozy <[email protected]>

QuncCccccc

LGTM! Thanks for helping add this! ~~Please do not submit this for now. Let's see if the google testing will be triggered. The test recently is not super stable.~~

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

…pBarTheme Signed-off-by: huycozy <[email protected]>

Signed-off-by: huycozy <[email protected]>

huycozy · 2025-05-14T04:20:26Z

Thanks to @bleroux's PR #168724, spotted out a few places that need cleanup here too! Pushed a commit 766c94f for this.

flutter/flutter@0b9f928...9a78af5 2025-05-15 [email protected] Manual pub package roll (flutter/flutter#168916) 2025-05-15 [email protected] Remove unnecessary `bringup: true` for release-channel only `Linux flutter_packaging`. (flutter/flutter#168761) 2025-05-15 [email protected] Revert: "Run `flutter_packaging` builders on release candidates (flutter/flutter#168917) 2025-05-15 [email protected] Roll Dart SDK from a6c25e31caa7 to c9640c3a4440 (1 revision) (flutter/flutter#168911) 2025-05-15 [email protected] Roll Packages from 1468581 to 2dff621 (4 revisions) (flutter/flutter#168908) 2025-05-15 [email protected] Roll Dart SDK from b3520981e0f0 to a6c25e31caa7 (11 revisions) (flutter/flutter#168895) 2025-05-15 [email protected] Roll Fuchsia Linux SDK from fSvuEJgRmHxnewRJr... to Jj-iDG5uPOsFgY2_H... (flutter/flutter#168893) 2025-05-15 [email protected] Fix mac_ios_engine_ddm config with missing ci/ios_debug_sim_ddm config (flutter/flutter#168888) 2025-05-15 [email protected] [native assets] Remove `KernelSnapshot` dependency in build (flutter/flutter#168742) 2025-05-15 [email protected] iOS,macOS: Migrate logging to Logger/FlutterLogger (flutter/flutter#168568) 2025-05-15 [email protected] Skip hot reload breakpoints test when running with web (flutter/flutter#168873) 2025-05-15 [email protected] CupertinoSliverNavigationBar respects accessibility text scaling (flutter/flutter#168866) 2025-05-15 [email protected] [display_list] paint cleanup. (flutter/flutter#168082) 2025-05-15 [email protected] Add a new CI build for iOS DDM-enabled artifacts (flutter/flutter#168717) 2025-05-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396)" (flutter/flutter#168880) 2025-05-14 [email protected] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (flutter/flutter#168396) 2025-05-14 [email protected] Mark web_tool_tests_1_2 as bringup. (flutter/flutter#168871) 2025-05-14 [email protected] Marks Mac_mokey run_debug_test_android to be unflaky (flutter/flutter#167634) 2025-05-14 [email protected] Reland "Clip search artifacts in CupertinoSliverNavigationBar searchable-to-searchable transitions" (flutter/flutter#168772) 2025-05-14 [email protected] Remove references to `team-release`. (flutter/flutter#168780) 2025-05-14 [email protected] Make Cupertino sheet set the systemUIStyle through an AnnotatedRegion (flutter/flutter#168182) 2025-05-14 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Use live region in error text input decorator for Android (#165531)" (flutter/flutter#168848) 2025-05-14 [email protected] Normalize BottomAppBarTheme (flutter/flutter#168586) 2025-05-14 [email protected] Roll Packages from 2e166de to 1468581 (2 revisions) (flutter/flutter#168828) 2025-05-14 [email protected] macOS,iOS: fix swift target triple (flutter/flutter#168749) 2025-05-14 [email protected] Further update `Engine-artifacts.md`. (flutter/flutter#168779) 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] 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

QuncCccccc · 2025-05-15T22:24:59Z

I'll be working on fixing the google testing once the PR to change theme type from Object? to BottomAppBarThemeData is ready:) No rush at all!!

huycozy · 2025-05-16T07:19:14Z

I'll be working on fixing the google testing once the PR to change theme type from Object? to BottomAppBarThemeData is ready:) No rush at all!!

Thank you! I filed #168966 following this.

This is following #168586: See #168586 (comment) for the context of this. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md Signed-off-by: huycozy <[email protected]>

rydmike · 2025-05-25T15:13:48Z

FYI @huycozy, this change breaks builds using the FlexColorScheme package, as have all past migrations of this type.

See report: rydmike/flex_color_scheme#283

The package in a few places returns:

BottomAppBarTheme bottomAppBarTheme(...) {... return BottomAppBarTheme(...)}

To create a custom version of BottomAppBarTheme (Data).

The package also requires explicit type specifications of all types, which this migration does not consider. Because of this, this change breaks any build that uses lint require_all_types, like Flutter repo does, and happens to specify and return the old none "normalized" class BottomAppBarTheme for the bottom app bars's component theme data.

The fix is of course simple enough, just change all refs to BottomAppBarTheme with BottomAppBarThemeData. However, as the usage of BottomAppBarThemeData for this purpose is not included in latest stable Flutter (3.32.x) there is no way to release a single package version that supports Flutter stable and master channels at the same time.

This of course may cause friction among FlexColorScheme users that venture to the master channel, as shown in example issue above.

For most of the the earlier component theme normalizations, I noticed that the parallel usage of both ComponentXTheme and ComponentXThemeData, had first been allowed to reach stable channel, before the ComponentXThemeData was removed from the API in master channel.

This way an update to use the new ComponentXThemeData could be released in packages, that was compatible with latest stable and beta/master at same time. Not so in this case.

Why was this not done in this case?

The change of course also updates a number of internal tests that would fail and not compile if they had not been fixed. Which of course is one of the marks of a breaking change.

huycozy · 2025-05-26T06:23:58Z

Thanks for sharing your case, @rydmike!

However, as the usage of BottomAppBarThemeData for this purpose is not included in latest stable Flutter (3.32.x) there is no way to release a single package version that supports Flutter stable and master channels at the same time.

Along with this PR, I also filed the breaking change documentation PR at flutter/website#12057 ( it's not ready for review yet as I need to wait for #169130 (AppBarTheme normalization) and #168981 (InputDecorationTheme normalization) to land first. And I'm unfortunately also not sure which stable or beta release will pack this commit.

For most of the the earlier component theme normalizations, I noticed that the parallel usage of both ComponentXTheme and ComponentXThemeData, had first been allowed to reach stable channel, before the ComponentXThemeData was removed from the API in master channel.

This way an update to use the new ComponentXThemeData could be released in packages, that was compatible with latest stable and beta/master at same time. Not so in this case.

This sounds a bit strange compared to the release process I'm familiar with, see Flutter's channels. Could you please elaborate on this? Typically, the fix/commit is landed on main/master first, then beta and stable. Maybe @QuncCccccc can help us figure out how to achieve this or verify if this is correct and helpful for users in the release process, and for similar PRs in the future (if there are any more)?

QuncCccccc · 2025-05-29T19:56:38Z

For most of the the earlier component theme normalizations, I noticed that the parallel usage of both ComponentXTheme and ComponentXThemeData, had first been allowed to reach stable channel, before the ComponentXThemeData was removed from the API in master channel.

This way an update to use the new ComponentXThemeData could be released in packages, that was compatible with latest stable and beta/master at same time. Not so in this case.

Sorry for the inconvenience! I think we kept BottomAppBarTheme actually in this PR. We currently don't have any plan to remove the existing properties in BottomAppBarTheme so we should be able to use them. Could you provide some code sample how this PR causes the breakages? We can help to fix them if needed!

This PR #168966 will cause breaking changes because we change the type of ThemeData.bottomAppBarTheme from Object? to BottomAppBarThemeData. @huycozy Maybe we can push the migration guide now for bottomAppBarTheme normalization, and then keep updating it once the other 2 components are ready:)

huycozy requested review from Piinks and QuncCccccc May 9, 2025 07:58

huycozy self-assigned this May 9, 2025

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels May 9, 2025

huycozy removed request for Piinks and QuncCccccc May 9, 2025 08:56

huycozy marked this pull request as draft May 9, 2025 08:56

This comment was marked as outdated.

Sign in to view

huycozy force-pushed the bottom-appbar-theme-normalization branch 3 times, most recently from 20bdbc2 to 71d59a6 Compare May 9, 2025 11:53

huycozy marked this pull request as ready for review May 9, 2025 14:30

QuncCccccc self-requested a review May 9, 2025 17:16

QuncCccccc reviewed May 9, 2025

View reviewed changes

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

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

huycozy added 4 commits May 12, 2025 18:19

Normalize BottomAppBarTheme

8791d8f

Signed-off-by: huycozy <[email protected]>

Normalize BottomAppBarTheme - refactor associates

41a07b2

Signed-off-by: huycozy <[email protected]>

Normalize BottomAppBarTheme - add and update tests

c700dbc

Signed-off-by: huycozy <[email protected]>

Normalize BottomAppBarTheme - update template

fa0051b

Signed-off-by: huycozy <[email protected]>

huycozy force-pushed the bottom-appbar-theme-normalization branch from 71d59a6 to 5270b9c Compare May 12, 2025 11:42

Temporarily change BottomAppBarThemeData to Object? type for bottomAp…

d178dbd

…pBarTheme Signed-off-by: huycozy <[email protected]>

huycozy force-pushed the bottom-appbar-theme-normalization branch from 5270b9c to d178dbd Compare May 12, 2025 15:39

QuncCccccc approved these changes May 12, 2025

View reviewed changes

QuncCccccc reviewed May 12, 2025

View reviewed changes

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

huycozy force-pushed the bottom-appbar-theme-normalization branch from 1328134 to 43c1667 Compare May 13, 2025 06:28

Temporarily change BottomAppBarThemeData to Object? type for bottomAp…

4d071ab

…pBarTheme Signed-off-by: huycozy <[email protected]>

huycozy force-pushed the bottom-appbar-theme-normalization branch from 43c1667 to 4d071ab Compare May 13, 2025 07:55

Cleanup typos and references to ThemeData class

766c94f

Signed-off-by: huycozy <[email protected]>

huycozy requested a review from QuncCccccc May 14, 2025 04:21

auto-submit bot added this pull request to the merge queue May 14, 2025

Merged via the queue into flutter:master with commit 494b08b May 14, 2025
150 of 151 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 14, 2025

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

75ac742

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to 1d8078552d99 (21 revisions) flutter/packages#9253

Closed

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

68de6cb

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to d69edc303b49 (22 revisions) flutter/packages#9255

Closed

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

d272c20

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to a164f6538603 (23 revisions) flutter/packages#9256

Closed

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

db8bf29

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to 94c661082cc3 (24 revisions) flutter/packages#9257

Closed

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

ebd279b

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to 9214ed12dbae (25 revisions) flutter/packages#9258

Closed

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

494b08b42 Normalize BottomAppBarTheme (flutter/flutter#168586)

d26985c

engine-flutter-autoroll mentioned this pull request May 15, 2025

Roll Flutter from 0b9f9288caf3 to 9a78af5eb067 (26 revisions) flutter/packages#9259

Merged

This was referenced May 16, 2025

Normalize BottomAppBarTheme (continue) #168963

Closed

Normalize BottomAppBarTheme (continue) #168966

Merged

guidezpl mentioned this pull request Jan 28, 2025

☂️ Material Theme System Updates #91772

Open

42 tasks

Piinks mentioned this pull request May 16, 2025

Flutter Notable Commits - 2025 #161460

Open

huycozy deleted the bottom-appbar-theme-normalization branch May 19, 2025 04:11

huycozy mentioned this pull request May 20, 2025

Normalize AppBarTheme #169130

Open

9 tasks

rydmike mentioned this pull request May 25, 2025

flex_color_scheme v8.2.0 broken in Flutter 3.33 rydmike/flex_color_scheme#283

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Normalize BottomAppBarTheme #168586

Normalize BottomAppBarTheme #168586

Uh oh!

huycozy commented May 9, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

QuncCccccc left a comment

Uh oh!

Uh oh!

Uh oh!

QuncCccccc left a comment •

edited

Loading

Uh oh!

Uh oh!

huycozy commented May 14, 2025

Uh oh!

Uh oh!

QuncCccccc commented May 15, 2025

Uh oh!

huycozy commented May 16, 2025

Uh oh!

rydmike commented May 25, 2025 •

edited

Loading

Uh oh!

huycozy commented May 26, 2025

Uh oh!

QuncCccccc commented May 29, 2025

Uh oh!

Uh oh!

Normalize BottomAppBarTheme #168586

Normalize BottomAppBarTheme #168586

Uh oh!

Conversation

huycozy commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

This comment was marked as outdated.

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

QuncCccccc left a comment • 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!

Uh oh!

huycozy commented May 14, 2025

Uh oh!

Uh oh!

QuncCccccc commented May 15, 2025

Uh oh!

huycozy commented May 16, 2025

Uh oh!

rydmike commented May 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

huycozy commented May 26, 2025

Uh oh!

QuncCccccc commented May 29, 2025

Uh oh!

Uh oh!

huycozy commented May 9, 2025 •

edited

Loading

QuncCccccc left a comment •

edited

Loading

rydmike commented May 25, 2025 •

edited

Loading