anchorTo: 'end' does not keep the reading position when only paddingStart changes
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 30/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- frontend
调研方向
The issue points to packages/virtual-core/src/index and provides a reproduction to save as packages/virtual-core/tests/padding-anchor.test.ts. Read the existing prepend anchor path and run the reproduction in packages/virtual-core; verify that both padding changes preserve the item’s viewport position and the provided control still passes. An open linked pull request (#1370) already addresses this issue.
由索引模型根据 Issue 内容生成。
描述
Describe the bug
With anchorTo: 'end', a prepend keeps the item at the scroll offset in place. A change of paddingStart with the same count and keys does not: setOptions captures an anchor only when the count or the first/last keys change, so every item moves by the padding delta and nothing compensates. (scrollMargin behaves the same way.)
This matters when content above the items lives in the padding, for example a chat's "Load earlier messages" header whose height changes with its state (loading, an error with a Retry button that wraps, translated text). Keeping that header out of the items is what makes a prepend anchor on the first message rather than on the header, so the padding is the natural place for it. Today the header's own height changes then move the reader's messages.
Your minimal, reproducible example
Dropping this in packages/virtual-core/tests/ reproduces it on main (11b48e4). The control passes; the other two fail with scrollToFn called 0 times.
import { expect, test, vi } from 'vitest'
import { Virtualizer } from '../src/index'
// 20 items of 100px, a 300px viewport, anchorTo: 'end'. Content above the
// items (a "Load earlier messages" header) lives in paddingStart.
function create(paddingStart: number, offset: number) {
let keys = Array.from({ length: 20 }, (_, i) => `m${i}`)
let padding = paddingStart
const scrollToFn = vi.fn()
const scrollElement = {
scrollTop: offset,
scrollLeft: 0,
scrollHeight: padding + keys.length * 100,
scrollWidth: 1000,
clientHeight: 300,
clientWidth: 400,
offsetHeight: 300,
ownerDocument: {
defaultView: {
requestAnimationFrame: () => 1,
cancelAnimationFrame: vi.fn(),
performance: { now: () => Date.now() },
ResizeObserver: vi.fn(function () {
return { observe: vi.fn(), unobserve: vi.fn(), disconnect: vi.fn() }
}),
},
},
} as unknown as HTMLDivElement
const options = () => {
const snapshot = keys
return {
count: snapshot.length,
estimateSize: () => 100,
getItemKey: (index: number) => snapshot[index]!,
getScrollElement: () => scrollElement,
scrollToFn,
observeElementRect: (_: any, cb: (rect: { width: number; height: number }) => void) => {
cb({ width: 400, height: 300 })
return () => {}
},
observeElementOffset: (_: any, cb: (offset: number, isScrolling: boolean) => void) => {
cb(scrollElement.scrollTop, false)
return () => {}
},
anchorTo: 'end' as const,
paddingStart: padding,
}
}
const virtualizer = new Virtualizer(options())
virtualizer._willUpdate()
virtualizer['getMeasurements']()
scrollToFn.mockClear()
const update = () => {
virtualizer.setOptions(options())
;(scrollElement as any).scrollHeight = padding + keys.length * 100
virtualizer._willUpdate()
}
return {
scrollToFn,
prepend(count: number) {
keys = [...Array.from({ length: count }, (_, i) => `p${i}`), ...keys]
update()
},
setPaddingStart(next: number) {
padding = next
update()
},
}
}
test('control: a prepend keeps the item at the offset (m2 starts at 240, offset 250)', () => {
const { prepend, scrollToFn } = create(40, 250)
prepend(8)
expect(scrollToFn).toHaveBeenCalledTimes(1)
expect(scrollToFn.mock.calls[0]![0]).toBe(1050)
})
test('a paddingStart-only change keeps the item at the offset', () => {
const { setPaddingStart, scrollToFn } = create(40, 250)
setPaddingStart(80)
// m2 moved from 240 to 280; keeping it in place needs offset 290.
expect(scrollToFn).toHaveBeenCalledTimes(1)
expect(scrollToFn.mock.calls[0]![0]).toBe(290)
})
test('a reader inside the padding keeps the first item when the padding grows', () => {
const { setPaddingStart, scrollToFn } = create(40, 33)
setPaddingStart(80)
// m0 was at viewport y 7 (40 - 33); it stays there at offset 73.
expect(scrollToFn).toHaveBeenCalledTimes(1)
expect(scrollToFn.mock.calls[0]![0]).toBe(73)
})
Steps to reproduce
- Save the file above as
packages/virtual-core/tests/padding-anchor.test.ts. pnpm exec vitest run tests/padding-anchor.test.tsinpackages/virtual-core.- The control test passes; the two
paddingStarttests fail (no scroll write).
Expected behavior
When anchorTo is 'end' and paddingStart changes, the item at the scroll offset keeps its viewport position, through the same anchor path a prepend uses (pending anchor, the hold during gestures, the clamped-write retry), also when the change arrives in its own update after a data change. A reader inside the padding (offset < paddingStart) anchors on the first item with a negative offset, as a prepend already does. A target outside the scroll range clamps once.
How often does this bug happen?
Every time
Platform
Any (core logic; reproduced in Node 24 with vitest).
tanstack-virtual version
@tanstack/virtual-core 3.19.11 (also 3.19.7)
Additional context
Related: #1339 (scrollMargin in the end-distance check, fixed in 3.19.8). We would be glad to open a PR if the expected behavior above is what you want.
- 主要语言
- TypeScript
- 星标
- 7.2k
- 派生
- 490
- 平均合并
- 15 小时 28 分钟
- 30 天内合并 PR
- 48
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
TanStack/virtual 的其他 Issue
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribes可能已有人在做 @clean99 于 3 天前认领。 未关闭
难度 4/5 1-2 天 新手友好度 35/100
维护者通常 1 天内回复
-
anchorTo: 'end' loses the end when the scroll element shrinks可能已有人在做 @langleyd 于 32 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
-
marko-virtual: scrollToEnd during an in-flight prepend strands the view one prepend above the bottom (chat-pretext e2e fails on CI)可能已有人在做 @officialasishkumar 于 6 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 55/100
维护者通常 1 天内回复
-
Scroll correction sometimes gets stuck on estimating row sizes可能已有人在做 @itisrmk 于 1 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 42/100
TanStack/virtual#1252 · 2 条评论 ·
维护者通常 1 天内回复
-
eslint-plugin-react-hooks v7 warning for useVirtualizer: Compilation Skipped: Use of incompatible library可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 4/5 3-5 天 新手友好度 45/100
TanStack/virtual#1119 · 11 条评论 · 32 个 reaction ·
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
backnotprop/plannotator#2914 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
microsoft/vscode-containers#655 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
dsh-tauri-desk/deepseek-harness-desktop#1477 · 1 条评论 ·