Skip to content

Commit c69a508

Browse files
committed
docs: use ut install for local setup
1 parent b975ea1 commit c69a508

3 files changed

Lines changed: 17 additions & 19 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515

1616
<p align="center">English | <a href="./README.zh-CN.md">简体中文</a></p>
1717

18-
1918
## Highlights
2019

2120
- Built for React and maintained by the rc-component team.
@@ -51,7 +50,7 @@ export default () => (
5150
Run the local dumi site:
5251

5352
```bash
54-
npm install
53+
ut install
5554
npm start
5655
```
5756

@@ -78,7 +77,7 @@ Then open `http://localhost:8000`.
7877
## Development
7978

8079
```bash
81-
npm install
80+
ut install
8281
npm start
8382
npm test
8483
npm run build

README.zh-CN.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515

1616
<p align="center"><a href="./README.md">English</a> | 简体中文</p>
1717

18-
1918
## 特性
2019

2120
- 面向 React 构建,并由 rc-component 团队维护。
@@ -51,7 +50,7 @@ export default () => (
5150
运行本地 dumi 站点:
5251

5352
```bash
54-
npm install
53+
ut install
5554
npm start
5655
```
5756

@@ -61,24 +60,24 @@ npm start
6160

6261
### List
6362

64-
| 属性 | 说明 | 类型 | 默认值 |
65-
| ---------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------- |
63+
| 属性 | 说明 | 类型 | 默认值 |
64+
| ---------- | ------------------------------------------------------------------ | -------------------------------------- | ------- |
6665
| children | 每一项的渲染函数。第三个参数包含旧浏览器兼容路径使用的测量 props。 | `(item, index, props) => ReactElement` | - |
67-
| component | 自定义列表容器元素。 | `string` \| `ComponentType` | `div` |
68-
| data | 虚拟列表渲染的数据项。 | `T[]` | - |
69-
| disabled | 禁用滚动位置检查,通常用于配合动画。 | `boolean` | `false` |
70-
| fullHeight | holder 是否保持完整高度。 | `boolean` | `true` |
71-
| height | 可视列表高度。 | `number` | - |
72-
| itemHeight | 用于计算虚拟范围的最小项高度。 | `number` | - |
73-
| itemKey | 数据项 key 字段或 key 获取函数。 | `string` \| `(item) => React.Key` | - |
74-
| onScroll | 列表滚动时调用。 | `React.UIEventHandler<HTMLElement>` | - |
75-
| styles | 自定义滚动条部位样式。 | `object` | - |
76-
| virtual | 启用虚拟渲染。 | `boolean` | `true` |
66+
| component | 自定义列表容器元素。 | `string` \| `ComponentType` | `div` |
67+
| data | 虚拟列表渲染的数据项。 | `T[]` | - |
68+
| disabled | 禁用滚动位置检查,通常用于配合动画。 | `boolean` | `false` |
69+
| fullHeight | holder 是否保持完整高度。 | `boolean` | `true` |
70+
| height | 可视列表高度。 | `number` | - |
71+
| itemHeight | 用于计算虚拟范围的最小项高度。 | `number` | - |
72+
| itemKey | 数据项 key 字段或 key 获取函数。 | `string` \| `(item) => React.Key` | - |
73+
| onScroll | 列表滚动时调用。 | `React.UIEventHandler<HTMLElement>` | - |
74+
| styles | 自定义滚动条部位样式。 | `object` | - |
75+
| virtual | 启用虚拟渲染。 | `boolean` | `true` |
7776

7877
## 本地开发
7978

8079
```bash
81-
npm install
80+
ut install
8281
npm start
8382
npm test
8483
npm run build

vercel.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"framework": "umijs",
3-
"installCommand": "npm install",
3+
"installCommand": "ut install",
44
"buildCommand": "npm run build",
55
"outputDirectory": "docs-dist"
66
}

0 commit comments

Comments
 (0)