Skip to content

[DOM] Scroll to text siblings of empty Fragments instead of the parent - #37060

Merged
eps1lon merged 3 commits into
mainfrom
sebbie/getinstancefromhostfiber-types-8d5392
Jul 19, 2026
Merged

[DOM] Scroll to text siblings of empty Fragments instead of the parent#37060
eps1lon merged 3 commits into
mainfrom
sebbie/getinstancefromhostfiber-types-8d5392

Conversation

@eps1lon

@eps1lon eps1lon commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

When a Fragment has no children, React would consider scrolling to siblings first and then to parents. However, React only considered HostComponent for the siblings.

Since we already have a heuristic for scrolling to HostText, we can reuse that same heuristic.

I used the opportunity to encode the state node types of the returned/handled Fibers in the relevant methods which makes this bug more obvious and revealed two more:

  1. We could land on document.ownerDocument.activeElement. ownerDocument is null for Document instead of a circular pointer. React hits this case when calling fragmentInstance.blur() on a Fragment below the document.
  2. When we have an empty Fragment and no text siblings, we attempt to scroll the parent which could be a Document or ShadowRoot. Those don't have scrollIntoView

I also noticed we skip HostSingleton. Seems to me we should start collecting these. Their stateNode will also be an Instance and not hoisted away. For react-dom that would mean a Fragment below <body> would scroll the body

@meta-cla meta-cla Bot added the CLA Signed label Jul 19, 2026
@github-actions github-actions Bot added the React Core Team Opened by a member of the React Core Team label Jul 19, 2026
@eps1lon
eps1lon requested review from gaearon and jackpope July 19, 2026 10:11
@eps1lon eps1lon changed the title [Fiber] Scroll to text siblings of empty Fragments instead of the parent [DOM] Scroll to text siblings of empty Fragments instead of the parent Jul 19, 2026
@eps1lon
eps1lon marked this pull request as ready for review July 19, 2026 10:13
@react-sizebot

react-sizebot commented Jul 19, 2026

Copy link
Copy Markdown

Comparing: 172742b...6d6a06b

Critical size changes

Includes critical production bundles, as well as any change greater than 2%:

Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable/react-dom/cjs/react-dom.production.js = 7.19 kB 7.19 kB = 1.91 kB 1.91 kB
oss-stable/react-dom/cjs/react-dom-client.production.js +0.12% 614.21 kB 614.95 kB +0.12% 108.58 kB 108.71 kB
oss-experimental/react-dom/cjs/react-dom.production.js = 7.19 kB 7.19 kB = 1.91 kB 1.91 kB
oss-experimental/react-dom/cjs/react-dom-client.production.js +0.11% 685.39 kB 686.14 kB +0.10% 120.07 kB 120.19 kB
facebook-www/ReactDOM-prod.classic.js +0.11% 705.24 kB 706.05 kB +0.10% 123.51 kB 123.63 kB
facebook-www/ReactDOM-prod.modern.js +0.12% 695.56 kB 696.37 kB +0.10% 121.90 kB 122.03 kB
oss-experimental/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-stable/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-experimental/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB
oss-stable/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB

Significant size changes

Includes any change greater than 0.2%:

Expand to show
Name +/- Base Current +/- gzip Base gzip Current gzip
oss-experimental/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-stable/react-reconciler/cjs/react-reconciler-reflection.development.js +4.54% 12.79 kB 13.37 kB +1.62% 2.72 kB 2.76 kB
oss-experimental/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB
oss-stable-semver/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB
oss-stable/react-reconciler/cjs/react-reconciler-reflection.production.js +3.93% 11.32 kB 11.77 kB +2.34% 2.64 kB 2.71 kB

Generated by 🚫 dangerJS against 6d6a06b

eps1lon and others added 3 commits July 19, 2026 12:24
…eFromHostFiber callsites honestly

`getInstanceFromHostFiber` returns a different kind of instance depending
on the fiber tag: an `Instance` for HostComponent, a `TextInstance` for
HostText, and a `Container` for HostRoot. The generic was unconstrained,
and every callsite instantiated it as `<Instance>`, which is unsound
whenever the passed fiber is not guaranteed to be a HostComponent.

