Expose an API to cancel active scroll reconciliation

Aperta

#1,285 aperta il 13/9/2026 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 4/5
Tempo stimato: 3-5 giorni
Idoneità per principianti: 62/100

Tipo di issue: Funzionalità
Chiarezza: Abbastanza chiara
Stato di attività: Attiva
Stack tecnologico: typescript
Ambito: frontend

Direzione di ricerca

Inizia nell’implementazione di @tanstack/virtual-core intorno a reconcileScroll e a scrollState, utilizzato da scrollToIndex e scrollToOffset. Traccia come vengono gestiti il target di riconciliazione attivo e il relativo limite di sicurezza, quindi esamina i test core esistenti, se disponibili. Il lavoro è completato quando una API pubblica cancelScrollTo interrompe il target attivo senza modificare l’offset DOM corrente e preserva la compensazione delle misurazioni successive.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Describe the use case

A virtualizer may have a long-distance scrollToIndex reconciliation in progress while the user begins a genuine wheel, touch, pointer, or keyboard scroll. The application must immediately hand viewport ownership back to the user.

In @tanstack/virtual-core 3.17.8, reconcileScroll can continue correcting toward the old target for up to the five-second safety limit. There is no public way to cancel it. The only effective application workaround is a private-field write:

;(virtualizer as unknown as { scrollState: unknown }).scrollState = null

That works, but is intentionally outside the public contract and can silently break on upgrade.

Requested API

A public method such as:

virtualizer.cancelScrollTo()

It should cancel the active scrollToIndex / scrollToOffset reconciliation target without changing the current DOM offset. This lets a user gesture take ownership immediately while preserving normal subsequent measurement compensation.

Why this belongs in core

Core owns the reconciliation state and its lifecycle.
Consumers cannot reliably infer or cancel every pending internal frame/timer.
User input cancellation is needed by chat timelines and other dynamic, long-distance virtual navigation surfaces.

Version

@tanstack/virtual-core 3.17.8; the same private-only state is present on current main.

Lingua principale: TypeScript
Stelle: 7.1k
Fork: 466
Merge medio: 2g 31m
PR unite (30g): 13

Guida per i contributori

Apri la guida per i contributori

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.
Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
Fai un fork del repository e lavora su un branch.
Apri una pull request che faccia riferimento al numero della issue.