Skip to content

Commit d8b975d

Browse files
xingyan95kagol
authored andcommitted
fix(VirtualList): 完善文档,补充item-height参数说明
1 parent c44f130 commit d8b975d

File tree

1 file changed

+16
-22
lines changed
  • packages/devui-vue/docs/components/virtual-list

1 file changed

+16
-22
lines changed

packages/devui-vue/docs/components/virtual-list/index.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<d-button @click="onScrollTo" size="sm" style="margin-right: 6px;">scorll to</d-button>
1717
<d-input-number v-model="num" placeholder="请输入" :min="0" :max="data.length - 1" size="sm" />
1818
</div>
19-
<d-virtual-list :data="data" ref="vlRef" >
19+
<d-virtual-list :data="data" ref="vlRef">
2020
<template #item="{ value }">
2121
<div>children{{ value }}</div>
2222
</template>
@@ -28,11 +28,7 @@ import { ref } from 'vue';
2828
2929
export default {
3030
setup() {
31-
const data = ref(
32-
Array
33-
.from({ length: 5000 })
34-
.map((_, index) => ({ value: index }))
35-
);
31+
const data = ref(Array.from({ length: 5000 }).map((_, index) => ({ value: index })));
3632
const num = ref(0);
3733
const vlRef = ref(null);
3834
const onScrollTo = () => {
@@ -42,37 +38,35 @@ export default {
4238
},
4339
};
4440
</script>
45-
46-
<style>
47-
</style>
4841
```
4942

5043
:::
5144

5245
### VirtualList 参数
5346

54-
| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
55-
| ---- | ---- | ---- | ---- | --------- |
56-
| data | `Array<Object>` | | 数据数组 | [基本用法](#基本用法) |
57-
| component | `string` | `div` | 定义滚动标签 | [基本用法](#基本用法) |
58-
| height | `number` | `100` | 滚动区域高度 | [基本用法](#基本用法) |
59-
| virtual | `boolean` | `true` | 是否禁用滚动 | [基本用法](#基本用法) |
47+
| 参数 | 类型 | 默认 | 说明 | 跳转 Demo |
48+
| :---------- | :-------------- | :----- | :--------------- | :-------------------- |
49+
| data | `Array<Object>` | | 数据数组 | [基本用法](#基本用法) |
50+
| component | `string` | `div` | 定义滚动标签 | [基本用法](#基本用法) |
51+
| height | `number` | `100` | 滚动区域高度 | [基本用法](#基本用法) |
52+
| virtual | `boolean` | `true` | 是否启用虚拟滚动 | [基本用法](#基本用法) |
53+
| item-height | `number` | 0 | 单个列表项的高度 | |
6054

6155
### VirtualList 方法
6256

6357
| 方法名 | 说明 | 参数 |
64-
| -------- | ---------------- | ------------------------- |
58+
| :------- | :--------------- | :------------------------ |
6559
| scrollTo | 滚动到指定的项目 | index: 需要滚动到项目索引 |
6660

6761
### VirtualList 事件
6862

69-
| 事件 | 类型 | 说明 | 跳转 Demo |
70-
| ----------- | ------------------------------------------------------------ | ---------------------- | --------------------- |
71-
| scroll | `(e: Event) => void` | 滚动事件 | [基本用法](#基本用法) |
63+
| 事件 | 类型 | 说明 | 跳转 Demo |
64+
| :---------- | :------------------------------------------------------------ | :--------------------- | :-------------------- |
65+
| scroll | `(e: Event) => void` | 滚动事件 | [基本用法](#基本用法) |
7266
| show-change | `(renderList: Array<Object>, allList: Array<Object>) => void` | 当前虚拟滚动渲染的数据 | [基本用法](#基本用法) |
7367

7468
### VirtualList 插槽
7569

76-
| 名称 | 默认 | 说明 | 跳转 Demo |
77-
| -------------- | ---- | ------------------------------------------------------------ | ----------------------------- |
78-
| item | -- | 自定义默认内容 | [基本用法](#基本用法) |
70+
| 名称 | 默认 | 说明 | 跳转 Demo |
71+
| :--- | :--- | :------------- | :-------------------- |
72+
| item | -- | 自定义默认内容 | [基本用法](#基本用法) |

0 commit comments

Comments
 (0)