Document the indexAttribute option and cover it with a test
Maintainer antworten meist innerhalb von 1 Tag
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
- Bereich
- documentation, testing
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
- Open
docs/api/virtualizer.md. - Look for
indexAttributeamong 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
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TanStack/virtual
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
Maintainer antworten meist innerhalb von 1 Tag
-
With `useScrollendEvent`, scrollToIndex and scrollToEnd stop short when the target moves while they settleEvtl. vergeben @Darkatse hat das vor 11 Tagen übernommen. Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
Maintainer antworten meist innerhalb von 1 Tag
-
svelte-virtual renders no rows when the scroll element is bound after the store subscribesEvtl. vergeben @clean99 hat das vor 15 Tagen übernommen. Offen
Schwierigkeit 4/5 1-2 Tage Anfängerfreundlichkeit 35/100
Maintainer antworten meist innerhalb von 1 Tag
-
anchorTo: 'end' does not keep the reading position when only paddingStart changesEvtl. vergeben @duongynhi000001-crypto hat das vor 15 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 30/100
Maintainer antworten meist innerhalb von 1 Tag
-
anchorTo: 'end' loses the end when the scroll element shrinksEvtl. vergeben @langleyd hat das vor 44 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in TanStack/virtual
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
fb55/htmlparser2#2579 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug good first issue needs-review
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 83/100
Maintainer antworten meist innerhalb von 1 Tag
-
Add Module DB RulesOffendocumentation public
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 68/100
midnightntwrk/umbradb#65 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
area/channels kind/bug priority/medium
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
nanocoai/nanoclaw#4501 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
needs verification
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 13 Tagen