alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/address-edit/README.md
+28 -28
View File
@@ -63,22 +63,22 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| area-list | Area List | `object` | - | - |
| address-info | Address Info | `AddressInfo` | `{}` | - |
| search-result | Address search result | `SearchResult[]` | `[]` | - |
| show-postal | Whether to show postal field | `boolean` | `false` | - |
| show-delete | Whether to show delete button | `boolean` | `false` | - |
| show-set-default | Whether to show default address switch | `boolean` | `false` | - |
| show-search-result | Whether to show address search result | `boolean` | `false` | - |
| save-button-text | Save button text | `string` | `Save` | - |
| delete-button-text | Delete button text | `string` | `Delete` | - |
| detail-rows | Detail input rows | `number` | `1` | - |
| detail-maxlength | Detail maxlength | `number` | `200` | 2.0.4 |
| is-saving | Whether to show save button loading status | `boolean` | `false` | - |
| is-deleting | Whether to show delete button loading status | `boolean` | `false` | - |
| tel-validator | The method to validate tel | `(tel: string) => boolean` | - | - |
| postal-validator | The method to validate postal | `(tel: string) => boolean` | - | 2.1.2 |
| validator | Custom validator | `(key, value) => string` | - | - |
| area-list | Area List | *object* | - | - |
| address-info | Address Info | *AddressInfo* | `{}` | - |
| search-result | Address search result | *SearchResult[]* | `[]` | - |
| show-postal | Whether to show postal field | *boolean* | `false` | - |
| show-delete | Whether to show delete button | *boolean* | `false` | - |
| show-set-default | Whether to show default address switch | *boolean* | `false` | - |
| show-search-result | Whether to show address search result | *boolean* | `false` | - |
| save-button-text | Save button text | *string* | `Save` | - |
| delete-button-text | Delete button text | *string* | `Delete` | - |
| detail-rows | Detail input rows | *number* | `1` | - |
| detail-maxlength | Detail maxlength | *number* | `200` | 2.0.4 |
| is-saving | Whether to show save button loading status | *boolean* | `false` | - |
| is-deleting | Whether to show delete button loading status | *boolean* | `false` | - |
| tel-validator | The method to validate tel | *(tel: string) => boolean* | - | - |
| postal-validator | The method to validate postal | *(tel: string) => boolean* | - | 2.1.2 |
| validator | Custom validator | *(key, value) => string* | - | - |
### Events
@@ -111,23 +111,23 @@ Use ref to get address-edit instance and call instance methods
| key | Description | Type |
|------|------|------|
| id | Address Id | `string | number` |
| name | Name | `string` |
| tel | Phone | `string` |
| province | Province | `string` |
| city | City | `string` |
| county | County | `string` |
| addressDetail | Detailed Address | `string` |
| areaCode | Area code | `string` |
| postalCode | Postal code | `string` |
| isDefault | Is default address | `boolean` |
| id | Address Id | *string \| number* |
| name | Name | *string* |
| tel | Phone | *string* |
| province | Province | *string* |
| city | City | *string* |
| county | County | *string* |
| addressDetail | Detailed Address | *string* |
| areaCode | Area code | *string* |
| postalCode | Postal code | *string* |
| isDefault | Is default address | *boolean* |
### SearchResult Data Structure
| key | Description | Type |
|------|------|------|
| name | Name | `string` |
| address | Address | `string` |
| name | Name | *string* |
| address | Address | *string* |
### Area Data Structure
src/address-edit/README.zh-CN.md
+28 -28
View File
@@ -63,22 +63,22 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| area-list | 地区列表 | `object` | - | - |
| address-info | 收货人信息初始值 | `AddressInfo` | `{}` | - |
| search-result | 详细地址搜索结果 | `SearchResult[]` | `[]` | - |
| show-postal | 是否显示邮政编码 | `boolean` | `false` | - |
| show-delete | 是否显示删除按钮 | `boolean` | `false` | - |
| show-set-default | 是否显示默认地址栏 | `boolean` | `false` | - |
| show-search-result | 是否显示搜索结果 | `boolean` | `false` | - |
| save-button-text | 保存按钮文字 | `string` | `保存` | - |
| delete-button-text | 删除按钮文字 | `string` | `删除` | - |
| detail-rows | 详细地址输入框行数 | `number` | `1` |
| detail-maxlength | 详细地址最大长度 | `number` | `200` | 2.0.4 |
| is-saving | 是否显示保存按钮加载动画 | `boolean` | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | `boolean` | `false` | - |
| tel-validator | 手机号格式校验函数 | `string => boolean` | - | - |
| postal-validator | 邮政编码格式校验函数 | `string => boolean` | - | 2.1.2 |
| validator | 自定义校验函数 | `(key, value) => string` | - | - |
| area-list | 地区列表 | *object* | - | - |
| address-info | 收货人信息初始值 | *AddressInfo* | `{}` | - |
| search-result | 详细地址搜索结果 | *SearchResult[]* | `[]` | - |
| show-postal | 是否显示邮政编码 | *boolean* | `false` | - |
| show-delete | 是否显示删除按钮 | *boolean* | `false` | - |
| show-set-default | 是否显示默认地址栏 | *boolean* | `false` | - |
| show-search-result | 是否显示搜索结果 | *boolean* | `false` | - |
| save-button-text | 保存按钮文字 | *string* | `保存` | - |
| delete-button-text | 删除按钮文字 | *string* | `删除` | - |
| detail-rows | 详细地址输入框行数 | *number* | `1` |
| detail-maxlength | 详细地址最大长度 | *number* | `200` | 2.0.4 |
| is-saving | 是否显示保存按钮加载动画 | *boolean* | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | *boolean* | `false` | - |
| tel-validator | 手机号格式校验函数 | *string => boolean* | - | - |
| postal-validator | 邮政编码格式校验函数 | *string => boolean* | - | 2.1.2 |
| validator | 自定义校验函数 | *(key, value) => string* | - | - |
### Events
@@ -113,23 +113,23 @@ export default {
| key | 说明 | 类型 |
|------|------|------|
| id | 每条地址的唯一标识 | `string | number` |
| name | 收货人姓名 | `string` |
| tel | 收货人手机号 | `string` |
| province | 省份 | `string` |
| city | 城市 | `string` |
| county | 区县 | `string` |
| addressDetail | 详细地址 | `string` |
| areaCode | 地区编码，通过`省市区选择`获取（必填） | `string` |
| postalCode | 邮政编码 | `string` |
| isDefault | 是否为默认地址 | `boolean` |
| id | 每条地址的唯一标识 | *string \| number* |
| name | 收货人姓名 | *string* |
| tel | 收货人手机号 | *string* |
| province | 省份 | *string* |
| city | 城市 | *string* |
| county | 区县 | *string* |
| addressDetail | 详细地址 | *string* |
| areaCode | 地区编码，通过`省市区选择`获取（必填） | *string* |
| postalCode | 邮政编码 | *string* |
| isDefault | 是否为默认地址 | *boolean* |
### SearchResult 数据格式
| key | 说明 | 类型 |
|------|------|------|
| name | 地名 | `string` |
| address | 详细地址 | `string` |
| name | 地名 | *string* |
| address | 详细地址 | *string* |
### 省市县列表数据格式