Document the indexAttribute option and cover it with a test

Offen Anfängerfreundlich
#1,386 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@officialasishkumar arbeitet bereits daran.

Seit 20.11.2026.

  • #1387 von @officialasishkumar — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript

Rechercherichtung

Beginne mit docs/api/virtualizer.md und dem vorhandenen Eintrag indexAttribute in docs/framework/marko/marko-virtual.md und untersuche anschließend packages/virtual-core/tests auf die Testmuster des Core-Virtualizers. Dokumentiere den Standardwert, seine Verwendung durch measureElement und den Resize Observer sowie den Grid-Fall mit gemeinsam genutzten Elementen; füge einen Test mit Zeilen- und Spalten-Virtualizern hinzu, die unterschiedliche Attribute verwenden. Fertig ist es, wenn die Dokumentation und der Test das angeforderte Verhalten abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
7.2k
Forks
495
Ø Merge
15 Std. 11 Min.
Gemergte PRs (30 T.)
17

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TanStack/virtual

Alle Issues in TanStack/virtual

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.