Add definition for composed selection range #1342

dizhang168 · 2024-12-17T23:55:59Z

As discussed at TPAC 2024, the specification for the new getComposedRanges() API need the introduction of the new definition "Composed live range" [1], which should react to mutations. This PR attempts to define that new concept. Once landed, we will add the spec language that uses composed live range in the Selection API. An overview of the spec changes necessary can be found at [2].

[1] w3c/selection-api#2 (comment)
[2] https://github.com/dizhang168/shadow-dom-selection/blob/main/selection-api-spec-changes.md

01/28/2025 Edit: Changed naming to Composed Selection Range.

At least two implementers are interested (and none opposed):
- Chromium: Positive
- Webkit: Positive (Selection API: getComposedRanges mozilla/standards-positions#1055)
- Gecko: Positive (Selection API: getComposedRanges WebKit/standards-positions#376)
Tests are written and can be reviewed and commented upon at:
- This PR introduces an internal concept as a Composed Live Range is not exposed directly to the user
- getComposedRanges() function tests can be found at: https://wpt.fyi/results/selection/shadow-dom/tentative?label=experimental&label=master&aligned
Implementation bugs are filed:
- Chromium: https://issues.chromium.org/issues/40286116
- Gecko: https://bugzilla.mozilla.org/show_bug.cgi?id=1430308
- WebKit: https://bugs.webkit.org/show_bug.cgi?id=216325
MDN issue is filed:
- Not necessary since live range and composed selection range are all definitions/concepts and not web exposed.
The top of this comment includes a clear commit message to use.

(See WHATWG Working Mode: Changes for more details.)

Preview | Diff

annevk

@smaug---- you should review this as well in due course. And @rniwa too I suspect.

dom.bs

dizhang168 · 2025-01-24T21:56:46Z

I have opened the draft PR for Selection API to use the definition described here, to help visualize:
w3c/selection-api#345

When a live range attached to a document is modified, this change is upstreamed to the FrameSelection. New spec [1] says to only update the composed live range (frame selection)'s start position if setStart is called and only update end position if setEnd is called: whatwg/dom#1342 This is the proposal (B) discussed here: whatwg/dom#772 (comment) To do this, we define enum UpdateSelectionIfAddedToSelection to have three possible update selection behavior: 1. kAll, set selection to have the same start and end as range. --> Default case, when both setStart, setEnd are called. 2. kStartOnly, set selection to have the same start as range only. --> When only setStart is called. 3. kEndOnly, set selection to have the same end as range only. --> When only setEnd is called. We add a WPT test for this new behavior, which only affects the output of getComposedRanges() as it is the only API that accesses the frame selection's endpoints directly. Change-Id: I51ea53fe6156164ba3fbe38b14bc47ff502633b1 Bug: 40286116 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6188157 Reviewed-by: Siye Liu <[email protected]> Commit-Queue: Di Zhang <[email protected]> Cr-Commit-Position: refs/heads/main@{#1411209}

…dateSelectionIfAddedToSelection, a=testonly Automatic update from web-platform-tests Add UpdateSelectionBehavior to Range::UpdateSelectionIfAddedToSelection When a live range attached to a document is modified, this change is upstreamed to the FrameSelection. New spec [1] says to only update the composed live range (frame selection)'s start position if setStart is called and only update end position if setEnd is called: whatwg/dom#1342 This is the proposal (B) discussed here: whatwg/dom#772 (comment) To do this, we define enum UpdateSelectionIfAddedToSelection to have three possible update selection behavior: 1. kAll, set selection to have the same start and end as range. --> Default case, when both setStart, setEnd are called. 2. kStartOnly, set selection to have the same start as range only. --> When only setStart is called. 3. kEndOnly, set selection to have the same end as range only. --> When only setEnd is called. We add a WPT test for this new behavior, which only affects the output of getComposedRanges() as it is the only API that accesses the frame selection's endpoints directly. Change-Id: I51ea53fe6156164ba3fbe38b14bc47ff502633b1 Bug: 40286116 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6188157 Reviewed-by: Siye Liu <[email protected]> Commit-Queue: Di Zhang <[email protected]> Cr-Commit-Position: refs/heads/main@{#1411209} -- wpt-commits: e679be39aa83e65a06627a8a5b911648f5312f13 wpt-pr: 50283

dom.bs

…dateSelectionIfAddedToSelection, a=testonly Automatic update from web-platform-tests Add UpdateSelectionBehavior to Range::UpdateSelectionIfAddedToSelection When a live range attached to a document is modified, this change is upstreamed to the FrameSelection. New spec [1] says to only update the composed live range (frame selection)'s start position if setStart is called and only update end position if setEnd is called: whatwg/dom#1342 This is the proposal (B) discussed here: whatwg/dom#772 (comment) To do this, we define enum UpdateSelectionIfAddedToSelection to have three possible update selection behavior: 1. kAll, set selection to have the same start and end as range. --> Default case, when both setStart, setEnd are called. 2. kStartOnly, set selection to have the same start as range only. --> When only setStart is called. 3. kEndOnly, set selection to have the same end as range only. --> When only setEnd is called. We add a WPT test for this new behavior, which only affects the output of getComposedRanges() as it is the only API that accesses the frame selection's endpoints directly. Change-Id: I51ea53fe6156164ba3fbe38b14bc47ff502633b1 Bug: 40286116 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6188157 Reviewed-by: Siye Liu <[email protected]> Commit-Queue: Di Zhang <[email protected]> Cr-Commit-Position: refs/heads/main@{#1411209} -- wpt-commits: e679be39aa83e65a06627a8a5b911648f5312f13 wpt-pr: 50283

… start/end algorithm

dom.bs

smaug---- · 2025-02-19T17:03:18Z

dom.bs

+
+<p>A <dfn export id=concept-composed-selection-range>composed selection range</dfn> is a
+<a>live range</a> that has an associated {{Range}} object, a
+<dfn export id=concept-legacy-selection-range for="composed selection range">legacy selection range</dfn>.</p>


Nit, I don't like calling the normal Range as legacy. Nothing really legacy there.

It's not the Range object that's legacy, it's having to keep around a pretend range for the purposes of the selection API as it was designed pre-shadow-trees that's kinda legacy.

Sure, but I don't still like it. It is not legacy, in the sense that there would be some better thing to replace it or so (in case of light dom). "Legacy" doesn't explain what the range is for.

What would you propose?

maybe the legacy selection range could be same-tree selection range, and composed selection range could be composed-tree selection range?

same-tree selection range sounds kinda nice. I personally think "composed selection range" is fine as-is.

Listing the naming options:

"composed live range" and "cached live range"

"composed selection range" and "legacy selection range"

"composed-tree selection range" and "same-tree selection range"

"composed selection range" and "same-tree selection range"

"composed selection range" and "selection range"

All these names seem ok to me, I will let the majority decide.

Based on an email conversation I'm a bit less sure what the semantics of this range are. Say you have an element with a shadow root that contains the word "Test". The end user selects "es". getSelection() should not provide access to this shadow root, but apparently the set of changes proposed here do not enforce that. Or am I misunderstanding something?

dom.bs

domfarolino self-requested a review December 19, 2024 18:40

domfarolino added the agenda+ To be discussed at a triage meeting label Jan 16, 2025

past mentioned this pull request Jan 16, 2025

Upcoming WHATNOT meeting on 2025-01-16 whatwg/html#10906

Closed

annevk reviewed Jan 17, 2025

View reviewed changes

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dizhang168 added 2 commits January 21, 2025 17:20

Add definition for composed live range

7c48fa5

Review, format changes

487cac0

dizhang168 force-pushed the composed-live-range branch from 54e6984 to 487cac0 Compare January 22, 2025 01:21

annevk mentioned this pull request Jan 23, 2025

Upcoming WHATNOT meeting on 2025-01-23 whatwg/html#10923

Closed

Fix collapse logic for set the start or end

461aed7

dizhang168 mentioned this pull request Jan 24, 2025

Change Selection to be associated with a composed live range w3c/selection-api#345

Draft

8 tasks

Fix for= typo

413348d

chromium-wpt-export-bot mentioned this pull request Jan 25, 2025

Add UpdateSelectionBehavior to Range::UpdateSelectionIfAddedToSelection web-platform-tests/wpt#50283

Merged

domfarolino added 2 commits January 28, 2025 10:34

Linking nit

c7f38b1

Remove em dash to fix spacing in rendered spec

1f74a51

domfarolino reviewed Jan 28, 2025

View reviewed changes

dom.bs Outdated Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

dom.bs Show resolved Hide resolved

dom.bs Outdated Show resolved Hide resolved

Review changes: rename composed live range, improve format of set the…

f5b6935

… start/end algorithm

dizhang168 changed the title ~~Add definition for composed live range~~ Add definition for composed selection range Jan 28, 2025

domfarolino reviewed Jan 30, 2025

View reviewed changes

dom.bs Show resolved Hide resolved

past removed the agenda+ To be discussed at a triage meeting label Jan 30, 2025

past mentioned this pull request Jan 30, 2025

Upcoming WHATNOT meeting on 2025-01-30 whatwg/html#10941

Closed

smaug---- reviewed Feb 19, 2025

View reviewed changes

sefeng211 reviewed Feb 19, 2025

View reviewed changes

dom.bs Show resolved Hide resolved

domfarolino reviewed Feb 25, 2025

View reviewed changes

dom.bs Show resolved Hide resolved

dom.bs Show resolved Hide resolved

define composed selection range separately from live range

367288b

Update composed selection range definition

fe020ca

dizhang168 mentioned this pull request Feb 27, 2025

Should Live Range expose endpoints inside a shadow tree? #1362

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add definition for composed selection range #1342

Add definition for composed selection range #1342

dizhang168 commented Dec 17, 2024 •

edited by pr-preview bot

Loading

annevk left a comment

dizhang168 commented Jan 24, 2025

smaug---- Feb 19, 2025

annevk Feb 24, 2025

smaug---- Feb 24, 2025

annevk Feb 25, 2025

sefeng211 Feb 25, 2025

domfarolino Feb 25, 2025

dizhang168 Feb 27, 2025

annevk Feb 27, 2025

Add definition for composed selection range #1342

Are you sure you want to change the base?

Add definition for composed selection range #1342

Conversation

dizhang168 commented Dec 17, 2024 • edited by pr-preview bot Loading

annevk left a comment

Choose a reason for hiding this comment

dizhang168 commented Jan 24, 2025

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

dizhang168 commented Dec 17, 2024 •

edited by pr-preview bot

Loading