Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` #145523

TahaTesser · 2024-03-21T09:04:12Z

fixes Deprecate ButtonBar

Code sample

expand to view the code sample

import 'package:flutter/material.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
        buttonBarTheme: const ButtonBarThemeData(
          alignment: MainAxisAlignment.spaceEvenly,
        ),
      ),
      home: Scaffold(
        body: ButtonBar(
          alignment: MainAxisAlignment.spaceEvenly,
          children: <Widget>[
            TextButton(
              onPressed: () {},
              child: const Text('Button 1'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 2'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 3'),
            ),
          ],
        ),
      ),
    );
  }
}

Data driven fix

Before executing `dart fix --apply`

  return MaterialApp(
      theme: ThemeData(
        buttonBarTheme: const ButtonBarThemeData(
          alignment: MainAxisAlignment.spaceEvenly,
        ),
      ),
      home: Scaffold(
        body: ButtonBar(
          alignment: MainAxisAlignment.spaceEvenly,
          children: <Widget>[
            TextButton(
              onPressed: () {},
              child: const Text('Button 1'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 2'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 3'),
            ),
          ],
        ),
      ),
    );

After executing `dart fix --apply`

    return MaterialApp(
      theme: ThemeData(

      ),
      home: Scaffold(
        body: OverflowBar(
          alignment: MainAxisAlignment.spaceEvenly,
          children: <Widget>[
            TextButton(
              onPressed: () {},
              child: const Text('Button 1'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 2'),
            ),
            TextButton(
              onPressed: () {},
              child: const Text('Button 3'),
            ),
          ],
        ),
      ),
    );

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.

Piinks

Just throwing this idea out there since OverflowBar does not have a theme, do you think there is any value in refactoring ButtonBar to use the OverflowBar internally?

packages/flutter/lib/fix_data/fix_material/fix_button_bar.yaml

Piinks · 2024-03-22T23:17:14Z

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

Ah! Just when ThemeData was clear! 😆

Haha yes, i saw your comment here when I had to restore all the deprecation sections with comments.

TahaTesser · 2024-03-25T07:59:41Z

Just throwing this idea out there since OverflowBar does not have a theme, do you think there is any value in refactoring ButtonBar to use the OverflowBar internally?

This is an interesting idea, we can could keep the widget and make it customizable with the ButtonBarTheme for sure.

FYI, over time all ButtonBar references have been removed from the other widgets in the framework and their examples.
I also replaced ButtonBar in the rfw packages with OverflowBar

The ButtonBarTheme contains some ineffective properties, related to other widgets, which are removed from other widgets. We definitely need to deprecate these properties if the the whole widget and theme.
The following properties don't do anything:

  //  - `buttonMinWidth`
  //  - `buttonHeight`
  //  - `buttonAlignedDropdown`

Piinks · 2024-03-28T21:53:51Z

Thank Taha for considering the keep-it path and the additional context. We discussed a bit more offline and it makes more sense to deprecate this. 👍 Just wanted to be extra considerate before we did so.

Piinks

Just the TBDs in the fix data files are left to fill in here, otherwise, this LGTM! We can land the migration guide once this is in.

…Theme`

