Cupertino text clear label #129727

MitchellGoodwin · 2023-06-28T17:49:37Z

Adds a customizable semantic label so that the clear button on the Cupertino text field will be picked up by screen readers.

RPReplay_Final1687901827.mov

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.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

LongCatIsLooong · 2023-06-28T20:17:19Z

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

I think the label should be localized?

I'll put that in.

LongCatIsLooong

I'm not familiar with semantics or internationalization. @chunhtai @thkim1011 do you mind taking a look?

LongCatIsLooong · 2023-07-26T20:11:48Z

packages/flutter_localizations/lib/src/l10n/cupertino_mr.arb

Much of these arb files don't seem to have the correct translation for "clearButtonLabel", "menuDismissLabel" or "noSpellCheckReplacementsLabel"?

The process is that these arb files holds the english strings as a placeholder until they are translated internally. Then we can incorporate those translations into Flutter. Although, it looks like some arb files are missing some strings. Was this README followed for regenerating the arb files?

I found that README file partway through manually adding the clearButtonLabel to some of the arb files and was originally copying the flow from previous PRs adding localization. The only difference I saw was the placement of clearButtonLabel was different in the files I manually added. The other two translations are from other work.

Are there arb files missing the translation besides the cupertino_xx_XX.arb files? I assumed the script skipped those for a reason.

Ah my bad, I thought menuDismissLabel was added in this PR but I think it just changed because of commas at the end of the line. The localization changes LGTM.

goderbauer · 2023-12-05T23:56:04Z

@MitchellGoodwin said last week that he still has plans to finish this.

Merge conflicts

goderbauer

LGTM

goderbauer · 2023-12-14T22:56:07Z

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

+  /// The semantic label for the clear button used by screen readers.
+  ///
+  /// This will be used by screen reading software to identify the clear button
+  /// widget. Defaults to "Text Field Clear".


From looking at the intl files: doesn't this just default to "clear"?

goderbauer · 2023-12-14T22:57:50Z

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

-          CupertinoIcons.clear_thick_circled,
-          size: 18.0,
-          color: CupertinoDynamicColor.resolve(_kClearButtonColor, context),
+    final CupertinoLocalizations localizations = CupertinoLocalizations.of(context);


I would do:

final String clearLabel = widget.clearButtonSemanticLabel ?? CupertinoLocalizations.of(context).clearButtonLabel;

That way, you only establish a dependency on CupertinoLocalizations if you actually need it.

goderbauer · 2023-12-14T22:59:11Z

packages/flutter/test/cupertino/text_field_test.dart

+      ),
+    );
+
+    expect(find.bySemanticsLabel('Text Field Clear'), findsNothing);


Should this be

Suggested change

expect(find.bySemanticsLabel('Text Field Clear'), findsNothing);

expect(find.bySemanticsLabel('Clear'), findsNothing);

