Fix showSnackBar can't access useMaterial3 from the theme by bleroux · Pull Request #157707 · flutter/flutter

bleroux · 2024-10-28T09:08:32Z

Description

This PR makes it possible for the MaterialApp built in ScaffoldMessenger state to access the ambient theme.

Before this PR, the built in messenger was above the theme.
After this PR, the build in messenger is below the theme.

Related Issue

Fixes Can't access useMaterial3 from the theme in the showSnackBar method

Tests

Adds 1 test.

justinmc · 2024-10-30T18:21:08Z

@nate-thegrate To review (from triage).

nate-thegrate

It's super great to see the simple fix, thank you!

I had an idea for the test and would love to hear your thoughts :)

nate-thegrate · 2024-10-30T19:41:31Z

packages/flutter/test/material/scaffold_test.dart

+    await tester.pumpWidget(MaterialApp(
+      theme: customTheme,
+      home: Scaffold(
+        body: Builder(
+          builder: (BuildContext context) {
+            return GestureDetector(
+              key: tapTarget,
+              onTap: () {
+                scaffoldMessenger = ScaffoldMessenger.maybeOf(context);
+              },
+              behavior: HitTestBehavior.opaque,
+              child: const SizedBox(
+                height: 100.0,
+                width: 100.0,
+              ),
+            );
+          },
+        ),
+      ),
+    ));
+
+    await tester.tap(find.byKey(tapTarget));
+    await tester.pump();
+
+    final ThemeData messengerTheme = Theme.of(scaffoldMessenger!.context);


I believe we could make use of MaterialApp's scaffoldMessengerKey parameter here:

Suggested change

await tester.pumpWidget(MaterialApp(

theme: customTheme,

home: Scaffold(

body: Builder(

builder: (BuildContext context) {

return GestureDetector(

key: tapTarget,

onTap: () {

scaffoldMessenger = ScaffoldMessenger.maybeOf(context);

},

behavior: HitTestBehavior.opaque,

child: const SizedBox(

height: 100.0,

width: 100.0,

),

);

},

),

),

));

await tester.tap(find.byKey(tapTarget));

await tester.pump();

final ThemeData messengerTheme = Theme.of(scaffoldMessenger!.context);

await tester.pumpWidget(

MaterialApp(

scaffoldMessengerKey: scaffoldMessengerKey,

theme: customTheme,

home: const SizedBox.shrink(),

),

);

final ThemeData messengerTheme = Theme.of(scaffoldMessengerKey.currentContext!);

Nice! I will make the change tomorrow morning (it is the evening here).

nate-thegrate · 2024-10-30T19:42:38Z

packages/flutter/test/material/scaffold_test.dart

