docs: prop virtual

phphe · Feb 7, 2024 · a2cd8d9 · a2cd8d9
1 parent 312df91
commit a2cd8d9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -77,6 +77,7 @@ export default function BaseExample() {
 - `listSize`: `number`, default: 1000. Height of the visible area of the list. Only used before DOM creation, suitable for SSR.
 - `triggerDistance`: `number`. The min distance to trigger re-rendering when scrolling.
 - `onScroll`: `typeof document.onscroll`. Listen for the list's scroll event. Type is same with HTML native onscroll handle.
+- `virtual`: `boolean`. default: `false`. Whether to enable the virtual list feature. Render all items if disabled.
 - `className`: `string`. Add a CSS class to the list root element.
 - `style`: `React.CSSProperties`. Add CSS styles to the list root element.
 

diff --git a/README_CN.md b/README_CN.md
@@ -77,6 +77,7 @@ export default function BaseExample() {
 - `listSize`: `number`, 默认值: 1000. 列表的可见区域高度。仅用于 DOM 创建前使用，适用于 SSR.
 - `triggerDistance`: `number`. 滚动时触发重新渲染的距离。
 - `onScroll`: `typeof document.onscroll`. 监听列表的 scorll 事件。类型与 HTML 原生 onscroll 监听器相同。
+- `virtual`: `boolean`. 默认`false`. 是否启用虚拟列表。不启用则会渲染全部列表项。
 - `className`: `string`. 附加 css class 到根元素。
 - `style`: `React.CSSProperties`. 附加 css style 到根元素。