…uttonBarTheme` (flutter/flutter#145523)

Manual roll requested by [email protected] flutter/flutter@9d32f07...7fa932b 2024-04-01 [email protected] Roll Flutter Engine from e6f19409b613 to ea93c5d91b12 (3 revisions) (flutter/flutter#146100) 2024-04-01 [email protected] Refactor realm_checker (flutter/flutter#145905) 2024-04-01 [email protected] Add info strings to code blocks. (flutter/flutter#146085) 2024-04-01 [email protected] Add test for animated_container.0.dart API example. (flutter/flutter#145995) 2024-04-01 [email protected] Roll Flutter Engine from 8dff6b833fe2 to e6f19409b613 (2 revisions) (flutter/flutter#146093) 2024-04-01 [email protected] Roll Flutter Engine from d33666d90916 to 8dff6b833fe2 (3 revisions) (flutter/flutter#146087) 2024-04-01 [email protected] Fix SliverMainAxisGroup layout in reverse (flutter/flutter#145572) 2024-04-01 [email protected] Roll Flutter Engine from dd4f5cd5c9d5 to d33666d90916 (3 revisions) (flutter/flutter#146083) 2024-04-01 [email protected] Roll Packages from 51faaa1 to d5aff19 (3 revisions) (flutter/flutter#146081) 2024-04-01 [email protected] Fixes some gesture recognizers are not disposed. (flutter/flutter#146072) 2024-04-01 [email protected] Flutter Gradle Plugin: add versionName and versionCode to FlutterExtension (flutter/flutter#146044) 2024-04-01 [email protected] Roll Flutter Engine from bf348cd73d49 to dd4f5cd5c9d5 (1 revision) (flutter/flutter#146071) 2024-04-01 [email protected] Roll Flutter Engine from 984a78b04671 to bf348cd73d49 (1 revision) (flutter/flutter#146065) 2024-04-01 [email protected] Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` (flutter/flutter#145523) 2024-04-01 [email protected] Add `DataColumn.headingRowAlignment ` for `DataTable` (flutter/flutter#144006) 2024-04-01 [email protected] Roll Flutter Engine from e9d35f8bfbe2 to 984a78b04671 (2 revisions) (flutter/flutter#146062) 2024-04-01 [email protected] Roll Flutter Engine from 4f6b832c8e33 to e9d35f8bfbe2 (1 revision) (flutter/flutter#146060) 2024-03-31 [email protected] Roll Flutter Engine from 9689390986b7 to 4f6b832c8e33 (1 revision) (flutter/flutter#146055) 2024-03-31 [email protected] Roll Flutter Engine from 34081fea4d59 to 9689390986b7 (1 revision) (flutter/flutter#146053) 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],[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

Related to flutter/flutter#145523 ## Presubmit checklist - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Kate Lovett <[email protected]> Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

) Manual roll requested by [email protected] flutter/flutter@9d32f07...7fa932b 2024-04-01 [email protected] Roll Flutter Engine from e6f19409b613 to ea93c5d91b12 (3 revisions) (flutter/flutter#146100) 2024-04-01 [email protected] Refactor realm_checker (flutter/flutter#145905) 2024-04-01 [email protected] Add info strings to code blocks. (flutter/flutter#146085) 2024-04-01 [email protected] Add test for animated_container.0.dart API example. (flutter/flutter#145995) 2024-04-01 [email protected] Roll Flutter Engine from 8dff6b833fe2 to e6f19409b613 (2 revisions) (flutter/flutter#146093) 2024-04-01 [email protected] Roll Flutter Engine from d33666d90916 to 8dff6b833fe2 (3 revisions) (flutter/flutter#146087) 2024-04-01 [email protected] Fix SliverMainAxisGroup layout in reverse (flutter/flutter#145572) 2024-04-01 [email protected] Roll Flutter Engine from dd4f5cd5c9d5 to d33666d90916 (3 revisions) (flutter/flutter#146083) 2024-04-01 [email protected] Roll Packages from 51faaa1 to d5aff19 (3 revisions) (flutter/flutter#146081) 2024-04-01 [email protected] Fixes some gesture recognizers are not disposed. (flutter/flutter#146072) 2024-04-01 [email protected] Flutter Gradle Plugin: add versionName and versionCode to FlutterExtension (flutter/flutter#146044) 2024-04-01 [email protected] Roll Flutter Engine from bf348cd73d49 to dd4f5cd5c9d5 (1 revision) (flutter/flutter#146071) 2024-04-01 [email protected] Roll Flutter Engine from 984a78b04671 to bf348cd73d49 (1 revision) (flutter/flutter#146065) 2024-04-01 [email protected] Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` (flutter/flutter#145523) 2024-04-01 [email protected] Add `DataColumn.headingRowAlignment ` for `DataTable` (flutter/flutter#144006) 2024-04-01 [email protected] Roll Flutter Engine from e9d35f8bfbe2 to 984a78b04671 (2 revisions) (flutter/flutter#146062) 2024-04-01 [email protected] Roll Flutter Engine from 4f6b832c8e33 to e9d35f8bfbe2 (1 revision) (flutter/flutter#146060) 2024-03-31 [email protected] Roll Flutter Engine from 9689390986b7 to 4f6b832c8e33 (1 revision) (flutter/flutter#146055) 2024-03-31 [email protected] Roll Flutter Engine from 34081fea4d59 to 9689390986b7 (1 revision) (flutter/flutter#146053) 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],[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

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. c: tech-debt Technical debt, code quality, testing, etc. labels Mar 21, 2024

TahaTesser force-pushed the deprecate_button_bar branch 2 times, most recently from 0025dac to 27b0319 Compare March 21, 2024 12:24

TahaTesser marked this pull request as ready for review March 21, 2024 13:26

TahaTesser mentioned this pull request Mar 21, 2024

Migration guide for ButtonBar deprecation flutter/website#10325

Merged

3 tasks

TahaTesser requested a review from Piinks March 21, 2024 13:28

Piinks reviewed Mar 22, 2024

View reviewed changes

This comment was marked as resolved.

Sign in to view

TahaTesser requested a review from Piinks March 25, 2024 15:30

Piinks approved these changes Mar 28, 2024

View reviewed changes

TahaTesser added 2 commits April 1, 2024 12:58

Deprecate ButtonBar, ButtonBarThemeData, and `ThemeData.buttonBar…

6788147

…Theme`

Replace TBDs with PR link

285406b

TahaTesser force-pushed the deprecate_button_bar branch from 27b0319 to 285406b Compare April 1, 2024 10:14

TahaTesser added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 1, 2024

auto-submit bot merged commit e85340e into flutter:master Apr 1, 2024

TahaTesser deleted the deprecate_button_bar branch April 1, 2024 11:45

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

Manual roll Flutter from 9d32f07e34c3 to 7fa932be5c12 (19 revisions) flutter/packages#6448

Merged

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

e85340e Deprecate ButtonBar, ButtonBarThemeData, and `ThemeData.b…

ccb838d

…uttonBarTheme` (flutter/flutter#145523)

HansMuller mentioned this pull request Apr 5, 2024

Flutter Framework Team: Notable Commits #121415

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` #145523

Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` #145523

Uh oh!

TahaTesser commented Mar 21, 2024 •

edited

Loading

Uh oh!

Piinks left a comment

Uh oh!

Uh oh!

Piinks Mar 22, 2024

Uh oh!

TahaTesser Mar 25, 2024

Uh oh!

This comment was marked as resolved.

Uh oh!

TahaTesser commented Mar 25, 2024 •

edited

Loading

Uh oh!

Piinks commented Mar 28, 2024

Uh oh!

Piinks left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Deprecate ButtonBar, ButtonBarThemeData, and ThemeData.buttonBarTheme #145523

Deprecate ButtonBar, ButtonBarThemeData, and ThemeData.buttonBarTheme #145523

Uh oh!

Conversation

TahaTesser commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code sample

Data driven fix

Before executing dart fix --apply

After executing dart fix --apply

Pre-launch Checklist

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Piinks Mar 22, 2024

Choose a reason for hiding this comment

Uh oh!

TahaTesser Mar 25, 2024

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

TahaTesser commented Mar 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Piinks commented Mar 28, 2024

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` #145523

Deprecate `ButtonBar`, `ButtonBarThemeData`, and `ThemeData.buttonBarTheme` #145523

TahaTesser commented Mar 21, 2024 •

edited

Loading

Before executing `dart fix --apply`

After executing `dart fix --apply`

TahaTesser commented Mar 25, 2024 •

edited

Loading