Deprecate unused `ButtonStyleButton.iconAlignment` property #160023

TahaTesser · 2024-12-10T11:33:58Z

Fixes Deprecate unused ButtonStyleButton.iconAlignment property

Refactor done in #158503 makes ButtonStyleButton.iconAlignment redundant. In this PR I'm marking it as deprecated without migration guide. However, it may possible to remove it altogether.

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

Could we add a dart fix that just removes uses of this?

TahaTesser · 2024-12-11T18:21:15Z

Could we add a dart fix that just removes uses of this?

It's an abstract class that is implemented by the buttons. I never wrote a dart fix for an abstract class. I'll look into it :)

TahaTesser · 2024-12-12T12:53:53Z

Could we add a dart fix that just removes uses of this?

It's an abstract class that is implemented by the buttons. I never wrote a dart fix for an abstract class. I'll look into it :)

@Piinks
I really tried to find some existing non-widget prop that are deprecated with dart fix so I can base this PR on it but couldn't find it such deprecation. It seems non-widget prop are deprecated without dart fix. If you have any instructions or an instance of such dart fix please share.

Good news is anyone extending ButtonStyleButton might not have a use case for this redundant prop and default dart fix automatically removes unused overrides.

Piinks

What about the subclasses? They inherit this property. Do ElevatedButton, FilledButton, OutlinedButton, and TextButton get an analyzer warning about the deprecation? Will a dart fix work for those instances?

TahaTesser · 2024-12-12T20:55:08Z

What about the subclasses? They inherit this property. Do ElevatedButton, FilledButton, OutlinedButton, and TextButton get an analyzer warning about the deprecation? Will a dart fix work for those instances?

They use the IconAlignment directly. They no longer depend on ButtonStyleButton.iconAlignment. This was added to ButtonStyleButton by mistake. I have removed the unnecessary reference in previous PR.

TahaTesser · 2024-12-12T20:58:25Z

Button classes use ButtonStyle customisation to get icon alignment similar to icon size and icon color. As a result, abstract ButtonStyleButton IconAlignment is now redundant.

Piinks · 2024-12-12T23:11:14Z

Ah ok thank you, just double checking.

Piinks · 2024-12-12T23:12:53Z

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

    this.statesController,
    this.isSemanticButton = true,
+    @Deprecated(
+      'Remove this parameter as it is now ignored. '


Can we add more context to the message here? This should probably mention ButtonStyle and the styleFrom methods where folks can use this now.

Great suggestion! I added a line about ButtonStyle.iconAlignment alternative and update version tag.

QuncCccccc

LGTM:)

Piinks

LGTM as well! Thank you!

…lutter/flutter#160023)