flutter/flutter@a51e33a...2407f69 2023-12-15 58529443+srujzs@users.noreply.github.com Move package:web dependency to dev dependency (flutter/flutter#139696) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9524a185b055 to 986a6fe198dc (1 revision) (flutter/flutter#140221) 2023-12-15 engine-flutter-autoroll@skia.org Roll Packages from 1151191 to 3f2e16b (9 revisions) (flutter/flutter#140218) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7a50221733c2 to 9524a185b055 (1 revision) (flutter/flutter#140217) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 767223f7a4f8 to 7a50221733c2 (1 revision) (flutter/flutter#140216) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 91f65eea0c11 to 767223f7a4f8 (1 revision) (flutter/flutter#140210) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from a47da28c9a62 to 91f65eea0c11 (1 revision) (flutter/flutter#140207) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from cde1a596432d to a47da28c9a62 (1 revision) (flutter/flutter#140204) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 46ff5c08a905 to cde1a596432d (1 revision) (flutter/flutter#140200) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from a17bb0a63b7e to 46ff5c08a905 (1 revision) (flutter/flutter#140198) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4cb3ba7a85f6 to a17bb0a63b7e (1 revision) (flutter/flutter#140196) 2023-12-15 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0e7248d43251 to 4cb3ba7a85f6 (14 revisions) (flutter/flutter#140195) 2023-12-15 polinach@google.com Increase versions of leak tracker libraries. (flutter/flutter#140018) 2023-12-15 magder@google.com Set compile test iOS app target version to not embed Swift runtime (flutter/flutter#140188) 2023-12-15 58190796+MitchellGoodwin@users.noreply.github.com Cupertino text clear label (flutter/flutter#129727) 2023-12-15 xilaizhang@google.com [github actions] use token from real user flutter mirror bot (flutter/flutter#140191) 2023-12-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 0e7248d43251 to 0b0fab821536 (4 revisions)" (flutter/flutter#140194) 2023-12-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0e7248d43251 to 0b0fab821536 (4 revisions) (flutter/flutter#140180) 2023-12-14 lsaudon@gmail.com feat: Add onTapAlwaysCalled in TextFormField (flutter/flutter#140089) 2023-12-14 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 3.1.3 to 4.0.0 (flutter/flutter#140177) 2023-12-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2140942444ea to 0e7248d43251 (2 revisions) (flutter/flutter#140176) 2023-12-14 ybz975218925@gmail.com fix reorderable_list drop animation (flutter/flutter#139362) 2023-12-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from 997d3dfa1e74 to 2140942444ea (4 revisions) (flutter/flutter#140171) 2023-12-14 38147403+sharmashashi@users.noreply.github.com Fix BottomNavigationBarItem label overflow (flutter/flutter#120206) 2023-12-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from a565cea256c7 to 997d3dfa1e74 (2 revisions) (flutter/flutter#140170) 2023-12-14 chingjun@google.com Revert "Dynamic view sizing" (flutter/flutter#140165) 2023-12-14 aki.nishi.work@gmail.com ð��¨: fix cupertionActionSheet design (flutter/flutter#134345) 2023-12-14 104349824+huycozy@users.noreply.github.com Make improvements to existing new issue templates (flutter/flutter#140142) 2023-12-14 engine-flutter-autoroll@skia.org Roll Flutter Engine from caf33276468b to a565cea256c7 (1 revision) (flutter/flutter#140163) 2023-12-14 parlough@gmail.com Expand and update a few release.yml categories (flutter/flutter#140120) 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 dit@google.com,rmistry@google.com,stuartmorgan@google.com 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

MitchellGoodwin requested a review from LongCatIsLooong June 28, 2023 19:57

LongCatIsLooong reviewed Jun 28, 2023

View reviewed changes

goderbauer added framework flutter/packages/flutter repository. See also f: labels. f: cupertino flutter/packages/flutter/cupertino repository labels Jul 5, 2023

github-actions bot added a: text input Entering text in a text field or keyboard related problems a: internationalization Supporting other languages or locales. (aka i18n) labels Jul 26, 2023

MitchellGoodwin force-pushed the cupertino-text-clear-label branch 3 times, most recently from 0e10c2d to 0099223 Compare July 26, 2023 19:53

LongCatIsLooong reviewed Jul 26, 2023

View reviewed changes

MitchellGoodwin force-pushed the cupertino-text-clear-label branch 3 times, most recently from 388c313 to 9af7989 Compare August 3, 2023 16:46

MitchellGoodwin force-pushed the cupertino-text-clear-label branch from 9af7989 to aa0fdf0 Compare August 10, 2023 21:31

MitchellGoodwin force-pushed the cupertino-text-clear-label branch from e858313 to 60e683d Compare August 24, 2023 20:48

MitchellGoodwin force-pushed the cupertino-text-clear-label branch from 60e683d to b5ce6c9 Compare September 1, 2023 17:25

MitchellGoodwin force-pushed the cupertino-text-clear-label branch 2 times, most recently from b98ad08 to 3c91c5d Compare September 14, 2023 16:45

MitchellGoodwin added 8 commits December 12, 2023 11:07

Add semantic label to clear button

100be72

Update tests

51e2bc3

Add debug property

2f5d797

Add framework for localization

de6b231

Merge conflicts

Merge conflicts

967e5e1

Adjust test for localization

98d213e

Revert change to todos

e2d537b

Move localization call

a479e8b

MitchellGoodwin force-pushed the cupertino-text-clear-label branch from 3c91c5d to a479e8b Compare December 12, 2023 20:56

Revert localization change

7e792d9

MitchellGoodwin requested a review from godofredoc December 14, 2023 22:32

MitchellGoodwin requested review from goderbauer and removed request for godofredoc December 14, 2023 22:33

goderbauer approved these changes Dec 14, 2023

View reviewed changes

Remove reference to old label, optionally depend on localization

ab1d07f

MitchellGoodwin added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 15, 2023

auto-submit bot merged commit f0051d8 into flutter:master Dec 15, 2023

engine-flutter-autoroll mentioned this pull request Dec 15, 2023

Roll Flutter from a51e33ac76e4 to ba30653f2ec9 (26 revisions) flutter/packages#5686

Closed

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

b7194d6

engine-flutter-autoroll mentioned this pull request Dec 15, 2023

Roll Flutter from a51e33ac76e4 to 8889a0981b69 (27 revisions) flutter/packages#5687

Closed

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

b4dae31

engine-flutter-autoroll mentioned this pull request Dec 15, 2023

Roll Flutter from a51e33ac76e4 to f9ee379b35e0 (28 revisions) flutter/packages#5688

Closed

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

4c02c31

engine-flutter-autoroll mentioned this pull request Dec 15, 2023

Roll Flutter from a51e33ac76e4 to 8b8d39593d9b (29 revisions) flutter/packages#5690

Closed

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

39eec60

engine-flutter-autoroll mentioned this pull request Dec 15, 2023

Roll Flutter from a51e33ac76e4 to 2407f699e935 (30 revisions) flutter/packages#5691

Merged

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

6819ef7

HansMuller mentioned this pull request Dec 15, 2023

Flutter Framework Team: Notable Commits #121415

Closed

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

f0051d8 Cupertino text clear label (flutter/flutter#129727)

918fef2

	expect(find.bySemanticsLabel('Text Field Clear'), findsNothing);
	expect(find.bySemanticsLabel('Clear'), findsNothing);

Cupertino text clear label #129727

Cupertino text clear label #129727

Uh oh!

Conversation

MitchellGoodwin commented Jun 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LongCatIsLooong left a comment

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!

Choose a reason for hiding this comment

Uh oh!

goderbauer commented Dec 5, 2023

Uh oh!

goderbauer left a comment

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MitchellGoodwin commented Jun 28, 2023 •

edited

Loading