The generic is now bounded as `<I: Instance | TextInstance | Container>`
so it can only be constrained to types the function can actually return.
The fragment traversal helpers now carry the instance types of the
fibers they can yield in their names (`traverseFragmentInstance` becomes
`traverseFragmentInstancesAndTextInstances`, `getFragmentParentHostFiber`
becomes `getFragmentParentInstanceOrContainerFiber`, and
`getNextSiblingHostFiber` becomes
`getNextSiblingInstanceOrTextInstanceFiber`), so each callsite can
instantiate the generic with the union that actually matches:
`<Instance>` only where a preceding HostText guard leaves HostComponent,
`<Instance | TextInstance>` for traversal children, and
`<Instance | Container>` for parent host fibers. Naming by instance type
rather than fiber tag keeps these names stable once HostSingleton and
HostHoistable, whose `stateNode` is also an `Instance`, are handled by
the helpers. The fragment handle path now uses a
`HostNodeWithFragmentHandles` type based on `Instance | TextInstance`
since those children can be text fibers.

The honest types reveal a real bug in
`FragmentInstance.prototype.scrollIntoView`: when a fragment has no
children and no host component siblings, the target falls back to the
parent host fiber, which can be a HostRoot. Its instance is a `Container`
(potentially a `Document` or `DocumentFragment`), which has no
`scrollIntoView` method, so the call crashes at runtime. That callsite is
marked with a TODO and a targeted suppression; the runtime fix will land
separately.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…empty fragment

When an empty FragmentInstance only has text node siblings, they are
skipped by `getFragmentInstanceSiblings`, which only collects
HostComponent fibers. The default `scrollIntoView()` call then falls
back to scrolling the parent host instance instead of using the Range
API to scroll to the adjacent text node, and `scrollIntoView(false)`
finds no target at all and warns without performing any scroll.

The test mocks the parent's `scrollIntoView` and `window.scrollTo` and
asserts on the calls to pin down this behavior. Once text siblings are
collected and scrolled to with the Range API, like text children already
are, these assertions should flip to verifying the actual scroll target.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
An empty FragmentInstance with only text node siblings previously
scrolled the parent host instance on the default `scrollIntoView()` call
and performed no scroll at all for `scrollIntoView(false)`, because
`findFragmentInstanceSiblings` only collected HostComponent fibers.

The sibling search now also collects HostText fibers when
`enableFragmentRefsTextNodes` is enabled, and both functions carry the
new instance type in their names as
`getFragmentInstanceOrTextInstanceSiblings` and
`findFragmentInstanceOrTextInstanceSiblings`. When the scroll target
fiber is a HostText, `scrollIntoView` computes the position with the
Range API, using the same logic that already handled text children.
That logic is extracted into a shared `scrollTextNodeIntoView` helper,
and the `getInstanceFromHostFiber` calls on text fibers are instantiated
as `<TextInstance>` now that the preceding tag checks guarantee it.

The test added in the previous commit flips from documenting the broken
fallback behavior to asserting that both scroll directions target the
adjacent text sibling through `window.scrollTo`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@eps1lon
eps1lon force-pushed the sebbie/getinstancefromhostfiber-types-8d5392 branch from a96f72b to 6d6a06b Compare July 19, 2026 10:53

@daltino daltino left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR refines the behavior for scrolling to empty fragments' text siblings. The naming improvements in the functions (e.g., traverseFragmentInstancesAndTextInstances) and updates to internal tests suggest thoughtful updates and alignment across DOM and React Native. The changes seem well-scoped and add clarity while maintaining functionality.

@eps1lon
eps1lon merged commit 2ba07c6 into main Jul 19, 2026
238 checks passed
@eps1lon
eps1lon deleted the sebbie/getinstancefromhostfiber-types-8d5392 branch July 19, 2026 19:42
github-actions Bot pushed a commit that referenced this pull request Jul 19, 2026
#37060)

When a Fragment has no children, React would consider scrolling to
siblings first and then to parents. However, React only considered
`HostComponent` for the siblings.

Since we already have a heuristic for scrolling to `HostText`, we can
reuse that same heuristic.

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

DiffTrain build for [2ba07c6](2ba07c6)
github-actions Bot pushed a commit that referenced this pull request Jul 19, 2026
#37060)

When a Fragment has no children, React would consider scrolling to
siblings first and then to parents. However, React only considered
`HostComponent` for the siblings.

Since we already have a heuristic for scrolling to `HostText`, we can
reuse that same heuristic.

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

DiffTrain build for [2ba07c6](2ba07c6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed React Core Team Opened by a member of the React Core Team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants