Update ButtonStyle documentation #168062

bleroux · 2025-04-30T12:02:59Z

Description

This PR updates ButtonStyle.minimumSize and ButtonStyle.fixedSize documentation.

It updates the documentation in order to describe the current behavior as it might be surprising.
I have considered changing the behavior related to ButtonStyle.minimumSize but while experimenting I noticed that several widgets in the framework (and several tests) use ButtonStyle.minimumSize with the expectation that the given size is adjusted based on the ambient visual density (and there are probably several similar usages outside of the framework in Google and non-Google apps).

Related Issue

ButtonStyle.minimumSize : Fixes minimumSize not respected properly when visual density is not standard
ButtonStyle.fixedSize : Fixes Button behaves differently in Web/Desktop and Mobile

Tests

Documentation only

flutter-dashboard · 2025-04-30T12:56:12Z

Golden file changes have been found for this pull request. Click here to view and triage (e.g. because this is an intentional change).

If you are still iterating on this change and are not ready to resolve the images on the Flutter Gold dashboard, consider marking this PR as a draft pull request above. You will still be able to view image results on the dashboard, commenting will be silenced, and the check will not try to resolve itself until marked ready for review.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #168062 at sha acb0e53

flutter-dashboard · 2025-04-30T13:53:12Z

Golden file changes are available for triage from new commit, Click here to view.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #168062 at sha e5aa4e0

flutter-dashboard · 2025-04-30T14:55:13Z

Golden file changes are available for triage from new commit, Click here to view.

For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Changes reported for pull request #168062 at sha 73bd23b

Piinks · 2025-04-30T21:55:18Z

Thanks for the PR Bruno! By coincidence I was just looking at something super similar - #94098

The delete button on input chip also ends up being less than the material tap target size, unless updated to use MaterialTapTargetSize.padded + VisualDensity.standard.
This feels like a hole for developers to fall into repeatedly, especially around something as serious as accessibility.

I noticed that several widgets in the framework (and several tests) set ButtonStyle.minimumSize with the expectation that the given size is adjusted based on the ambient visual density (and there are probably several similar usages outside of the framework in Google and non-Google apps).
So changing this default behavior does not seem possible at that point.

You are so right about this. I wonder, do you have a sense of how many components are affected by this quirk? It might be worth investigating if we can change this to ensure we have the minimum tap target respected by default. It is very important for accessibility.

Maybe we can look at the default values in ThemeData? WDYT?

bleroux · 2025-05-20T15:21:17Z

@Piinks The issue targeted by this PR is somewhat different than #94098.

Here the problem is that ButtonStyle.minimumSize might not be respected on desktop (or when visual density is not VisualDensity.standard). Changing this behavior is difficult because current usages expect that the size will be adjusted based on the visual density. For instance, the M3 defaults are given only for mobile and then they are adjusted based on visual density. If we change this behavior it would be the responsability of the code (user code, framework code relying on this behavior) to adjust ButtonStyle.minimumSize before providing it (currently it is done automatically).
For the buttons M3 defaults it would be doable to adjust the values after querying the M3 defaults. But there are other usages where it will be difficult to do so.

So I opted for a documentation update that explains the current behavior because:

this is mainly a desktop issue.
there is a workaround which is to override the visual density.
while fixing this for ButtonStyle.minimumSize usages in the framework might be doable it will require updating several widgets and tests.
changing this behavior now will probably impact users in a way that won't be easy for them to identify (we can't provide a dart fix, the change will be visible in some platforms, ect).

Piinks

LGTM - thanks for the detailed explanation. :)

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

Co-authored-by: Kate Lovett <[email protected]>

Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (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. ...

…r#9315) Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (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. f: material design flutter/packages/flutter/material repository. labels Apr 30, 2025

bleroux mentioned this pull request Apr 30, 2025

BUG: Elevated / Text / Outline Buttons - minimumSize not respected properly when visual density is not standard #123528

Closed

flutter-dashboard bot added the will affect goldens Changes to golden files label Apr 30, 2025

bleroux force-pushed the update_button_style_documentation branch from acb0e53 to e5aa4e0 Compare April 30, 2025 12:59

bleroux force-pushed the update_button_style_documentation branch from e5aa4e0 to 73bd23b Compare April 30, 2025 13:58

bleroux force-pushed the update_button_style_documentation branch from 73bd23b to d71c7de Compare April 30, 2025 16:37

bleroux requested a review from Piinks April 30, 2025 16:37

Piinks approved these changes May 20, 2025

View reviewed changes

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

bleroux force-pushed the update_button_style_documentation branch from d71c7de to 45095a3 Compare May 21, 2025 07:12

bleroux and others added 2 commits May 21, 2025 22:05

Update ButtonStyle documentation

a364f8e

Update packages/flutter/lib/src/material/button_style.dart

24a71aa

Co-authored-by: Kate Lovett <[email protected]>

bleroux force-pushed the update_button_style_documentation branch from 2fa082c to 24a71aa Compare May 21, 2025 20:05

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

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

Merged via the queue into flutter:master with commit e78b434 May 22, 2025
76 checks passed

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

eaae283

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

cce2b2c

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

00648e4

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

027b961

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

76612b1

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

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

Merged

bleroux deleted the update_button_style_documentation branch June 16, 2025 08:09

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

8ac798a

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

7718e6f

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

4f27559

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

b4beafd

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

e78b434e8 Update ButtonStyle documentation (flutter/flutter#168062)

5d4f86d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update ButtonStyle documentation #168062

Update ButtonStyle documentation #168062

Uh oh!

bleroux commented Apr 30, 2025

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

Piinks commented Apr 30, 2025

Uh oh!

bleroux commented May 20, 2025 •

edited

Loading

Uh oh!

Piinks left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update ButtonStyle documentation #168062

Update ButtonStyle documentation #168062

Uh oh!

Conversation

bleroux commented Apr 30, 2025

Description

Related Issue

Tests

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

flutter-dashboard bot commented Apr 30, 2025

Uh oh!

Piinks commented Apr 30, 2025

Uh oh!

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

Uh oh!

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bleroux commented May 20, 2025 •

edited

Loading