With `useScrollendEvent`, scrollToIndex and scrollToEnd stop short when the target moves while they settle
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 25/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- react, typescript
- Domaine
- frontend, performance
Piste de recherche
Start with the linked pull request #1376 and the command retirement and reconciliation paths described in the issue. Reproduce the two cases using the linked example's src/main.tsx and the index-shrink button on the command-retire e2e page. Done means both scrollToIndex and scrollToEnd reach their targets with useScrollendEvent: true, including when rows move while the command settles.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Describe the bug
With useScrollendEvent: true, a scrollToIndex or scrollToEnd can stop before its target with no user input. It happens when the target moves while the command is settling. I found two ways:
- In one ResizeObserver batch, a row above the viewport grows (the virtualizer corrects the scroll position for it) and a row in the viewport above the target grows too (no correction). The target moves further than the correction, and the command ends where the correction left the view.
- Rows above the target shrink before the command's write is reported back (#1310). The browser clamps the write at the smaller max, and the command ends there.
With the default useScrollendEvent: false, both land on the target.
Your minimal, reproducible example
Live: https://virtual-scrollend-repro.darkatse.workers.dev
Source: https://github.com/Darkatse/virtual-scrollend-repro
It shows case 1 with the published @tanstack/react-virtual 3.14.26, pinned. All the code is in src/main.tsx, and it depends only on React.
Steps to reproduce
- Open the page and click Run. It calls
scrollToIndex(60, { align: 'center' }). In the frame after its scroll event, row 55 grows to 100px and row 58 to 150px. - Click run with false (
useScrollendEvent: false), then click Run again.
Case 2: the index-shrink button on the command-retire e2e page, with useScrollendEvent: true on its virtualizer, ends at 4000 instead of 3900 in Chromium. WebKit fires no scrollend there.
Expected behavior
Both runs end with row 60 centred on the dashed line (scrollTop 2975).
Actual behavior
With useScrollendEvent: true the run ends at scrollTop 2875, 100px short, and the command has ended. With false it lands on 2975.
How often does this bug happen?
Every time
Platform
- macOS 27.2, Chromium 156.0.8078.4 and WebKit 26.0 (Playwright builds); the same result in both.
- Also seen in a chat app on Android WebView and iOS.
tanstack-virtual version
@tanstack/react-virtual 3.14.26 (@tanstack/virtual-core 3.19.11). Present since virtual-core 3.18.0 (scroll events retire commands, #1294) through main.
TypeScript version
5.9.3
Additional context
Each scroll write is reported a second time when the element comes to rest, and the virtualizer reads that second report as an external scroll, as if the user had scrolled away. With useScrollendEvent it is a scrollend at the same position in the same frame, so it arrives before reconcile has written the moved target. externalRetiresCommand sees the element neither where the command last wrote nor at the fresh target, and ends the command. With the debounced fallback, the second report comes after reconcile.
I have a fix and will open a PR.
- Langage dominant
- TypeScript
- Étoiles
- 7.2k
- Forks
- 495
- Merge moyen
- 23 h 16 min
- PR mergées (30 j)
- 19
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de TanStack/virtual
-
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
Les mainteneurs répondent en général sous 1 jour
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribesPeut-être pris @clean99 l’a pris il y a 13 jours. Ouverte
Difficulté 4/5 1-2 jours Accessibilité débutants 35/100
Les mainteneurs répondent en général sous 1 jour
-
anchorTo: 'end' does not keep the reading position when only paddingStart changesPeut-être pris @duongynhi000001-crypto l’a pris il y a 12 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 30/100
Les mainteneurs répondent en général sous 1 jour
-
anchorTo: 'end' loses the end when the scroll element shrinksPeut-être pris @langleyd l’a pris il y a 41 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
marko-virtual: scrollToEnd during an in-flight prepend strands the view one prepend above the bottom (chat-pretext e2e fails on CI)Peut-être pris @officialasishkumar l’a pris il y a 15 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 55/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de TanStack/virtual
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
hemilabs/ui-monorepo#2711 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
code-yeongyu/senpi#6929 ·
Les mainteneurs répondent en général sous 1 jour
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
lingdojo/kana-dojo#34261 · 1 commentaire · 5 réactions ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
embedpdf/embed-pdf-viewer#1116 ·
Les mainteneurs répondent en général sous 1 jour
-
Revise communication normsOuvertecurrent task
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100
Sunday-School-Software/Sunday-School-Scheduler#87 ·
Les mainteneurs répondent en général sous 1 jour