Add default selection style #100719

chunhtai · 2022-03-24T20:38:02Z

based on #99576

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.

HansMuller

This looks good, just some trivial feedback to prove that I read the code :-).

HansMuller · 2022-04-09T00:26:46Z

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

@@ -712,7 +712,8 @@ class CupertinoTextField extends StatefulWidget {

  /// The color to use when painting the cursor.
  ///
-  /// Defaults to the [CupertinoThemeData.primaryColor] of the ambient theme,
+  /// Defaults to the [DefaultSelectionStyle.cursorColor]. If that color is


I assume that we have a test that checks this default for the light/dark themes; likewise for selectionColor.

The existing tests covered it

HansMuller · 2022-04-09T00:29:20Z

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

-            child: Builder(
-              builder: _buildWidgetApp,
+          child: DefaultSelectionStyle(
+            selectionColor: effectiveThemeData.primaryColor.withOpacity(0.2),


What's the 0.2 opacity based on?

This is the value that the CupertinoTextField uses. Since CupertinoTextField needs to be under CupertinoApp, so I put the value up to the CupertinoApp. This will however change the behavior for TextField that is under CupertinoApp, I am not sure whether that will be a problem

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

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

HansMuller · 2022-04-09T00:58:39Z

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

+  }) : assert(data != null),
+      super(key: key, child: _wrapsWithDefaultSelectionStyle(data, child));
+
+  static Widget _wrapsWithDefaultSelectionStyle(TextSelectionThemeData data, Widget child) {


This function could be a widget with a const constructor

how would that help with making TextSelectionTheme const? the use the const widget in the initializer, the input also needs to be const value.

so I can't do

super(key: key, child: const MyWidget(data: data, child: child));

because the data and child is runtime value.

Although i can make it const by doing some hack, but that will need to rely on the implementation detail of ProxyWidget

Even if it's not possible to use a const constructor for a _WithDefaultSelectionStyle() widget, it seems clearer and more in-line with Flutter conventions than using a function that has the same effect.

packages/flutter/lib/src/widgets/selection.dart

HansMuller · 2022-04-12T19:52:04Z

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

  ///
-  /// Defaults to the theme's `cursorColor` when null.
+  /// The cursor indicates the current location of the text insertion point in


The cursor indicates the current location of the text insertion point in the field. =>
The cursor indicates the current text insertion point.

HansMuller · 2022-04-12T19:54:56Z

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

+  /// The cursor indicates the current location of the text insertion point in
+  /// the field.
+  ///
+  /// If this is null it will default to the ambient


If null then [DefaultSelectionStyle.cursorColor] is used. If that is also null and [ThemeData.platform] is [TargetPlatform.iOS] or [TargetPlatform.macOS], then [CupertinoThemeData.primaryColor] is used. Otherwise [ColorScheme.primary] of [ThemeData.colorScheme] is used.

HansMuller · 2022-04-12T19:56:14Z

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


  /// The properties for descendant [TextField] and [SelectableText] widgets.
  final TextSelectionThemeData data;

+  // Overriding the getter to insert `DefaultSelectionStyle` into the subtree
+  // without a breaking change. This should be avoid in general since this


breaking => breaking API

In general, this approach should be avoided because it relies on an implementation detail of ProxyWidget. This workaround is necessary because TextSelectionTheme is const.

HansMuller · 2022-04-12T19:59:00Z

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

+  // without a breaking change. This should be avoid in general since this
+  // relies on the implementation detail of ProxyWidget.
+  //
+  // The `TextSelectionTheme` should be non-const if it were to start


You can leave this out

HansMuller

LGTM

HansMuller · 2022-04-12T21:59:18Z

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

-  }) : assert(data != null), super(key: key, child: child);
+  }) : assert(data != null),
+       _child = child,
+       super(key: key, child: const _NullWidget());


Maybe include a warning comment here:

// See `get child` override below

Sylith1231 · 2022-04-14T08:43:07Z

Should the documentation (https://api.flutter.dev/flutter/material/TextSelectionThemeData/selectionHandleColor.html) be edited to reflect the suggested approach above?

chunhtai · 2022-04-14T16:36:48Z

@Sylith1231 The TextSelectionTheme still works, it will create a defaultSelectionStyle as part of its widget build.

This reverts commit c8057bc.

* Revert "Add default selection style (#100719)" This reverts commit c8057bc. * update * update

This reverts commit 95e52da.

chunhtai mentioned this pull request Mar 24, 2022

Move text selection theme to widget libraries #99576

Closed

8 tasks

chunhtai force-pushed the default-selection branch from 4686f4f to 66a4845 Compare March 24, 2022 23:39

chunhtai requested review from HansMuller and darrenaustin March 25, 2022 21:16

HansMuller reviewed Apr 9, 2022

View reviewed changes

chunhtai added 8 commits April 11, 2022 13:32

Add default selection style

57848d0

add documentation

d28f68f

fix test

35b6381

update

e3c400a

constgit add .

62869a6

update

8ea3054

update

7f4a0e5

fix build

641a282

chunhtai force-pushed the default-selection branch from 564abee to 641a282 Compare April 11, 2022 20:32

more lint

68a6806

chunhtai requested a review from HansMuller April 12, 2022 19:44

updatE

f948c41

HansMuller reviewed Apr 12, 2022

View reviewed changes

HansMuller approved these changes Apr 12, 2022

View reviewed changes

HansMuller mentioned this pull request Apr 12, 2022

Can't locally set 'selectionHandleColor' theme property on IOS. #101672

Closed

fix doc and addressing comments

dbd0015

chunhtai added the waiting for tree to go green label Apr 13, 2022

fluttergithubbot merged commit c8057bc into flutter:master Apr 13, 2022

engine-flutter-autoroll mentioned this pull request Apr 13, 2022

Roll Flutter from 4aa843a606b5 to c8057bc5064f (1 revision) flutter/packages#1520

Merged

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

c8057bc Add default selection style (flutter/flutter#100719)

5a8126b

engine-flutter-autoroll mentioned this pull request Apr 13, 2022

Roll Flutter from a20cd33d6734 to 9526c84b2e48 (7 revisions) flutter/plugins#5255

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Apr 13, 2022

c8057bc Add default selection style (flutter/flutter#100719)

1bd6de1

chunhtai added a commit to chunhtai/flutter that referenced this pull request Apr 14, 2022

Revert "Add default selection style (flutter#100719)"

aca6ba7

This reverts commit c8057bc.

chunhtai added a commit that referenced this pull request Apr 14, 2022

Revert "Add default selection style (#100719)" (#101921)

95e52da

* Revert "Add default selection style (#100719)" This reverts commit c8057bc. * update * update

chunhtai added a commit to chunhtai/flutter that referenced this pull request Apr 15, 2022

Reland "Add default selection style (flutter#100719)"

c57428c

This reverts commit 95e52da.

chunhtai mentioned this pull request Apr 15, 2022

Reland "Add default selection style (#100719)" #101954

Merged

8 tasks

fluttergithubbot pushed a commit that referenced this pull request Apr 15, 2022

Reland "Add default selection style (#100719)" (#101954)

52fd241

Renzo-Olivares mentioned this pull request May 9, 2022

Textfield selection is not deselected after it loses focus #103341

Closed

Add default selection style #100719

Add default selection style #100719

Uh oh!

Conversation

chunhtai commented Mar 24, 2022

Pre-launch Checklist

Uh oh!

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

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!

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!

HansMuller left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sylith1231 commented Apr 14, 2022

Uh oh!

chunhtai commented Apr 14, 2022

Uh oh!

Uh oh!