blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-05-24 15:39:15 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] optimize data structure table (#3854)

Browse Source
This commit is contained in:
neverland 2019-07-15 17:00:41 +08:00 committed by GitHub
parent 5c70473f87
commit d15315b8e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/action-sheet/README.md
View File

@ -117,12 +117,12 @@ export default {
| close | Triggered when close ActionSheet | - | | close | Triggered when close ActionSheet | - |
| closed | Triggered when closed ActionSheet | - | | closed | Triggered when closed ActionSheet | - |
### Data struct of Action ### Data Structure of Action
| key | Description | | Key | Description | Type |
|------|------| |------|------|------|
| name | Title | | name | Title | `string` |
| subname | Subtitle | | subname | Subtitle | `string` |
| className | className for the option | | className | className for the option | `any` |
| loading | Whether to be loading status | | loading | Whether to be loading status | `boolean` |
| disabled | Whether to be disabled | | disabled | Whether to be disabled | `boolean` |

14
src/action-sheet/README.zh-CN.md
View File

@ -128,10 +128,10 @@ export default {
`Props`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`： `Props`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`：
| key | 说明 | | 键名 | 说明 | 类型 |
|------|------| |------|------|------|
| name | 标题 | | name | 标题 | `string` |
| subname | 二级标题 | | subname | 二级标题 | `string` |
| className | 为对应列添加额外的 class | | className | 为对应列添加额外的 class | `any` |
| loading | 是否为加载状态 | | loading | 是否为加载状态 | `boolean` |
| disabled | 是否为禁用状态 | | disabled | 是否为禁用状态 | `boolean` |

4
src/address-list/README.md
View File

@ -86,9 +86,9 @@ export default {
| edit-disabled | Triggered when edit disabled address | item: address object，index | | edit-disabled | Triggered when edit disabled address | item: address object，index |
| select-disabled | Triggered when select disabled address | item: address object，index | | select-disabled | Triggered when select disabled address | item: address object，index |
### Address Data Structure ### Data Structure of Address
| key | Description | Type | | Key | Description | Type |
|------|------|------| |------|------|------|
| id | Id | `string | number` | | id | Id | `string | number` |
| name | Name | `string` | | name | Name | `string` |

2
src/address-list/README.zh-CN.md
View File

@ -89,7 +89,7 @@ export default {
### Address 数据结构 ### Address 数据结构
| key | 说明 | 类型 | | 键名 | 说明 | 类型 |
|------|------|------| |------|------|------|
| id | 每条地址的唯一标识 | `string | number` | | id | 每条地址的唯一标识 | `string | number` |
| name | 收货人姓名 | `string` | | name | 收货人姓名 | `string` |

2
src/contact-card/README.md
View File

@ -180,7 +180,7 @@ export default {
| save | Triggered when click save button | content：contact info | | save | Triggered when click save button | content：contact info |
| delete | Triggered when click delete button | content：contact info | | delete | Triggered when click delete button | content：contact info |
### Contact Data Structure ### Data Structure of Contact
| key | Description | Type | | key | Description | Type |
|------|------|------| |------|------|------|

2
src/contact-card/README.zh-CN.md
View File

@ -186,7 +186,7 @@ export default {
### Contact 数据结构 ### Contact 数据结构
| key | 说明 | 类型 | | 键名 | 说明 | 类型 |
|------|------|------| |------|------|------|
| id | 每位联系人的唯一标识 | `string | number` | | id | 每位联系人的唯一标识 | `string | number` |
| name | 联系人姓名 | `string` | | name | 联系人姓名 | `string` |

4
src/coupon-list/README.md
View File

@ -105,9 +105,9 @@ export default {
| change | Triggered when change chosen coupon | index: index of chosen coupon | | change | Triggered when change chosen coupon | index: index of chosen coupon |
| exchange | Triggered when exchange coupon | code: exchange code | | exchange | Triggered when exchange coupon | code: exchange code |
### Coupon Data Structure ### Data Structure of Coupon
| key | Description | Type | | Key | Description | Type |
|------|------|------| |------|------|------|
| id | Id | `string` | | id | Id | `string` |
| name | Name | `string` | | name | Name | `string` |

2
src/coupon-list/README.zh-CN.md
View File

@ -109,7 +109,7 @@ export default {
### Coupon 数据结构 ### Coupon 数据结构
| key | 说明 | 类型 | | 键名 | 说明 | 类型 |
|------|------|------| |------|------|------|
| id | 优惠券 id | `string` | | id | 优惠券 id | `string` |
| name | 优惠券名称 | `string` | | name | 优惠券名称 | `string` |

12
src/picker/README.md
View File

@ -213,13 +213,13 @@ Picker events will pass different parameters according to the columns are single
|------|------| |------|------|
| title | Custom title | | title | Custom title |
### Column Data Struct ### Data Structure of Column
| key | Description | | Key | Description | Type |
|------|------| |------|------|------|
| values | Value of column | | values | Value of column | `string[]` |
| defaultIndex | Default value index | | defaultIndex | Default value index | `number` |
| className | ClassName for this column | | className | ClassName for this column | `any` |
### Methods ### Methods

10
src/picker/README.zh-CN.md
View File

@ -225,11 +225,11 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数
当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key` 当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`
| key | 说明 | | 键名 | 说明 | 类型 |
|------|------| |------|------|------|
| values | 列中对应的备选值 | | values | 列中对应的备选值 | `string[]`
| defaultIndex | 初始选中项的索引，默认为 0 | | defaultIndex | 初始选中项的索引，默认为 0 | `number` |
| className | 为对应列添加额外的`class` | | className | 为对应列添加额外的类名 | `any` |
### 方法 ### 方法

2
src/tree-select/README.md
View File

@ -62,7 +62,7 @@ export default {
| navclick | triggered when parent node is selected | index: index of selected parent | | navclick | triggered when parent node is selected | index: index of selected parent |
| itemclick | triggered when item is selected | data: selected item | | itemclick | triggered when item is selected | data: selected item |
### Item Data Structure ### Data Structure of Item
`items` should be an array contains specified tree objects. `items` should be an array contains specified tree objects.