flutter/flutter@864d4f5...72db8f6 2025-01-13 [email protected] Roll Packages from 6554751 to 3c3bc68 (16 revisions) (flutter/flutter#161515) 2025-01-13 [email protected] Update error message for when leading/trailing width exceeds `ListTile` width and add missing test (flutter/flutter#161091) 2025-01-13 [email protected] Deprecate unused `ButtonStyleButton.iconAlignment` property (flutter/flutter#160023) 2025-01-12 [email protected] Provide monitor information. (flutter/flutter#161359) 2025-01-11 [email protected] [android_engine_test] Remove background/foreground from surface texture trampoline test. (flutter/flutter#161441) 2025-01-11 [email protected] Remove some miscellaneous references to Cirrus. (flutter/flutter#161390) 2025-01-11 [email protected] add semantics role and tab (flutter/flutter#161260) 2025-01-10 [email protected] CupertinoSheetRoute (flutter/flutter#157568) 2025-01-10 [email protected] Update `TextEditingController.text` documentation to recommend against using it in production code (flutter/flutter#157769) 2025-01-10 [email protected] ð�� [tool] Add a wirelessly connected device name as `displayName` (flutter/flutter#160497) 2025-01-10 [email protected] FixForward: method was renamed (flutter/flutter#161431) 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

…lutter/flutter#160023)

flutter/flutter@864d4f5...72db8f6 2025-01-13 [email protected] Roll Packages from 6554751 to 3c3bc68 (16 revisions) (flutter/flutter#161515) 2025-01-13 [email protected] Update error message for when leading/trailing width exceeds `ListTile` width and add missing test (flutter/flutter#161091) 2025-01-13 [email protected] Deprecate unused `ButtonStyleButton.iconAlignment` property (flutter/flutter#160023) 2025-01-12 [email protected] Provide monitor information. (flutter/flutter#161359) 2025-01-11 [email protected] [android_engine_test] Remove background/foreground from surface texture trampoline test. (flutter/flutter#161441) 2025-01-11 [email protected] Remove some miscellaneous references to Cirrus. (flutter/flutter#161390) 2025-01-11 [email protected] add semantics role and tab (flutter/flutter#161260) 2025-01-10 [email protected] CupertinoSheetRoute (flutter/flutter#157568) 2025-01-10 [email protected] Update `TextEditingController.text` documentation to recommend against using it in production code (flutter/flutter#157769) 2025-01-10 [email protected] ð�� [tool] Add a wirelessly connected device name as `displayName` (flutter/flutter#160497) 2025-01-10 [email protected] FixForward: method was renamed (flutter/flutter#161431) 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

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

TahaTesser marked this pull request as ready for review December 10, 2024 13:02

TahaTesser requested a review from QuncCccccc December 10, 2024 13:03

Piinks reviewed Dec 11, 2024

View reviewed changes

TahaTesser requested a review from Piinks December 12, 2024 12:55

Piinks reviewed Dec 12, 2024

View reviewed changes

TahaTesser requested a review from Piinks December 13, 2024 20:21

QuncCccccc approved these changes Dec 18, 2024

View reviewed changes

Piinks approved these changes Dec 19, 2024

View reviewed changes

TahaTesser force-pushed the button_style_button_icon_alignment branch 4 times, most recently from b252c80 to 469fb63 Compare January 9, 2025 08:32

TahaTesser added 8 commits January 13, 2025 12:38

Deprecate unused ButtonStyleButton.iconAlignment property

591b792

Update deprecation message

52b1e32

Fix indent

2ad2a87

Update version tag

4eeb9d7

Kick tests

8d2ca72

Fix format

89beabb

Kick tests

876d72c

Kick tests

ab159d7

TahaTesser force-pushed the button_style_button_icon_alignment branch from 469fb63 to ab159d7 Compare January 13, 2025 10:40

Kick tests

2a8f914

TahaTesser added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 13, 2025

auto-submit bot added this pull request to the merge queue Jan 13, 2025

Merged via the queue into flutter:master with commit 1c147a2 Jan 13, 2025
103 checks passed

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

TahaTesser deleted the button_style_button_icon_alignment branch January 13, 2025 13:56

engine-flutter-autoroll mentioned this pull request Jan 13, 2025

Roll Flutter from 864d4f59dde0 to cef35e77909f (10 revisions) flutter/packages#8419

Closed

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

a4ac599

…lutter/flutter#160023)

engine-flutter-autoroll mentioned this pull request Jan 13, 2025

Roll Flutter from 864d4f59dde0 to cef35e77909f (10 revisions) flutter/packages#8420

Closed

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

7214b0e

…lutter/flutter#160023)

engine-flutter-autoroll mentioned this pull request Jan 13, 2025

Roll Flutter from 864d4f59dde0 to 72db8f69e339 (11 revisions) flutter/packages#8421

Merged

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

765a891

…lutter/flutter#160023)

Piinks mentioned this pull request Jan 17, 2025

Flutter Notable Commits - 2025 #161460

Open

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

5276851

…lutter/flutter#160023)

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

dce876e

…lutter/flutter#160023)

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

7e25144

…lutter/flutter#160023)

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

6cbf591

…lutter/flutter#160023)

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

1c147a2 Deprecate unused ButtonStyleButton.iconAlignment property (f…

313349f

…lutter/flutter#160023)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deprecate unused `ButtonStyleButton.iconAlignment` property #160023

Deprecate unused `ButtonStyleButton.iconAlignment` property #160023

Uh oh!

TahaTesser commented Dec 10, 2024 •

edited

Loading

Uh oh!

Piinks left a comment

Uh oh!

TahaTesser commented Dec 11, 2024

Uh oh!

TahaTesser commented Dec 12, 2024 •

edited

Loading

Uh oh!

Piinks left a comment

Uh oh!

TahaTesser commented Dec 12, 2024 •

edited

Loading

Uh oh!

TahaTesser commented Dec 12, 2024

Uh oh!

Piinks commented Dec 12, 2024

Uh oh!

Piinks Dec 12, 2024

Uh oh!

TahaTesser Dec 13, 2024

Uh oh!

QuncCccccc left a comment

Uh oh!

Piinks left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Deprecate unused ButtonStyleButton.iconAlignment property #160023

Deprecate unused ButtonStyleButton.iconAlignment property #160023

Uh oh!

Conversation

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

Uh oh!

Pre-launch Checklist

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

TahaTesser commented Dec 11, 2024

Uh oh!

TahaTesser commented Dec 12, 2024 • 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!

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

Uh oh!

Uh oh!

TahaTesser commented Dec 12, 2024

Uh oh!

Piinks commented Dec 12, 2024

Uh oh!

Piinks Dec 12, 2024

Choose a reason for hiding this comment

Uh oh!

TahaTesser Dec 13, 2024

Choose a reason for hiding this comment

Uh oh!

QuncCccccc left a comment

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Deprecate unused `ButtonStyleButton.iconAlignment` property #160023

Deprecate unused `ButtonStyleButton.iconAlignment` property #160023

TahaTesser commented Dec 10, 2024 •

edited

Loading

TahaTesser commented Dec 12, 2024 •

edited

Loading

TahaTesser commented Dec 12, 2024 •

edited

Loading