Add bottomSheetScrimBuilder to Scaffold by alex-medinsh · Pull Request #167335 · flutter/flutter

alex-medinsh · 2025-04-17T09:13:29Z

Adds a new Scaffold param bottomSheetScrimBuilder that allows to define a custom scrim instead of the default ModalBarrier.

Fixes #109037

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.

alex-medinsh · 2025-04-17T09:17:41Z

I am not sure if allowing null as a return value is necessary or desired, but it can make it easier for folks who want to just remove the scrim. Otherwise they would need to return a SizedBox.shrink() or something similar.

I'll add another test to check for null if we decide to allow it.

justinmc

I'm a fan of exposing a builder function like this as opposed to exposing a parameter for the barrier color or something like that.

I wonder if @QuncCccccc or anyone else has an opinion on whether exposing this is worth the maintenance cost? It seems like a yes from me by looking at the issue. It seems like a reasonable use case that is not currently doable without this new parameter.

justinmc

Thanks for the changes. Some comments but I like the new approach with a default builder.

alex-medinsh · 2025-04-22T06:50:41Z

Hi @justinmc! I have made the requested changes. Please take a look when you have the time. Thanks!

justinmc · 2025-04-25T16:22:18Z

@RepliedSage11 It looks like there is a legit docs failure, can you take a look?

alex-medinsh · 2025-04-25T21:39:12Z

@justinmc Tests are now passing

justinmc · 2025-05-09T23:04:49Z

Sorry for the delay, I owe you a re-review here next week.

justinmc

LGTM 👍. I'll look for a secondary reviewer.

I really like the API now. Builder method that takes an animation and has a static default 👍

justinmc · 2025-05-12T18:51:18Z

+  ///
+  /// The builder receives the current [BuildContext] and an [Animation] as parameters.
+  /// The [Animation] ranges from 0.0 to 1.0 based on how much the bottom sheet covers the screen.
+  /// A value of 0.0 represents when the bottom sheet covers 70% of the screen,


Where does that 70% value come from, is there a constant somewhere? Maybe the docs are fine as-is but I'm curious myself.

It comes from 1 - _kBottomSheetDominatesPercentage. I wouldn't be able to tell you why it is 0.7 though🙂. I guess it is some material guideline?

Thinking about this, maybe some folks would want to animate the whole extent (so from 0% to 100%)? 70% to 100% is ok for the default builder, but might feel a bit limiting and arbitrary for custom builders?

True, but probably not in this PR. I'd wait until we know it's useful before building it.

This animation could be considered as fully opened to fully closed, wherever that is.

QuncCccccc

LGTM. Thanks for your contribution:)

QuncCccccc · 2025-05-21T17:44:40Z

Seems google testing keeps showing errors in all recent PRs. Rebased master to trigger the tests again.

auto-submit · 2025-05-21T18:02:58Z

autosubmit label was removed for flutter/flutter/167335, because - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

