react-virtuoso

<img src="https://yellow-cdn.veclightyear.com/2b54e442/5cb7bb50-bf63-47ad-81fe-a84051a4685f.png" width="229" />

React Virtuoso - 最全面的 React 虚拟化渲染列表/表格/网格组件系列。

• 开箱即用的可变大小项目；无需手动测量或硬编码项目高度；
• 聊天消息列表 UI 新功能；
• 带有粘性标题的分组模式；
• 响应式网格布局；
• 表格支持；
• 自动处理内容大小调整；
• 自定义页眉、页脚和空列表组件；
• 置顶项目；
• 无限滚动，按下加载更多；
• 初始顶部项目索引；
• 滚动到索引方法。

有关实例演示和文档，请查看文档网站。

赞助商

如果您在工作中使用 Virtuoso，请赞助它。任何捐赠都对项目的开发和维护有很大帮助。

开始使用

npm install react-virtuoso

import * as React from 'react'
import * as ReactDOM from 'react-dom'
import { Virtuoso } from 'react-virtuoso'

const App = () => {
  return <Virtuoso style={{ height: '400px' }} totalCount={200} itemContent={index => <div>项目 {index}</div>} />
}

ReactDOM.render(<App />, document.getElementById('root'))

消息列表

Virtuoso 消息列表组件专为人类/聊天机器人对话而设计。除了虚拟化渲染外，该组件还提供了一个命令式数据管理 API，让您能够在加载旧消息、新消息到达以及用户提交消息时对滚动位置进行必要的控制。滚动位置可以立即更新或平滑滚动动画。

分组模式

GroupedVirtuoso 组件是"平面" Virtuoso 的变体，有以下不同：

• 不使用 totalCount，该组件提供 groupCounts: number[] 属性，用于指定每个组中的项目数量。 例如，传递 [20, 30] 将渲染两个组，分别包含 20 和 30 个项目；
• 除了 itemContent 属性外，该组件还需要一个额外的 groupContent 属性， 用于渲染组标题。groupContent 回调接收基于零的组索引作为参数。

网格

VirtuosoGrid 组件以多列显示大小相同的项目。 布局和项目大小通过 CSS 类属性控制，这允许您使用媒体查询、最小宽度、百分比等。

表格

TableVirtuoso 组件的工作方式与 Virtuoso 相同，但适用于 HTML 表格。 它支持窗口滚动、粘性标题、粘性列，并与 React Table 和 MUI Table 兼容。

适用于您选择的 UI 库

您可以根据需求自定义标记 - 查看 Material UI 列表演示。 如果您需要支持重新排序，请查看 React Sortable HOC 示例。

文档和演示

有关支持功能的深入文档和实例演示，请查看文档网站。

浏览器支持

为了支持旧版浏览器，您可能需要在使用 react-virtuoso 之前加载 ResizeObserver Polyfill：

import ResizeObserver from 'resize-observer-polyfill'
if (!window.ResizeObserver)
  window.ResizeObserver = ResizeObserver

作者

Petyo Ivanov @petyosi。

贡献

修复和新功能

要运行测试，请使用 npm run test。 可以使用 npm run e2e 运行基于浏览器的端到端测试套件，页面为 e2e/*.tsx，测试为 e2e/*.test.ts。

调试的一个便捷方法是在浏览器中预览测试用例。 为此，请运行 npm run dev - 它将启动一个 Ladle 服务器，让您可以浏览 examples 文件夹中的组件。

许可证

MIT 许可证。