Document the indexAttribute option and cover it with a test

Ouverte Adaptée aux débutants
#1,386 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@officialasishkumar y travaille déjà.

Depuis le 20/11/2026.

  • #1387 par @officialasishkumar — ouverte

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
78/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript

Piste de recherche

Commence par docs/api/virtualizer.md et l’entrée indexAttribute existante dans docs/framework/marko/marko-virtual.md, puis examine packages/virtual-core/tests pour repérer les modèles de test du virtualiseur principal. Documente la valeur par défaut, son utilisation par measureElement et l’observateur de redimensionnement, ainsi que le cas de grille avec des éléments partagés ; ajoute un test avec des virtualiseurs de lignes et de colonnes utilisant des attributs distincts. Le travail est terminé lorsque la documentation et le test couvrent le comportement demandé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
7.2k
Forks
495
Merge moyen
15 h 11 min
PR mergées (30 j)
17

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TanStack/virtual

Toutes les issues de TanStack/virtual

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.