Roll Flutter from 33cdd8e to 85564cb (39 revisions) flutter/flutter@33cdd8e...85564cb 2025-05-23 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#169276)" (flutter/flutter#169347) 2025-05-23 [email protected] Roll Skia from a01ea49f53a4 to 956fd8b14e22 (1 revision) (flutter/flutter#169334) 2025-05-23 [email protected] Roll Dart SDK from 4de10a11ceb9 to 085f110ecf33 (1 revision) (flutter/flutter#169333) 2025-05-23 [email protected] Roll Skia from bcc7e7fce10e to a01ea49f53a4 (1 revision) (flutter/flutter#169329) 2025-05-23 [email protected] Roll Skia from 18b85aced9b7 to bcc7e7fce10e (3 revisions) (flutter/flutter#169323) 2025-05-23 [email protected] Roll Dart SDK from 2a45b2f88a4f to 4de10a11ceb9 (2 revisions) (flutter/flutter#169322) 2025-05-23 [email protected] Remove patching of `package_config.json` from Flutter Pub wrapper. (flutter/flutter#169306) 2025-05-23 [email protected] Add missing dart_dynamic_modules flag for iOS DDM simulator builds (flutter/flutter#169254) 2025-05-23 [email protected] Roll Skia from ea73ccdc1417 to 18b85aced9b7 (6 revisions) (flutter/flutter#169315) 2025-05-23 [email protected] Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack (flutter/flutter#159133) 2025-05-23 [email protected] [Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (flutter/flutter#169276) 2025-05-23 [email protected] Roll Dart SDK from 8f85d89fdc23 to 2a45b2f88a4f (6 revisions) (flutter/flutter#169312) 2025-05-23 [email protected] Removes unnecessary parentheses (flutter/flutter#169015) 2025-05-22 [email protected] Unpin test/test_core/test_api packages (flutter/flutter#169198) 2025-05-22 [email protected] [Engine] Fix an edge case of RoundSuperellipseParam::Contains with sharp corners (flutter/flutter#167977) 2025-05-22 [email protected] Replace goldens in test/cupertino/nav_bar_transition_test.dart (flutter/flutter#169172) 2025-05-22 [email protected] Roll Skia from 13a299964c9f to ea73ccdc1417 (35 revisions) (flutter/flutter#169303) 2025-05-22 [email protected] Increase sub-task timeout for Mac web_tool_tests (flutter/flutter#169307) 2025-05-22 [email protected] Fix crash on two finger selection gesture (flutter/flutter#168598) 2025-05-22 [email protected] Disable the ability to opt-out of `explicit-package-dependencies`. (flutter/flutter#169283) 2025-05-22 [email protected] Fixes tab semantics gets dropped if the child produce a semantics node (flutter/flutter#169233) 2025-05-22 [email protected] Skip `{PLAT}_web_tools_test#expression_evaluation_*_test.dart`, turning tree 🔴 (flutter/flutter#169305) 2025-05-22 [email protected] Update tool-internal `generateLocalizations...()` to never use synthetic (`flutter_gen`) packages (flutter/flutter#169285) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Make `build_android_host_app_with_module_aar` build using an aar (#169171)" (flutter/flutter#169287) 2025-05-22 [email protected] Increase sub-task timeout for `web_tool_tests_1_2` (flutter/flutter#169277) 2025-05-22 [email protected] refactor the usage of `MediaQuery.sizeOf(context).height` to use the new `.heightOf(context)` (flutter/flutter#168894) 2025-05-22 [email protected] [tool] Add --no-minify flag to JS Compiler (flutter/flutter#169102) 2025-05-22 [email protected] Update ButtonStyle documentation (flutter/flutter#168062) 2025-05-22 [email protected] Fix the issue where DropdownMenu disposes of the controller. (flutter/flutter#168541) 2025-05-22 [email protected] Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (#168914)" (flutter/flutter#169250) 2025-05-21 [email protected] Roll Dart SDK from 56940edd099d to 8f85d89fdc23 (6 revisions) (flutter/flutter#169237) 2025-05-21 [email protected] Use gestureSettings.touchSlop in PrimaryPointerGestureRecognizer (flutter/flutter#161549) 2025-05-21 [email protected] Normalize BottomAppBarTheme (continue) (flutter/flutter#168966) 2025-05-21 [email protected] [Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (flutter/flutter#168914) 2025-05-21 [email protected] Respect `calendarDelegate` in `showDateRangePicker` (flutter/flutter#168290) 2025-05-21 [email protected] Make `build_android_host_app_with_module_aar` build using an aar (flutter/flutter#169171) 2025-05-21 [email protected] Roll Dart SDK from 7c40eba6bf77 to 56940edd099d (flutter/flutter#169135) 2025-05-21 [email protected] Feat: Add full screen dialog support for dialog routes (flutter/flutter#167794) 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. ...

github-actions Bot added framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages labels Apr 17, 2025

justinmc reviewed Apr 18, 2025

View reviewed changes

Comment thread packages/flutter/lib/src/material/scaffold.dart Outdated

Comment thread packages/flutter/lib/src/material/scaffold.dart Outdated

