TextSelectionTheme support (step 1 of 3) #62014

darrenaustin · 2020-07-22T07:51:30Z

Description

As part of the larger theme system update, this PR provides a new TextSelectionTheme that configures the visual properties of text selection in TextField and SelectableText widgets. The initial supported properties are the cursorColor, selectionColor and selectionHandleColor, with more to come in future PRs.

These properties will now replace the existing equivalent properties in ThemeData (i.e cursorColor, textSelectionColor and textSelectionHandleColor). As such the properties on ThemeData will be deprecated.

In addition to this deprecation, we are updating the default values for each of these properties to use the colors in the ThemeData.colorScheme. This will eventually be a breaking change. However, for this first step this is all turned off by default. To turn on the text selection theme support you can set the new temporary opt-in ThemeData.useTextSelectionTheme flag to true.

A more detailed description can be found in the design doc. It also includes a migration guide for migrating application code to use the new theme.

Step 2 (re-landed in Reland: TextSelectionTheme support (step 2 of 3) #66061)
Step 3

Related Issues

#17635
#56082
#61227

Tests

I added tests for the new theme as well as updating the overall ThemeData tests.

Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

This PR specifically won't break any tests, as it is a soft migration. Overall however, after all stages of this are complete it will be a breaking change.

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change.
- I wrote a design doc: https://flutter.dev/go/text-selection-theme
- I got input from the developer relations team, specifically from: @RedBrogdon
- I wrote a migration guide: https://flutter.dev/docs/release/breaking-changes/text-selection-theme

justinmc

LGTM, just some formatting I got carried away with. Thanks for doing this!

packages/flutter/test/material/text_selection_theme_test.dart

googlebot · 2020-07-22T21:40:10Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot · 2020-07-22T22:23:06Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

gspencergoog

gspencergoog · 2020-07-22T21:42:48Z

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

+///
+/// Use [TextSelectionTheme.of] to access the closest ancestor
+/// [TextSelectionTheme] of the current [BuildContext].
+///


Please add the diagram that you have on the PR to the docs: that makes it super clear what you're talking about.

HansMuller

LGTM

HansMuller · 2020-07-23T22:11:18Z

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

@@ -635,10 +636,21 @@ class TextField extends StatefulWidget {
  /// {@macro flutter.widgets.editableText.cursorRadius}
  final Radius cursorRadius;

-  /// The color to use when painting the cursor.
+  /// The color used to paint the cursor.


We seem to be on a nice trajectory here :-). How about : The color of the cursor. Here and elsewhere and in general. For example: The color of the TextField's selection handles, instead of "The color used to paint the selection handles on the text field".

HansMuller · 2020-07-23T22:11:48Z

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

  ///
-  /// Defaults to [ThemeData.cursorColor] or [CupertinoTheme.primaryColor]
-  /// depending on [ThemeData.platform].
+  /// The cursor indicates the current location of text input in the field.


Doesn't indicate the current text insertion point? Here and elsewhere.

HansMuller · 2020-07-23T22:29:28Z

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

+}
+
+/// An inherited widget that defines the configuration for
+/// the rendering of text selection in this widget's subtree.


that defines the configuration for the rendering of text selection => that defines the appearance of text selection

HansMuller · 2020-07-23T22:31:02Z

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

+///     cursorColor: Colors.blue,
+///     selectionHandleColor: Colors.lightBlue,
+///   ),
+///   child: TextField(),


This works because the TextField doesn't actually use TextSelectionTheme directly right? Otherwise we'd have to include a Builder.

TextField looks up the current theme with TextSelectionTheme.of(context) in the build method, so it should work fine here.

HansMuller · 2020-07-23T22:31:48Z

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

@@ -319,7 +322,6 @@ class ThemeData with Diagnosticable {
    // Spec doesn't specify a dark theme secondaryHeaderColor, this is a guess.
    secondaryHeaderColor ??= isDark ? Colors.grey[700] : primarySwatch[50];
    textSelectionColor ??= isDark ? accentColor : primarySwatch[200];
-    // TODO(hansmuller): We need a TextFieldTheme to handle this instead, https://github.com/flutter/flutter/issues/56082


…s in the flutter_gallery community tests.

Create a new TextSelectionTheme for text selection properties.

darrenaustin requested a review from HansMuller July 22, 2020 07:51

googlebot added the cla: yes label Jul 22, 2020

darrenaustin requested review from gspencergoog and justinmc July 22, 2020 07:52

darrenaustin added f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Jul 22, 2020

justinmc approved these changes Jul 22, 2020

View reviewed changes

googlebot added cla: no and removed cla: yes labels Jul 22, 2020

googlebot added cla: yes and removed cla: no labels Jul 22, 2020

gspencergoog approved these changes Jul 23, 2020

View reviewed changes

HansMuller approved these changes Jul 23, 2020

View reviewed changes

darrenaustin added 4 commits August 4, 2020 12:34

Create a new TextSelectionTheme for text selection properties.

23fa203

Review comment updates.

5d99826

Removed the deprecations for this first step as it introduced failure…

1f5ac28

…s in the flutter_gallery community tests.

Fixed dart doc comments.

7309c38

darrenaustin merged commit bebc119 into flutter:master Aug 4, 2020

darrenaustin deleted the text_selection_theme branch August 4, 2020 23:06

Pragya007 pushed a commit to Pragya007/flutter that referenced this pull request Aug 11, 2020

TextSelectionTheme support (step 1 of 3) (flutter#62014)

71ecd90

Create a new TextSelectionTheme for text selection properties.

This was referenced Sep 1, 2020

TextSelectionTheme support (step 2 of 3) #65044

Merged

Missing API for TextSelectionToolbar styling #22210

Closed

mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020

TextSelectionTheme support (step 1 of 3) (flutter#62014)

f3fc2a1

Create a new TextSelectionTheme for text selection properties.

darrenaustin restored the text_selection_theme branch September 8, 2020 21:26

This was referenced Sep 12, 2020

Migrate Gallery to use the new TextSelectionTheme. flutter/gallery#295

Merged

ColorScheme Theme Quality Issues - Gaps in completeness and inconsistencies #65782

Open

darrenaustin mentioned this pull request Sep 23, 2020

TextSelectionTheme support (step 3 of 3) #66482

Merged

9 tasks

This was referenced Sep 30, 2020

Theme cursor color not working on iOS dark mode #66869

Closed

Text selection handle color should be accent color by default #17635

Closed

darrenaustin deleted the text_selection_theme branch April 26, 2021 20:55

TextSelectionTheme support (step 1 of 3) #62014

TextSelectionTheme support (step 1 of 3) #62014

Uh oh!

Conversation

darrenaustin commented Jul 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

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

Uh oh!

googlebot commented Jul 22, 2020

Uh oh!

googlebot commented Jul 22, 2020

Uh oh!

gspencergoog left a comment

Choose a reason for hiding this comment

Uh oh!

gspencergoog Jul 22, 2020

Choose a reason for hiding this comment

Uh oh!

HansMuller left a comment

Choose a reason for hiding this comment

Uh oh!

HansMuller Jul 23, 2020

Choose a reason for hiding this comment

Uh oh!

HansMuller Jul 23, 2020

Choose a reason for hiding this comment

Uh oh!

HansMuller Jul 23, 2020

Choose a reason for hiding this comment

Uh oh!

HansMuller Jul 23, 2020

Choose a reason for hiding this comment

Uh oh!

darrenaustin Jul 27, 2020

Choose a reason for hiding this comment

Uh oh!

HansMuller Jul 23, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

darrenaustin commented Jul 22, 2020 •

edited

Loading