Describe the bug
Virtualizer.measureElement(node) measures the node synchronously right after observing it, even when the node is not attached to the document yet. A detached node reports offsetHeight === 0, and since there is no cached size on the first measurement, that 0 is stored as the item size.
In Vue this is easy to hit. Function refs run synchronously during patch, so when the rows are created in the same patch as their parent (the sizer is behind v-if and shows up once data is loaded), :ref="(el) => virtualizer.measureElement(el)" is called while the sizer is still detached:
- Every visible row gets size
0 and renders at start: 0, on top of each other.
- On the next frame the ResizeObserver reports the real sizes and the rows spread out.
- The list ends up scrolled down (~305px in the repro, row 9 at the top) instead of staying at the top.
The ResizeObserver callback already ignores disconnected nodes (#1135), but the sync path in measureElement doesn't. #1226 only rejects a 0 when there is a previously cached size, so it doesn't cover the first measurement either.
Your minimal, reproducible example
https://stackblitz.com/github/webn00b/tanstack-vue-virtual-detached-measure
Steps to reproduce
- Open the repro. The scroll container is always rendered; the sizer and the rows are behind
v-if="loaded", which flips after a simulated fetch.
- Rows are measured with
:ref="(el) => virtualizer.measureElement(el)", estimateSize is 60.
- Check the output under the list: the ref calls log
isConnected: false, offsetHeight: 0, and right after nextTick the visible items have start: 0, size: 0.
- After the ResizeObserver fires, the list is at
scrollTop ≈ 305.
Expected behavior
Rows keep their estimateSize positions until they are measured, and the list stays at scrollTop: 0.
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
- OS: macOS
- Browser: Chrome
Not browser-specific, it comes from when Vue calls function refs.
tanstack-virtual version
@tanstack/vue-virtual 3.13.39, @tanstack/virtual-core 3.17.11
TypeScript version
No response
Additional context
Skipping the sync measurement when !node.isConnected fixes it. The node is still observed, so the first frame uses estimateSize, the ResizeObserver delivers the real size once the node is attached, and the scroll position stays at 0. I have a fix with a regression test and can open a PR.
Terms & Code of Conduct
Describe the bug
Virtualizer.measureElement(node)measures the node synchronously right after observing it, even when the node is not attached to the document yet. A detached node reportsoffsetHeight === 0, and since there is no cached size on the first measurement, that0is stored as the item size.In Vue this is easy to hit. Function refs run synchronously during patch, so when the rows are created in the same patch as their parent (the sizer is behind
v-ifand shows up once data is loaded),:ref="(el) => virtualizer.measureElement(el)"is called while the sizer is still detached:0and renders atstart: 0, on top of each other.The ResizeObserver callback already ignores disconnected nodes (#1135), but the sync path in
measureElementdoesn't. #1226 only rejects a0when there is a previously cached size, so it doesn't cover the first measurement either.Your minimal, reproducible example
https://stackblitz.com/github/webn00b/tanstack-vue-virtual-detached-measure
Steps to reproduce
v-if="loaded", which flips after a simulated fetch.:ref="(el) => virtualizer.measureElement(el)",estimateSizeis 60.isConnected: false, offsetHeight: 0, and right afternextTickthe visible items havestart: 0, size: 0.scrollTop ≈ 305.Expected behavior
Rows keep their
estimateSizepositions until they are measured, and the list stays atscrollTop: 0.How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
Not browser-specific, it comes from when Vue calls function refs.
tanstack-virtual version
@tanstack/vue-virtual 3.13.39, @tanstack/virtual-core 3.17.11
TypeScript version
No response
Additional context
Skipping the sync measurement when
!node.isConnectedfixes it. The node is still observed, so the first frame usesestimateSize, the ResizeObserver delivers the real size once the node is attached, and the scroll position stays at 0. I have a fix with a regression test and can open a PR.Terms & Code of Conduct