SelectionArea support for triple click/tap to select line on Linux #153514

Renzo-Olivares · 2024-08-15T18:30:44Z

This change adds support for triple click/tap to select a line at the location on Linux. Also adds support for extending selection by line on triple click followed by a drag.

Fixes: #129583

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.

Renzo-Olivares · 2024-09-25T20:50:46Z

This is ready for a review, curious to hear thoughts on the SelectBoundarySelectionEvent and SelectMultiSelectableBoundarySelectionEvent.

justinmc

LGTM 👍 Code duplication with editable text doesn't look too bad.

justinmc · 2024-09-26T21:21:12Z

packages/flutter/lib/src/rendering/paragraph.dart

          case TextGranularity.line:
-            assert(false, 'Moving the selection edge by line or document is not supported.');
+            result = _updateSelectionEdgeByMultiSelectableTextBoundary(edgeUpdate.globalPosition, isEnd: edgeUpdate.type == SelectionEventType.endEdgeUpdate, getTextBoundary: _getLineBoundaryAtPosition, getClampedTextBoundary: _getClampedLineBoundaryAtPosition);


Nit: Break this onto multiple lines to make it more readable?

justinmc · 2024-09-26T21:28:49Z

packages/flutter/test/widgets/selectable_region_test.dart

+        ),
+      );
+      final RenderParagraph paragraph = tester.renderObject<RenderParagraph>(find.descendant(of: find.text(longText), matching: find.byType(RichText)));
+      final TestGesture gesture = await tester.startGesture(textOffsetToPosition(paragraph, 2), kind: PointerDeviceKind.mouse);


Nit: Maybe comment that this is a triple click (like you did below).

And in a few other places too.

justinmc · 2024-09-27T22:50:18Z

packages/flutter/test/widgets/selectable_region_test.dart

+
+      await gesture.up();
+    }, variant: TargetPlatformVariant.only(TargetPlatform.linux),
+       skip: kIsWeb); // https://github.com/flutter/flutter/issues/125582.


Nit: Closing parenthesis on the next line (here and elsewhere).

chunhtai · 2024-09-30T22:44:19Z

packages/flutter/lib/src/rendering/paragraph.dart

@@ -1441,6 +1442,15 @@ class _SelectableFragment with Selectable, Diagnosticable, ChangeNotifier implem
        } else {
          result = _handleSelectParagraph(selectParagraph.globalPosition);
        }
+      case SelectionEventType.selectLine:


I wonder if it is possible to use pattern match like

case SelectLineSelectionEvent event so that we no longer rely on the event type and downward cast

This works! Any thoughts on binding to a variable vs not?

case SelectLineSelectionEvent event: vs case SelectLineSelectionEvent():

I am not sure, but from the looks of it, it seems the later will create a new object which may not be necessary?

I don’t think either creates a new object, the latter just requires that syntax for pattern matching. The former creates a reference to the original object from what I understand.

chunhtai · 2024-09-30T23:05:12Z

packages/flutter/lib/src/rendering/paragraph.dart

          case TextGranularity.line:
-            assert(false, 'Moving the selection edge by line or document is not supported.');
+            result = _updateSelectionEdgeByMultiSelectableTextBoundary(edgeUpdate.globalPosition, isEnd: edgeUpdate.type == SelectionEventType.endEdgeUpdate, getTextBoundary: _getLineBoundaryAtPosition, getClampedTextBoundary: _getClampedLineBoundaryAtPosition);


the indent for this _updateSelectionEdgeByMultiSelectableTextBoundary declaration is off.

SelectionResult _updateSelectionEdgeByMultiSelectableTextBoundary( Offset globalPosition, { required bool isEnd, required _TextBoundaryAtPositionInText getTextBoundary, required _TextBoundaryAtPosition getClampedTextBoundary, }) {

chunhtai · 2024-09-30T23:08:25Z

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

+  const SelectMultiSelectableBoundarySelectionEvent._(this.absorb, Offset globalPosition, SelectionEventType type) : super._(globalPosition, type);
+
+  /// Whether the selectable receiving the event should be absorbed into
+  /// an encompassing boundary.


Can you explain a bit more in the doc? what is encompassing boundary?

Added some more docs in bf5d04c (#153514).

chunhtai · 2024-09-30T23:12:23Z

packages/flutter/lib/src/rendering/paragraph.dart

@@ -1441,6 +1442,15 @@ class _SelectableFragment with Selectable, Diagnosticable, ChangeNotifier implem
        } else {
          result = _handleSelectParagraph(selectParagraph.globalPosition);
        }
+      case SelectionEventType.selectLine:
+        final SelectLineSelectionEvent selectLine = event as SelectLineSelectionEvent;
+        if (selectLine.absorb) {


can you explain a bit what absorb is and how is it use?

I added absorb to support cases like below:

| Start of paragraph | | inline element | | End of paragraph |

If we click somewhere on the Start of paragraph or End of paragraph it should select all content in the inline element. This is consistent with the behavior on web and with our SelectableText.

Screen.Recording.2024-10-01.at.11.43.38.AM.mov

Screen.Recording.2024-10-01.at.11.47.42.AM.mov

When a Selectable receives this event set to true it should select all of its contents, and be absorbed into the boundary. When it is false it should process the event as normal.

In that case should the parent selectable container send a select all event directly to the inline element?

I think with a select all event the child won't be able to differentiate that its selection is part of an encompassing boundary. Right now It uses this information maintain its selection as part of the origin of the selection

flutter/packages/flutter/lib/src/rendering/paragraph.dart

Line 1501 in b8dcb0c

if (_selectableContainsOriginTextBoundary && existingSelectionStart != null && existingSelectionEnd != null) {

.

…by line on triple click + drag on Linux platform

chunhtai · 2024-10-30T17:54:12Z

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

+  /// When [absorb] is set to false, and a [Selectable] that is inline with a boundary
+  /// receives this event, it should find the end of the boundary relative to itself
+  /// and stop searching.
+  final bool absorb;


based on the doc and the code, can we replace case with absorb = true with a select all event?

Answered in: #153514 (comment)

chunhtai · 2024-10-30T17:55:30Z

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

+  /// Whether the [Selectable] receiving the event should be completely
+  /// absorbed into a boundary.
+  ///
+  /// For example, when [absorb] is set to true, and a [Selectable] that is inline


what is inline within a boundary?

When I said "inline" I was thinking about text. I think just a [Selectable] within a boundary is more clear.

same here inline within any piece of text doesn't really help me understand

chunhtai · 2024-10-30T17:55:54Z

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

+  const SelectMultiSelectableBoundarySelectionEvent._(this.absorb, Offset globalPosition, SelectionEventType type) : super._(globalPosition, type);
+
+  /// Whether the [Selectable] receiving the event should be completely
+  /// absorbed into a boundary.


I can't parse this sentence either.

it feel to me the boundary word has other meaning in this doc, can you explain a bit more?

By boundary I meant a range within some content with a start and end. This boundary can be across multiple Selectables. Some Selectables within a boundary should be able to be considered as part of that boundary as a single unit rather than granularly. Let me know if I can explain more.

does that mean any piece of text like TextBoundary? It is not very useful in this doc context.

I meant reading this doc as a developer who implement Selecable subclass. I still won't know how to deal with this boolean. Some example or a better name would be better.

justinmc · 2024-11-14T23:12:39Z

@Renzo-Olivares Heads up you have merge conflicts.

chunhtai

forgot to submit my last round of review. I remember we have a discussion offline that suggest some other way to avoid the boolean, is this pr ready for another look? @Renzo-Olivares

chunhtai · 2024-11-13T21:32:33Z

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

+  const SelectMultiSelectableBoundarySelectionEvent._(this.absorb, Offset globalPosition, SelectionEventType type) : super._(globalPosition, type);
+
+  /// Whether the [Selectable] receiving the event should be completely
+  /// absorbed into a boundary.


does that mean any piece of text like TextBoundary? It is not very useful in this doc context.

chunhtai · 2024-11-13T21:35:11Z

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

+  const SelectMultiSelectableBoundarySelectionEvent._(this.absorb, Offset globalPosition, SelectionEventType type) : super._(globalPosition, type);
+
+  /// Whether the [Selectable] receiving the event should be completely
+  /// absorbed into a boundary.


I meant reading this doc as a developer who implement Selecable subclass. I still won't know how to deal with this boolean. Some example or a better name would be better.

chunhtai · 2024-11-13T21:36:05Z

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

+  /// Whether the [Selectable] receiving the event should be completely
+  /// absorbed into a boundary.
+  ///
+  /// For example, when [absorb] is set to true, and a [Selectable] that is inline


same here inline within any piece of text doesn't really help me understand

Piinks · 2025-02-26T00:10:11Z

@Renzo-Olivares says this is still on his radar to return to in the future.

Piinks · 2025-04-30T22:52:14Z

Hey @Renzo-Olivares this one came up again in stale PR triage - is it still something you'd like to work on?

Renzo-Olivares mentioned this pull request Aug 15, 2024

SelectionArea supported gestures should have feature parity with TextSelectionGestureDetector #129583

Open

Renzo-Olivares force-pushed the sr-extendbyline branch from 49fc431 to c145704 Compare September 10, 2024 00:58

Renzo-Olivares force-pushed the sr-extendbyline branch 2 times, most recently from e0035e1 to 18498b3 Compare September 25, 2024 20:44

Renzo-Olivares marked this pull request as ready for review September 25, 2024 20:45

Renzo-Olivares requested review from chunhtai and justinmc September 25, 2024 20:49

justinmc approved these changes Sep 27, 2024

View reviewed changes

chunhtai reviewed Sep 30, 2024

View reviewed changes

Renzo Olivares added 8 commits September 30, 2024 22:14

Add support for selecting line on triple tap and extending selection …

ee44fc0

…by line on triple click + drag on Linux platform

updates to docs

77cb77c

abstract SelectWord/SelectParagraph/SelectLine selection events

4103d61

Updates

a1afb09

getLineAtOffset should return unclamped line and add tests

7567999

clean up

ce560fe

update method names

d48c3f4

address reviewer nits

a5b3dd6

Renzo-Olivares force-pushed the sr-extendbyline branch from 09194c7 to a5b3dd6 Compare October 1, 2024 05:14

Renzo Olivares added 3 commits September 30, 2024 22:45

address reviewer comments - use pattern matching

fa377cd

address comments

21c29ef

absorb docs

bf5d04c

Renzo-Olivares requested a review from chunhtai October 1, 2024 18:50

chunhtai reviewed Oct 30, 2024

View reviewed changes

chunhtai self-requested a review November 12, 2024 23:15

chunhtai reviewed Dec 9, 2024

View reviewed changes

Renzo-Olivares marked this pull request as draft December 9, 2024 20:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SelectionArea support for triple click/tap to select line on Linux #153514

SelectionArea support for triple click/tap to select line on Linux #153514

Renzo-Olivares commented Aug 15, 2024 •

edited

Loading

Renzo-Olivares commented Sep 25, 2024

justinmc left a comment

justinmc Sep 26, 2024

justinmc Sep 26, 2024

justinmc Sep 27, 2024

justinmc Sep 27, 2024

chunhtai Sep 30, 2024

Renzo-Olivares Oct 1, 2024

chunhtai Oct 1, 2024

Renzo-Olivares Oct 2, 2024

chunhtai Sep 30, 2024

chunhtai Sep 30, 2024

Renzo-Olivares Oct 1, 2024

chunhtai Sep 30, 2024

Renzo-Olivares Oct 1, 2024 •

edited

Loading

chunhtai Oct 30, 2024

Renzo-Olivares Oct 30, 2024

chunhtai Oct 30, 2024

Renzo-Olivares Oct 30, 2024

chunhtai Oct 30, 2024

Renzo-Olivares Oct 30, 2024

chunhtai Nov 13, 2024

chunhtai Oct 30, 2024

chunhtai Oct 30, 2024

Renzo-Olivares Oct 30, 2024

chunhtai Nov 13, 2024

chunhtai Nov 13, 2024

justinmc commented Nov 14, 2024

chunhtai left a comment

chunhtai Nov 13, 2024

chunhtai Nov 13, 2024

chunhtai Nov 13, 2024

Piinks commented Feb 26, 2025

Piinks commented Apr 30, 2025

SelectionArea support for triple click/tap to select line on Linux #153514

Are you sure you want to change the base?

SelectionArea support for triple click/tap to select line on Linux #153514

Conversation

Renzo-Olivares commented Aug 15, 2024 • edited Loading

Pre-launch Checklist

Renzo-Olivares commented Sep 25, 2024

justinmc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Renzo-Olivares Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmc commented Nov 14, 2024

chunhtai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Piinks commented Feb 26, 2025

Piinks commented Apr 30, 2025

Renzo-Olivares commented Aug 15, 2024 •

edited

Loading

Renzo-Olivares Oct 1, 2024 •

edited

Loading