docs(list): update api (#563)

* docs(icon): 更新图标组件的说明文档

* docs(pageHeader): 更新页头组件的说明文档

* docs(pageHeader): 更新页头组件的文档中的错别字

* docs(typography): 更新排印组件的说明文档

* Update src/typography/demos/zhCN/index.demo-entry.md

* docs(mention): 更新提及组件的说明文档

* docs(mention): 更新提及组件的一部分参数说明

* docs(radio): 更新单选组件的说明文档

* docs(timePicker): 更新时间选择组件的一部分参数说明

* docs(timePicker): 更正时间选择组件的参数文案

* docs(timePicker): 更正时间选择组件的英文参数文案

* docs(transfer): 更新穿梭框组件的说明文档

* docs(radio): 更新单选组件的一部分说明文档

* Apply suggestions from code review

* docs(list): 更正列表组件的说明文档

* Update src/transfer/demos/zhCN/index.demo-entry.md

Co-authored-by: 07akioni <07akioni2@gmail.com>
This commit is contained in:
songjianet 2021-07-22 00:23:31 +08:00 committed by GitHub
parent e5e2d3929e
commit 3604da7e75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 27 deletions

View File

@ -15,24 +15,24 @@ border
### List Props
| Name | Type | Default | Description |
| -------- | --------- | ------- | ----------- |
| bordered | `boolean` | `false` | |
| Name | Type | Default | Description |
| -------- | --------- | ------- | --------------------------- |
| bordered | `boolean` | `false` | Whether to show the border. |
## Slots
### List Slots
| Name | Parameters | Description |
| ------- | ---------- | ----------- |
| default | `()` | |
| footer | `()` | |
| header | `()` | |
| Name | Parameters | Description |
| ------- | ---------- | ------------------------------------- |
| default | `()` | The contents of the list. |
| footer | `()` | Content at the bottom of the list. |
| header | `()` | The contents of the head of the list. |
### List Item Slots
| Name | Parameters | Description |
| ------- | ---------- | ----------- |
| default | `()` | |
| prefix | `()` | |
| suffix | `()` | |
| Name | Parameters | Description |
| ------- | ---------- | ----------------------------------- |
| default | `()` | The contents of the list item. |
| prefix | `()` | The first content of the list item. |
| suffix | `()` | The end of the list item. |

View File

@ -15,24 +15,24 @@ border
### List Props
| 名称 | 类型 | 默认值 | 说明 |
| -------- | --------- | ------- | ---- |
| bordered | `boolean` | `false` | |
| 名称 | 类型 | 默认值 | 说明 |
| -------- | --------- | ------- | ------------ |
| bordered | `boolean` | `false` | 是否显示边框 |
## Slots
### List Slots
| 名称 | 参数 | 说明 |
| ------- | ---- | ---- |
| default | `()` | |
| footer | `()` | |
| header | `()` | |
| 名称 | 参数 | 说明 |
| ------- | ---- | -------------- |
| default | `()` | 列表的内容 |
| footer | `()` | 列表底部的内容 |
| header | `()` | 列表头部的内容 |
### List Item Slots
| 名称 | 参数 | 说明 |
| ------- | ---- | ---- |
| default | `()` | |
| prefix | `()` | |
| suffix | `()` | |
| 名称 | 参数 | 说明 |
| ------- | ---- | ---------------- |
| default | `()` | 列表项的内容 |
| prefix | `()` | 列表项的首部内容 |
| suffix | `()` | 列表项的尾部内容 |

View File

@ -20,7 +20,7 @@ filterable
| default-value | `Array<string \| number> \| null` | `null` | 非受控模式下的默认值 |
| disabled | `boolean` | `true` | 是否禁用 |
| filterable | `boolean` | `false` | 是否可过滤 |
| filter | `function` | `(pattern: string, option: TransferOption, from: 'source' \| 'target') => boolean` | 一个简单的标签字符串匹配函数 |
| filter | `(pattern: string, option: TransferOption, from: 'source' \| 'target') => boolean` | 一个简单的标签字符串匹配函数 | 搜索时使用的过滤函数 |
| options | `Array<TransferOption>` | `[]` | 配置选项内容,详情见 TransferOption Type |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 尺寸 |
| source-filter-placeholder | `string` | `undefined` | 源项搜索框中的占位符 |