From d15315b8e4ed8d970306568edf2055891c902d61 Mon Sep 17 00:00:00 2001 From: neverland Date: Mon, 15 Jul 2019 17:00:41 +0800 Subject: [PATCH] [Doc] optimize data structure table (#3854) --- src/action-sheet/README.md | 16 ++++++++-------- src/action-sheet/README.zh-CN.md | 14 +++++++------- src/address-list/README.md | 4 ++-- src/address-list/README.zh-CN.md | 2 +- src/contact-card/README.md | 2 +- src/contact-card/README.zh-CN.md | 2 +- src/coupon-list/README.md | 4 ++-- src/coupon-list/README.zh-CN.md | 2 +- src/picker/README.md | 12 ++++++------ src/picker/README.zh-CN.md | 10 +++++----- src/tree-select/README.md | 2 +- 11 files changed, 35 insertions(+), 35 deletions(-) diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 6531e66cd..a46d05f4c 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -117,12 +117,12 @@ export default { | close | Triggered when close ActionSheet | - | | closed | Triggered when closed ActionSheet | - | -### Data struct of Action +### Data Structure of Action -| key | Description | -|------|------| -| name | Title | -| subname | Subtitle | -| className | className for the option | -| loading | Whether to be loading status | -| disabled | Whether to be disabled | +| Key | Description | Type | +|------|------|------| +| name | Title | `string` | +| subname | Subtitle | `string` | +| className | className for the option | `any` | +| loading | Whether to be loading status | `boolean` | +| disabled | Whether to be disabled | `boolean` | diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 23711f655..c2feb946d 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -128,10 +128,10 @@ export default { `Props`中的`actions`为一个对象数组,数组中的每一个对象配置每一列,每一列有以下`key`: -| key | 说明 | -|------|------| -| name | 标题 | -| subname | 二级标题 | -| className | 为对应列添加额外的 class | -| loading | 是否为加载状态 | -| disabled | 是否为禁用状态 | +| 键名 | 说明 | 类型 | +|------|------|------| +| name | 标题 | `string` | +| subname | 二级标题 | `string` | +| className | 为对应列添加额外的 class | `any` | +| loading | 是否为加载状态 | `boolean` | +| disabled | 是否为禁用状态 | `boolean` | diff --git a/src/address-list/README.md b/src/address-list/README.md index 97e88c6fb..fb5a2a810 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -86,9 +86,9 @@ export default { | edit-disabled | Triggered when edit 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` | | name | Name | `string` | diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index 906269bda..11b8129a7 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -89,7 +89,7 @@ export default { ### Address 数据结构 -| key | 说明 | 类型 | +| 键名 | 说明 | 类型 | |------|------|------| | id | 每条地址的唯一标识 | `string | number` | | name | 收货人姓名 | `string` | diff --git a/src/contact-card/README.md b/src/contact-card/README.md index b69fb1728..4d2e91bbb 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -180,7 +180,7 @@ export default { | save | Triggered when click save button | content:contact info | | delete | Triggered when click delete button | content:contact info | -### Contact Data Structure +### Data Structure of Contact | key | Description | Type | |------|------|------| diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index 80bd4f912..ffaaaf386 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -186,7 +186,7 @@ export default { ### Contact 数据结构 -| key | 说明 | 类型 | +| 键名 | 说明 | 类型 | |------|------|------| | id | 每位联系人的唯一标识 | `string | number` | | name | 联系人姓名 | `string` | diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index e1207a85d..3ab2db0d4 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -105,9 +105,9 @@ export default { | change | Triggered when change chosen coupon | index: index of chosen coupon | | exchange | Triggered when exchange coupon | code: exchange code | -### Coupon Data Structure +### Data Structure of Coupon -| key | Description | Type | +| Key | Description | Type | |------|------|------| | id | Id | `string` | | name | Name | `string` | diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index bf0018948..289419cdd 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -109,7 +109,7 @@ export default { ### Coupon 数据结构 -| key | 说明 | 类型 | +| 键名 | 说明 | 类型 | |------|------|------| | id | 优惠券 id | `string` | | name | 优惠券名称 | `string` | diff --git a/src/picker/README.md b/src/picker/README.md index 221a8d4ae..7a468311a 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -213,13 +213,13 @@ Picker events will pass different parameters according to the columns are single |------|------| | title | Custom title | -### Column Data Struct +### Data Structure of Column -| key | Description | -|------|------| -| values | Value of column | -| defaultIndex | Default value index | -| className | ClassName for this column | +| Key | Description | Type | +|------|------|------| +| values | Value of column | `string[]` | +| defaultIndex | Default value index | `number` | +| className | ClassName for this column | `any` | ### Methods diff --git a/src/picker/README.zh-CN.md b/src/picker/README.zh-CN.md index 0f023cd4a..dde135f56 100644 --- a/src/picker/README.zh-CN.md +++ b/src/picker/README.zh-CN.md @@ -225,11 +225,11 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 当传入多列数据时,`columns`为一个对象数组,数组中的每一个对象配置每一列,每一列有以下`key` -| key | 说明 | -|------|------| -| values | 列中对应的备选值 | -| defaultIndex | 初始选中项的索引,默认为 0 | -| className | 为对应列添加额外的`class` | +| 键名 | 说明 | 类型 | +|------|------|------| +| values | 列中对应的备选值 | `string[]` +| defaultIndex | 初始选中项的索引,默认为 0 | `number` | +| className | 为对应列添加额外的类名 | `any` | ### 方法 diff --git a/src/tree-select/README.md b/src/tree-select/README.md index f6a780b03..980e77a96 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -62,7 +62,7 @@ export default { | navclick | triggered when parent node is selected | index: index of selected parent | | 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.