-   testWidgets('ScaffoldMessenger showSnackBar default animation', (WidgetTester tester) async {
+  // Regression test for https://github.com/flutter/flutter/issues/115924.
+  testWidgets('Default ScaffoldMessenger can access ambient theme', (WidgetTester tester) async {
+    ScaffoldMessengerState? scaffoldMessenger;


Suggested change

ScaffoldMessengerState? scaffoldMessenger;

final GlobalKey<ScaffoldMessengerState> scaffoldMessengerKey = GlobalKey<ScaffoldMessengerState>();

packages/flutter/test/material/scaffold_test.dart

nate-thegrate · 2024-10-30T19:54:25Z

bleroux requested a review from Piinks

(Kate is out this week btw)

nate-thegrate

Thank you very much!

nate-thegrate · 2024-10-31T15:17:29Z

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

+      child: DefaultSelectionStyle(
+        selectionColor: effectiveSelectionColor,
+        cursorColor: effectiveCursorColor,
+        child: childWidget,
+      ),


Probably not in the scope of this PR, but I noticed that the Theme widget already builds a DefaultSelectionStyle:

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

Lines 132 to 142 in 16622e6

Widget _wrapsWidgetThemes(BuildContext context, Widget child) {

final DefaultSelectionStyle selectionStyle = DefaultSelectionStyle.of(context);

return IconTheme(

data: data.iconTheme,

child: DefaultSelectionStyle(

selectionColor: data.textSelectionTheme.selectionColor ?? selectionStyle.selectionColor,

cursorColor: data.textSelectionTheme.cursorColor ?? selectionStyle.cursorColor,

child: child,

),

);

}

Would be nice to remove the duplicate widget here at some point :)

…utter/flutter#157707)

flutter/flutter@0fe6153...f86b777 2024-11-01 [email protected] Roll Packages from 7cc1caa to 796afa3 (15 revisions) (flutter/flutter#158003) 2024-11-01 [email protected] Marks Linux_pixel_7pro service_extensions_test to be flaky (flutter/flutter#157853) 2024-11-01 [email protected] Roll Flutter Engine from 0a0d5c9be6ff to 3a090b46dd35 (1 revision) (flutter/flutter#157994) 2024-11-01 [email protected] Roll Flutter Engine from bacc5e1e73b7 to 0a0d5c9be6ff (3 revisions) (flutter/flutter#157991) 2024-11-01 [email protected] Add test for `interactive_viewer.transformation_controller.0.dart` (flutter/flutter#157986) 2024-11-01 [email protected] Roll Flutter Engine from d7e928911ac2 to bacc5e1e73b7 (1 revision) (flutter/flutter#157982) 2024-11-01 [email protected] Add test for `notification.0.dart` (flutter/flutter#157909) 2024-11-01 [email protected] performance: Override .elementAt in CachingIterable (flutter/flutter#152477) 2024-11-01 [email protected] Roll Flutter Engine from cd46383cd55e to d7e928911ac2 (4 revisions) (flutter/flutter#157978) 2024-11-01 [email protected] Roll Flutter Engine from bb77cf867aef to cd46383cd55e (11 revisions) (flutter/flutter#157972) 2024-11-01 [email protected] Add a warning/additional handlers for parsing`synthetic-package`. (flutter/flutter#157934) 2024-10-31 [email protected] Roll Flutter Engine from f2154ef3e31c to bb77cf867aef (6 revisions) (flutter/flutter#157960) 2024-10-31 [email protected] Renames `injectBuildTimePluginFilesForWebPlatform` and removes unused named parameter. (flutter/flutter#157944) 2024-10-31 [email protected] [flutter_driver] use mostly public screenshot API. (flutter/flutter#157888) 2024-10-31 [email protected] Made insetPadding configurable for Date Picker Dialog (flutter/flutter#155651) 2024-10-31 [email protected] Fix showSnackBar can't access useMaterial3 from the theme (flutter/flutter#157707) 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

…utter/flutter#157707)

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Oct 28, 2024

bleroux requested a review from Piinks October 28, 2024 19:25

justinmc requested a review from nate-thegrate October 30, 2024 18:21

nate-thegrate reviewed Oct 30, 2024

View reviewed changes

bleroux added 2 commits October 31, 2024 10:14

Fix showSnackBar can't access useMaterial3 from the theme

1cbbae5

Simplify test per Nate's suggestion

a1b4402

bleroux force-pushed the fix_default_ScaffoldMessenger_cannot_access_theme branch from fd4b72c to a1b4402 Compare October 31, 2024 09:19

bleroux requested a review from nate-thegrate October 31, 2024 14:36

nate-thegrate approved these changes Oct 31, 2024

View reviewed changes

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

auto-submit bot merged commit 5f65bd0 into flutter:master Oct 31, 2024

bleroux deleted the fix_default_ScaffoldMessenger_cannot_access_theme branch October 31, 2024 21:05

engine-flutter-autoroll mentioned this pull request Nov 1, 2024

Roll Flutter from 0fe615343bd9 to 2da2332ad1be (14 revisions) flutter/packages#7996

Closed

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

0c20b4c

…utter/flutter#157707)

engine-flutter-autoroll mentioned this pull request Nov 1, 2024

Roll Flutter from 0fe615343bd9 to f15913654977 (15 revisions) flutter/packages#7999

Closed

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

7df894d

…utter/flutter#157707)

engine-flutter-autoroll mentioned this pull request Nov 1, 2024

Roll Flutter from 0fe615343bd9 to f86b77721524 (16 revisions) flutter/packages#8000

Merged

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

6ca56ec

…utter/flutter#157707)

Piinks mentioned this pull request Nov 8, 2024

Flutter Framework Team: Notable Commits #121415

Closed

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

b323c61

…utter/flutter#157707)

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

b88723b

…utter/flutter#157707)

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

22786c7

…utter/flutter#157707)

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

c5d4ee6

…utter/flutter#157707)

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

5f65bd0 Fix showSnackBar can't access useMaterial3 from the theme (fl…

6aae629

…utter/flutter#157707)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix showSnackBar can't access useMaterial3 from the theme#157707

Fix showSnackBar can't access useMaterial3 from the theme#157707
auto-submit[bot] merged 2 commits intoflutter:masterfrom
NevercodeHQ:fix_default_ScaffoldMessenger_cannot_access_theme

bleroux commented Oct 28, 2024

Uh oh!

justinmc commented Oct 30, 2024

Uh oh!

nate-thegrate left a comment

Uh oh!

nate-thegrate Oct 30, 2024

Uh oh!

bleroux Oct 30, 2024

Uh oh!

nate-thegrate Oct 30, 2024

Uh oh!

Uh oh!

nate-thegrate commented Oct 30, 2024

Uh oh!

nate-thegrate left a comment

Uh oh!

nate-thegrate Oct 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	ScaffoldMessengerState? scaffoldMessenger;
	final GlobalKey<ScaffoldMessengerState> scaffoldMessengerKey = GlobalKey<ScaffoldMessengerState>();

	Widget _wrapsWidgetThemes(BuildContext context, Widget child) {
	final DefaultSelectionStyle selectionStyle = DefaultSelectionStyle.of(context);
	return IconTheme(
	data: data.iconTheme,
	child: DefaultSelectionStyle(
	selectionColor: data.textSelectionTheme.selectionColor ?? selectionStyle.selectionColor,
	cursorColor: data.textSelectionTheme.cursorColor ?? selectionStyle.cursorColor,
	child: child,
	),
	);
	}

Conversation

bleroux commented Oct 28, 2024

Description

Related Issue

Tests

Uh oh!

justinmc commented Oct 30, 2024

Uh oh!

nate-thegrate left a comment

Choose a reason for hiding this comment

Uh oh!

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

bleroux Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

nate-thegrate Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nate-thegrate commented Oct 30, 2024

Uh oh!

nate-thegrate left a comment

Choose a reason for hiding this comment

Uh oh!

nate-thegrate Oct 31, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants