Style: Rename CupertinoSwitch activeColor and trackColor to activeTrackColor and InactiveTrackColor #151367

rkishan516 · 2024-07-06T10:37:29Z

Style: Rename CupertinoSwitch activeColor and trackColor to activeTrackColor and InactiveTrackColor

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.

victorsanni

Thanks for this PR! Renaming parameters would be a breaking change for many users, so we typically have a different process for these types of changes. This process involves deprecating these parameters (the old names), adding new parameters (the new names), and adding a flutter fix to automate the migration for users.

See the breaking change policy and adding Data Driven Fixes for more information.

rkishan516 · 2024-07-12T02:47:47Z

@victorsanni Sure I will do respective changes and push.

rkishan516 · 2024-07-15T15:52:47Z

@victorsanni & @Piinks I have done required changes as per my understanding.

Piinks

Hey @rkishan516 thanks for contributing! This is a good example of how we implement a deprecation like this while maintaining backwards compatibility, by making the original field a getter:

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

Line 307 in 6205c11

TextStyle? get headline3 => displaySmall;

packages/flutter/lib/src/cupertino/switch.dart

packages/flutter/lib/fix_data/fix_cupertino.yaml

packages/flutter/lib/src/cupertino/switch.dart

packages/flutter/test/cupertino/switch_test.dart

packages/flutter/lib/src/cupertino/switch.dart

rkishan516 · 2024-07-16T01:29:59Z

@MitchellGoodwin & @Piinks Thanks for review, I have updated code.

MitchellGoodwin · 2024-07-16T16:54:03Z

packages/flutter/lib/src/cupertino/switch.dart

-    this.trackColor,
+    @Deprecated(
+      'Use activeTrackColor instead. '
+      'This feature was deprecated after v3.24.0-0.0.pre.'


Note to self/ other reviewers: check that this is still the up to date message before merging

Because I often forget where to check for this: https://github.com/flutter/flutter/tags

Can you check and update this version number in the deprecation messages? I think we are really close now.

justinmc

I think it makes sense to change to these names 👍 . There doesn't seem to be a clear standard to follow here from Material. I checked the Material 3 Switch spec and it seems to not give names for these kinds of things. Other implementations like in Jetpack Compose, Android, and Material web seem to all use their own names.

So we should probably pick something and stick with it everywhere, and activeTrackColor and inactiveTrackColor sound good to me.

MitchellGoodwin

Thank you for the update. This is getting close. A couple more comments.

packages/flutter/lib/src/cupertino/switch.dart

packages/flutter/lib/fix_data/fix_cupertino.yaml

packages/flutter/lib/src/cupertino/switch.dart

justinmc

Just some small things to look at here, thanks for cleaning up this API.

justinmc · 2024-07-17T17:42:39Z

packages/flutter/lib/src/cupertino/switch.dart

-    this.trackColor,
+    @Deprecated(
+      'Use activeTrackColor instead. '
+      'This feature was deprecated after v3.24.0-0.0.pre.'


Because I often forget where to check for this: https://github.com/flutter/flutter/tags

packages/flutter/lib/src/cupertino/switch.dart

packages/flutter/test/cupertino/switch_test.dart

Piinks · 2024-07-29T17:21:12Z

packages/flutter/lib/src/cupertino/switch.dart

  ///
  /// See also:
  ///
  ///  * [trackColor], the color to use for the track when the switch is off.


Should this see also point to activeTrackColor?

Piinks · 2024-07-29T17:21:24Z

packages/flutter/lib/src/cupertino/switch.dart

+  ///
+  /// See also:
+  ///
+  ///  * [activeTrackColor], the color to use for the track when the switch is on.


This see also is pointing to itself. :)

Piinks · 2024-07-29T17:23:04Z

packages/flutter/lib/src/cupertino/switch.dart

-    this.trackColor,
+    @Deprecated(
+      'Use activeTrackColor instead. '
+      'This feature was deprecated after v3.24.0-0.0.pre.'


Can you check and update this version number in the deprecation messages? I think we are really close now.

victorsanni · 2024-07-29T21:29:07Z

packages/flutter/test/cupertino/switch_test.dart

      expect(tester.takeException(), isNull);
    });
+
+    testWidgets('Switch is using inactive track color when set', (WidgetTester tester) async {


Suggested change

testWidgets('Switch is using inactive track color when set', (WidgetTester tester) async {

testWidgets('Switch uses inactive track color when set', (WidgetTester tester) async {

victorsanni · 2024-07-29T21:29:35Z

packages/flutter/test/cupertino/switch_test.dart

+        expect(find.byType(CupertinoSwitch), paints..rrect(color: inactiveTrackColor));
+    });
+
+    testWidgets('Switch is using active track color when set', (WidgetTester tester) async {


Suggested change

testWidgets('Switch is using active track color when set', (WidgetTester tester) async {

testWidgets('Switch uses active track color when set', (WidgetTester tester) async {

MitchellGoodwin

LGTM! Thank you for putting up with our feedback.

MitchellGoodwin · 2024-08-06T17:21:28Z

packages/flutter/lib/src/cupertino/switch.dart

-    this.trackColor,
+    @Deprecated(
+      'Use activeTrackColor instead. '
+      'This feature was deprecated after v3.24.0-0.1.pre.'


Looks like the version went up again https://github.com/flutter/flutter/tags

…ackColor and inactiveTrackColor

justinmc

LGTM 👍

victorsanni · 2024-08-07T17:20:54Z

packages/flutter/test/cupertino/switch_test.dart

    });
+
+    testWidgets('Switch uses inactive track color when set', (WidgetTester tester) async {
+        const Color inactiveTrackColor = Color(0xFF00FF00);


Nit: The contents of both tests should probably be outdented.

Ah good catch. I think it's ok to land this, we can tidy it up after. The tag on the deprecation is time sensitive.

…ckColor and InactiveTrackColor (flutter#151367) Style: Rename CupertinoSwitch `activeColor` and `trackColor` to `activeTrackColor` and `InactiveTrackColor` Resolves flutter#151256

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

Manual roll requested by [email protected] flutter/flutter@d595e98...b6cd31e 2024-08-08 [email protected] Add a contribution doc on using reliable links in tooling (flutter/flutter#150962) 2024-08-08 [email protected] Roll Flutter Engine from 94cf8c8fad31 to 3978ddd8d7a7 (1 revision) (flutter/flutter#153086) 2024-08-08 [email protected] Roll Flutter Engine from 9dd4a2303898 to 94cf8c8fad31 (2 revisions) (flutter/flutter#153073) 2024-08-08 [email protected] Roll Flutter Engine from 9932f34aac4e to 9dd4a2303898 (1 revision) (flutter/flutter#153067) 2024-08-08 [email protected] Add drawer and navigation drawer in a11y assessment app, also run `dart format` under a11y_assessments/ (flutter/flutter#153034) 2024-08-07 [email protected] Roll Flutter Engine from d4d9537bccdf to 9932f34aac4e (1 revision) (flutter/flutter#153063) 2024-08-07 [email protected] Clean up MenuAnchor (flutter/flutter#152946) 2024-08-07 [email protected] Set default Cupertino `primaryContrastingColor` to white (flutter/flutter#153039) 2024-08-07 [email protected] Roll Flutter Engine from 317eb6107646 to d4d9537bccdf (2 revisions) (flutter/flutter#153058) 2024-08-07 [email protected] Allow dropdown_menu to accept any EdgeInsetsGeometry (flutter/flutter#153053) 2024-08-07 [email protected] Add xcresulttool --legacy flag for deprecated usage (flutter/flutter#152988) 2024-08-07 [email protected] Revert "Marks Mac channels_integration_test to be flaky" (flutter/flutter#153044) 2024-08-07 [email protected] Roll Flutter Engine from 69c29fb309bb to 317eb6107646 (2 revisions) (flutter/flutter#153048) 2024-08-07 [email protected] Marks Linux android_java17_dependency_smoke_tests to be unflaky (flutter/flutter#153011) 2024-08-07 [email protected] Marks Linux android_java11_dependency_smoke_tests to be unflaky (flutter/flutter#153010) 2024-08-07 [email protected] [web] hide the --web-renderer option in the tool (flutter/flutter#152683) 2024-08-07 [email protected] Doc imports again (flutter/flutter#152958) 2024-08-07 [email protected] Roll Flutter Engine from 5a0fd5fbecc6 to 69c29fb309bb (6 revisions) (flutter/flutter#153035) 2024-08-07 [email protected] Roll Packages from 551bde5 to 5cc0a01 (12 revisions) (flutter/flutter#153040) 2024-08-07 [email protected] MenuAnchor hover traversal fixes (flutter/flutter#150914) 2024-08-07 [email protected] Style: Rename CupertinoSwitch activeColor and trackColor to activeTrackColor and InactiveTrackColor (flutter/flutter#151367) 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] 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

…ckColor and InactiveTrackColor (flutter#151367) Style: Rename CupertinoSwitch `activeColor` and `trackColor` to `activeTrackColor` and `InactiveTrackColor` Resolves flutter#151256

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

Piinks requested review from Piinks and victorsanni July 11, 2024 18:21

victorsanni reviewed Jul 11, 2024

View reviewed changes

rkishan516 force-pushed the rename-cupertino-switch-properties branch from 20e2acd to 673716a Compare July 12, 2024 03:25

github-actions bot added the c: tech-debt Technical debt, code quality, testing, etc. label Jul 15, 2024

rkishan516 force-pushed the rename-cupertino-switch-properties branch from f04e07e to f02800b Compare July 15, 2024 15:47

victorsanni requested a review from MitchellGoodwin July 15, 2024 16:56

Piinks reviewed Jul 15, 2024

View reviewed changes

MitchellGoodwin reviewed Jul 15, 2024

View reviewed changes

packages/flutter/lib/src/cupertino/switch.dart Outdated Show resolved Hide resolved

MitchellGoodwin reviewed Jul 15, 2024

View reviewed changes

packages/flutter/lib/src/cupertino/switch.dart Outdated Show resolved Hide resolved

rkishan516 force-pushed the rename-cupertino-switch-properties branch 2 times, most recently from 69077dd to 751dc04 Compare July 16, 2024 01:27

MitchellGoodwin reviewed Jul 16, 2024

View reviewed changes

justinmc reviewed Jul 16, 2024

View reviewed changes

MitchellGoodwin reviewed Jul 16, 2024

View reviewed changes

rkishan516 force-pushed the rename-cupertino-switch-properties branch 6 times, most recently from 12c8f22 to b3146f7 Compare July 17, 2024 15:04

MitchellGoodwin reviewed Jul 17, 2024

View reviewed changes

packages/flutter/lib/fix_data/fix_cupertino.yaml Show resolved Hide resolved

packages/flutter/lib/fix_data/fix_cupertino.yaml Show resolved Hide resolved

packages/flutter/lib/src/cupertino/switch.dart Outdated Show resolved Hide resolved

justinmc reviewed Jul 17, 2024

View reviewed changes

Piinks reviewed Jul 29, 2024

View reviewed changes

victorsanni reviewed Jul 29, 2024

View reviewed changes

rkishan516 force-pushed the rename-cupertino-switch-properties branch from 2f89307 to 5b6d849 Compare July 30, 2024 02:01

MitchellGoodwin approved these changes Aug 6, 2024

View reviewed changes

rkishan516 force-pushed the rename-cupertino-switch-properties branch from b743bde to 2cd111c Compare August 7, 2024 02:54

Style: Rename cupertino switch activeColor and trackColor to activeTr…

0a1b946

…ackColor and inactiveTrackColor

rkishan516 force-pushed the rename-cupertino-switch-properties branch from 2cd111c to 0a1b946 Compare August 7, 2024 04:19

Merge branch 'master' into rename-cupertino-switch-properties

649ba1a

justinmc approved these changes Aug 7, 2024

View reviewed changes

victorsanni reviewed Aug 7, 2024

View reviewed changes

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 7, 2024

auto-submit bot merged commit 0f7bceb into flutter:master Aug 7, 2024

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Manual roll Flutter from d595e98d85ea to b6cd31e6b5a6 (21 revisions) flutter/packages#7339

Merged

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

03029af

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Roll Flutter from d595e98d85ea to b6cd31e6b5a6 (21 revisions) flutter/packages#7340

Closed

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

ee2f196

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Roll Flutter from d595e98d85ea to 51606f99a49e (22 revisions) flutter/packages#7341

Closed

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

9682886

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Roll Flutter from d595e98d85ea to d23be7a07de3 (24 revisions) flutter/packages#7342

Closed

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

bfedddb

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

engine-flutter-autoroll mentioned this pull request Aug 8, 2024

Roll Flutter from d595e98d85ea to a04ecb2b7234 (25 revisions) flutter/packages#7343

Closed

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

93ec767

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

Piinks mentioned this pull request Aug 9, 2024

Flutter Framework Team: Notable Commits #121415

Closed

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

3cf7840

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

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

0f7bceb Style: Rename CupertinoSwitch activeColor and trackColor to a…

4911dd3

…ctiveTrackColor and InactiveTrackColor (flutter/flutter#151367)

rkishan516 deleted the rename-cupertino-switch-properties branch July 26, 2025 05:46

	testWidgets('Switch is using inactive track color when set', (WidgetTester tester) async {
	testWidgets('Switch uses inactive track color when set', (WidgetTester tester) async {

	testWidgets('Switch is using active track color when set', (WidgetTester tester) async {
	testWidgets('Switch uses active track color when set', (WidgetTester tester) async {

Style: Rename CupertinoSwitch activeColor and trackColor to activeTrackColor and InactiveTrackColor #151367

Style: Rename CupertinoSwitch activeColor and trackColor to activeTrackColor and InactiveTrackColor #151367

Uh oh!

Conversation

rkishan516 commented Jul 6, 2024

Pre-launch Checklist

Uh oh!

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

rkishan516 commented Jul 12, 2024

Uh oh!

rkishan516 commented Jul 15, 2024

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rkishan516 commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

victorsanni left a comment •

edited

Loading

rkishan516 commented Jul 16, 2024 •

edited

Loading