Document the indexAttribute option and cover it with a test

Aperta Adatta ai principianti
#1,386 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@officialasishkumar ci sta già lavorando.

Dal 20/11/2026.

  • #1387 di @officialasishkumar — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript

Direzione di ricerca

Inizia da docs/api/virtualizer.md e dalla voce indexAttribute esistente in docs/framework/marko/marko-virtual.md, poi esamina packages/virtual-core/tests per individuare i modelli di test del virtualizzatore principale. Documenta il valore predefinito, il suo utilizzo da parte di measureElement e dell’observer di ridimensionamento, nonché il caso di griglia con elementi condivisi; aggiungi un test con virtualizzatori di righe e colonne che usano attributi distinti. Il lavoro è completo quando la documentazione e il test coprono il comportamento richiesto.

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

Descrizione

Describe the bug

The indexAttribute option of Virtualizer (default 'data-index') is public API in VirtualizerOptions and is documented only for the Marko adapter. It is missing from docs/api/virtualizer.md, so nothing on the core options page explains how to measure the same element with two virtualizers (for example a row and a column virtualizer in a grid). Without it, both virtualizers read the same data-index attribute and the second one measures the wrong index.

There is also no test in packages/virtual-core/tests that exercises a custom indexAttribute, so the behavior could regress unnoticed.

Your minimal, reproducible example

Search the docs for indexAttribute: it only appears in docs/framework/marko/marko-virtual.md.

Steps to reproduce
  1. Open docs/api/virtualizer.md.
  2. Look for indexAttribute among the options.
Expected behavior

The option is documented with its default, how it is used by measureElement and the resize observer, and the two-virtualizer grid use case. A core test covers a row and a column virtualizer measuring one shared element through distinct attributes.

How often does this bug happen?

Every time

Platform

Any

tanstack-virtual version

@tanstack/virtual-core 3.19.11 (main)

Additional context

Docs and test only; no published code changes.

Lingua principale
TypeScript
Stelle
7.2k
Fork
495
Merge medio
15h 11m
PR unite (30g)
17

Preparare l'ambiente

Come iniziare

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

Altre issue di TanStack/virtual

Tutte le issue di TanStack/virtual

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.