@tanstack/virtual-core

What is @tanstack/virtual-core?

The @tanstack/virtual-core package is a headless utility for creating virtualized lists, grids, or any other scrolling content. It provides the core logic needed to implement virtualization in web applications, helping to improve performance by only rendering items that are currently visible in the viewport. This package is framework-agnostic, meaning it can be used with any web framework or no framework at all.

What are @tanstack/virtual-core's main functionalities?

List Virtualization

This feature allows for the virtualization of a simple list. By providing the total count of items, a function to get the scrolling element, an estimated size for each item, and an overscan value, the Virtualizer instance can manage which items should be rendered based on the scroll position.

{"import { Virtualizer } from '@tanstack/virtual-core';\n\nconst virtualizer = new Virtualizer({\n  count: 1000, // Total number of items\n  getScrollElement: () => document.getElementById('scroll-container'), // Element to track scroll\n  estimateSize: () => 35, // Estimated size of each item\n  overscan: 5, // Number of items to render outside of the viewport\n});\n\nvirtualizer.listen((state) => {\n  // Render logic based on the current state\n});"}

Grid Virtualization

This feature supports the virtualization of grid layouts. It extends the list virtualization by adding support for both horizontal and vertical scrolling, making it suitable for large grid layouts where items are arranged in rows and columns.

{"import { Virtualizer } from '@tanstack/virtual-core';\n\nconst virtualizer = new Virtualizer({\n  count: 10000, // Total number of items in the grid\n  getScrollElement: () => document.getElementById('grid-container'),\n  estimateSize: () => ({ width: 100, height: 100 }), // Estimated size of each grid item\n  overscan: 5,\n  direction: 'both' // Indicates both horizontal and vertical scrolling\n});\n\nvirtualizer.listen((state) => {\n  // Render logic for grid items based on the current state\n});"}

Other packages similar to @tanstack/virtual-core

react-window

React-window is a popular React-specific library for virtualizing long lists and grids. It provides components like FixedSizeList and VariableSizeList for lists, and FixedSizeGrid and VariableSizeGrid for grids. Compared to @tanstack/virtual-core, react-window is more out-of-the-box for React applications but less flexible for non-React or custom implementations.

react-virtualized

React-virtualized is another React-focused library offering a wide range of components for virtualization, including lists, tables, grids, and more. It offers more features and flexibility than react-window but at the cost of a larger bundle size. Unlike @tanstack/virtual-core, react-virtualized is not framework-agnostic and is designed specifically for React applications.

README

The README file is missing