alex-medinsh marked this pull request as ready for review April 18, 2025 17:36

justinmc reviewed Apr 18, 2025

View reviewed changes

Comment thread packages/flutter/lib/src/material/scaffold.dart Outdated

Comment thread packages/flutter/lib/src/material/scaffold.dart Outdated

Comment thread packages/flutter/lib/src/material/scaffold.dart Outdated

alex-medinsh requested a review from matanlurey as a code owner April 18, 2025 22:39

github-actions Bot added engine flutter/engine related. See also e: labels. f: scrolling Viewports, list views, slivers, etc. and removed engine flutter/engine related. See also e: labels. f: scrolling Viewports, list views, slivers, etc. labels Apr 18, 2025

alex-medinsh force-pushed the fix-109037 branch 2 times, most recently from aa45a84 to bf0e785 Compare April 18, 2025 23:14

matanlurey removed their request for review April 18, 2025 23:26

alex-medinsh force-pushed the fix-109037 branch 3 times, most recently from 9d3d9f2 to a62a46d Compare April 19, 2025 07:35

alex-medinsh force-pushed the fix-109037 branch 2 times, most recently from 918cb50 to 3016513 Compare April 22, 2025 19:38

justinmc requested a review from QuncCccccc April 25, 2025 16:22

alex-medinsh force-pushed the fix-109037 branch from 09f5bfe to b67d9c5 Compare April 25, 2025 19:06

justinmc approved these changes May 12, 2025

View reviewed changes

QuncCccccc approved these changes May 21, 2025

View reviewed changes

QuncCccccc added the autosubmit Merge PR when tree becomes green via auto submit App label May 21, 2025

alex-medinsh added 2 commits May 21, 2025 11:23

docs

52c557a

fix docs

179bca6

dkwingsmt force-pushed the fix-109037 branch from cd64363 to 179bca6 Compare May 21, 2025 18:23

QuncCccccc added the autosubmit Merge PR when tree becomes green via auto submit App label May 21, 2025

auto-submit Bot added this pull request to the merge queue May 22, 2025

Merged via the queue into flutter:master with commit fa24a71 May 22, 2025

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

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

Roll Flutter from 33cdd8ef31dc to e78b434e8f08 (12 revisions) flutter/packages#9307

Closed

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

dd1d229

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

426aee7

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

Roll Flutter from 33cdd8ef31dc to cb3150f99848 (13 revisions) flutter/packages#9308

Closed

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

a10d2ec

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

Roll Flutter from 33cdd8ef31dc to 5fd7aa2ed70d (16 revisions) flutter/packages#9309

Closed

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

9921b4a

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

Roll Flutter from 33cdd8ef31dc to d5ae7839620b (38 revisions) flutter/packages#9314

Closed

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

09ba6a0

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

Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (39 revisions) flutter/packages#9315

Merged

Piinks mentioned this pull request May 23, 2025

Flutter Notable Commits - 2025 #161460

Closed

alex-medinsh deleted the fix-109037 branch July 2, 2025 08:02

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

354bec5

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

cc1ed31

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

e540062

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

3944e3c

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

fa24a71 Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335)

3311099

Conversation

alex-medinsh commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

alex-medinsh commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alex-medinsh commented Apr 22, 2025

Uh oh!

justinmc commented Apr 25, 2025

Uh oh!

alex-medinsh commented Apr 25, 2025

Uh oh!

justinmc commented May 9, 2025

Uh oh!

justinmc 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!

justinmc May 12, 2025

Choose a reason for hiding this comment

Uh oh!

alex-medinsh May 12, 2025

Choose a reason for hiding this comment

Uh oh!

alex-medinsh May 13, 2025 • 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!

justinmc May 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

QuncCccccc commented May 21, 2025

Uh oh!

auto-submit Bot commented May 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alex-medinsh commented Apr 17, 2025 •

edited

Loading

alex-medinsh commented Apr 17, 2025 •

edited

Loading

justinmc left a comment •

edited

Loading

alex-medinsh May 13, 2025 •

edited

Loading