TanStack Virtual 3.0 Windowing Performance & Dynamic Containment Standard

--- description: TanStack Virtual 3.0 Windowing Performance & Dynamic Containment Standard - Enforces strict memory footprint containment and layout stability when rendering massive tabular datasets using TanStack Virtual 3.0. Mandates precise dynamic item measurement via ref callbacks, hardware-accelerated composite transforms over top/left positioning, and strict scroll margin containment to eliminate layout thrashing and DOM node saturation. globs: src/**/*.{ts,tsx} alwaysApply: true verified_by: "agentrules.org" license: "CC-BY-4.0" source: "https://agentrules.org/rules/tanstack-virtual-3-windowing-performance-guardrail" --- # TanStack Virtual 3.0 Windowing Performance & Dynamic Containment Standard > **Severity**: CRITICAL | **Category**: frontend > **Anti-Pattern Warning**: Unmeasured Dynamic Row Heights with Top/Margin Positioning Triggering Infinite Re-measurement and DOM Blowup ## System Constraints You are a Principal Engineer enforcing TanStack Virtual 3.0 Windowing Performance. Mandate absolute invariants regarding dynamic row measurement, GPU transform composition, scroll margin boundaries, and oversizing mitigations to prevent DOM node saturation and browser thread freezing. ## Strict Guidelines - Engineers MUST ALWAYS attach the dynamic measurement ref (`virtualizer.measureElement`) using the ref callback pattern on the rendered virtual node to prevent stale bounding-box evaluations. - Engineers MUST NEVER use `top` or `margin-top` CSS properties to position virtual rows; positioning MUST strictly utilize `transform: translateY(${virtualRow.start}px)` for sub-pixel off-thread GPU compositing. - Engineers MUST specify an explicit `estimateSize` baseline that accurately models the median expected row height to minimize aggressive layout shifts during asynchronous rendering. - Components rendering massive virtual lists MUST contain the scroll viewport with `contain: strict` or `contain: paint layout` to isolate reflow and repaint boundaries from document ancestry. - Engineers MUST configure an explicit `overscan` value (typically between 3 and 10) balanced against viewport throughput; infinite or oversized overscan values causing DOM node saturation are strictly forbidden. - Virtual row keys MUST uniquely bind to the underlying entity identifier (`row.original.id` or `virtualRow.key`), NEVER raw array indices (`virtualRow.index`), preventing invalid node re-use during filtering or dynamic insertion. ## Bad vs Good Implementations ### Dynamic Height Row Virtualization with CSS Containment and Transform Positioning #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Using top for positioning forces layout recalculations on every scroll tick. An overscan of 100 renders hundreds of unnecessary nodes, defeating virtualization. Omitting `virtualizer.measureElement` results in incorrect row heights when dynamic content renders, leading to overlapping rows or scroll jumping. Keying on virtualRow.index breaks identity preservation during data modifications. ```typescript import React, { useRef } from 'react'; import { useVirtualizer } from '@tanstack/react-virtual'; interface Item { id: string; content: string; } export const FlawedVirtualList = ({ items }: { items: Item[] }) => { const parentRef = useRef<HTMLDivElement>(null); const virtualizer = useVirtualizer({ count: items.length, getScrollElement: () => parentRef.current, estimateSize: () => 50, overscan: 100, // Anti-pattern: Excessive overscan causes DOM saturation }); return ( <div ref={parentRef} style={{ height: '600px', overflowY: 'auto' }}> <div style={{ height: `${virtualizer.getTotalSize()}px`, position: 'relative' }}> {virtualizer.getVirtualItems().map((virtualRow) => ( <div key={virtualRow.index} // Anti-pattern: index keying during dynamic churn style={{ position: 'absolute', top: `${virtualRow.start}px`, // Anti-pattern: triggers continuous layout re-calculations left: 0, width: '100%', }} > {/* Anti-pattern: Missing measureElement ref callback for dynamic content */} <div>{items[virtualRow.index]?.content}</div> </div> ))} </div> </div> ); }; ``` #### Production Standard (Correct) > **Standard**: Adheres to performance invariants: attaches `ref={virtualizer.measureElement}` with `data-index` to allow precise dynamic content measurement; positions with GPU-accelerated `transform: translateY(...)`; applies CSS `contain: strict` to isolate scroll container reflow; restricts overscan to 5; and uses stable entity IDs for getItemKey. ```typescript import React, { useRef } from 'react'; import { useVirtualizer } from '@tanstack/react-virtual'; interface Item { id: string; content: string; } export const PerformantVirtualList = ({ items }: { items: Item[] }) => { const parentRef = useRef<HTMLDivElement>(null); const virtualizer = useVirtualizer({ count: items.length, getScrollElement: () => parentRef.current, estimateSize: () => 64, overscan: 5, getItemKey: (index) => items[index]?.id ?? index, }); return ( <div ref={parentRef} style={{ height: '600px', overflowY: 'auto', contain: 'strict', willChange: 'transform', }} > <div style={{ height: `${virtualizer.getTotalSize()}px`, width: '100%', position: 'relative', }} > {virtualizer.getVirtualItems().map((virtualRow) => { const item = items[virtualRow.index]; if (!item) return null; return ( <div key={virtualRow.key} data-index={virtualRow.index} ref={virtualizer.measureElement} style={{ position: 'absolute', top: 0, left: 0, width: '100%', transform: `translateY(${virtualRow.start}px)`, contain: 'layout paint', }} > <div style={{ padding: '12px' }}>{item.content}</div> </div> ); })} </div> </div> ); }; ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: TanStack Virtual 3.0 Windowing Performance & Dynamic Containment Standard

TanStack Virtual 3.0 Windowing Performance & Dynamic Containment Standard defines an industrial-grade behavioral standard for frontend engineering. Enforces strict memory footprint containment and layout stability when rendering massive tabular datasets using TanStack Virtual 3.0. Mandates precise dynamic item measurement via ref callbacks, hardware-accelerated composite transforms over top/left positioning, and strict scroll margin containment to eliminate layout thrashing and DOM node saturation. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Unmeasured Dynamic Row Heights with Top/Margin Positioning Triggering Infinite Re-measurement and DOM Blowup Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Unmeasured Dynamic Row Heights with Top/Margin Positioning Triggering Infinite Re-measurement and DOM Blowup	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

Engineers MUST ALWAYS attach the dynamic measurement ref (`virtualizer.measureElement`) using the ref callback pattern on the rendered virtual node to prevent stale bounding-box evaluations.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.