[Doc] update changelog

This commit is contained in:
陈嘉涵
2018-10-18 18:50:23 +08:00
parent 2228e46733
commit 2e8d7e0b4f
107 changed files with 810 additions and 1212 deletions

View File

@@ -60,7 +60,7 @@ export default {
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|
|------|------|------|------|
| area-list | Area List | `Object` | - |
| address-info | Address Info | `Object` | `{}` |
| search-result | Address search result | `Array` | `[]` |
@@ -77,7 +77,7 @@ export default {
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
|------|------|------|
| save | Triggered when click save button | contentform content |
| focus | Triggered when focus field | key: field name |
| delete | Triggered when confirm delete | contentform content |
@@ -89,14 +89,14 @@ export default {
### Slot
| Name | Description |
|-----------|-----------|
|------|------|
| - | Custom content below postal |
### Data Structure
#### addressInfo Data Structure
| key | Description | Type |
|-----------|-----------|-----------|
|------|------|------|
| id | Address Id | `String | Number` |
| name | Name | `String` |
| tel | Phone | `String` |
@@ -110,7 +110,7 @@ export default {
#### searchResult Data Structure
| key | Description | Type |
|-----------|-----------|-----------|
|------|------|------|
| name | Name | `String` |
| address | Address | `String` |

View File

@@ -57,25 +57,25 @@ export default {
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| area-list | 地区列表 | `Object` | - |
| address-info | 收货人信息初始值 | `Object` | `{}` |
| search-result | 详细地址搜索结果 | `Array` | `[]` |
| 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` | `删除` |
| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` |
| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` |
| tel-validator | 手机号格式校验函数 | `(tel: string) => boolean` | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| area-list | 地区列表 | `Object` | - | - |
| address-info | 收货人信息初始值 | `Object` | `{}` | - |
| search-result | 详细地址搜索结果 | `Array` | `[]` | - |
| show-postal | 是否显示邮政编码 | `Boolean` | `false` | - |
| show-delete | 是否显示删除按钮 | `Boolean` | `false` | 1.0.0 |
| show-set-default | 是否显示默认地址栏 | `Boolean` | `false` | - |
| show-search-result | 是否显示搜索结果 | `Boolean` | `false` | - |
| save-button-text | 保存按钮文字 | `String` | `保存` | - |
| delete-button-text | 删除按钮文字 | `String` | `删除` | - |
| is-saving | 是否显示保存按钮加载动画 | `Boolean` | `false` | - |
| is-deleting | 是否显示删除按钮加载动画 | `Boolean` | `false` | - |
| tel-validator | 手机号格式校验函数 | `string => boolean` | - | - |
### Event
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
|------|------|------|
| save | 点击保存按钮时触发 | content表单内容 |
| focus | 输入框聚焦时触发 | key: 聚焦的输入框对应的 key |
| delete | 确认删除地址时触发 | content表单内容 |
@@ -87,7 +87,7 @@ export default {
### Slot
| 名称 | 说明 |
|-----------|-----------|
|------|------|
| - | 在邮政编码下方插入内容 |
### 数据格式
@@ -97,7 +97,7 @@ export default {
注意addressInfo 仅作为初始值传入,表单最终内容可以在 save 事件中获取
| key | 说明 | 类型 |
|-----------|-----------|-----------|
|------|------|------|
| id | 每条地址的唯一标识 | `String | Number` |
| name | 收货人姓名 | `String` |
| tel | 收货人手机号 | `String` |
@@ -112,24 +112,10 @@ export default {
#### searchResult 数据格式
| key | 说明 | 类型 |
|-----------|-----------|-----------|
|------|------|------|
| name | 地名 | `String` |
| address | 详细地址 | `String` |
#### 省市县列表数据格式
请参考 [Area](#/zh-CN/area) 组件。
### 更新日志
| 版本 | 类型 | 内容 |
|-----------|-----------|-----------|
| 1.3.2 | bugfix | 修复详细地址下边框未展示的问题
| 1.2.0 | breaking change | 采用驼峰命名的数据结构
| 1.2.0 | bugfix | 修复删除按钮展示逻辑
| 1.1.14 | bugfix | 修复格式化字符串时报错的问题
| 1.1.8 | feature | 支持配置按钮文字
| 1.1.6 | bugfix | 修复省市区弹层样式错误的问题
| 1.1.3 | feature | 新增 cancel-delete 事件
| 1.0.2 | bugfix | 修复初始化时省市区未正确选中的问题
| 1.0.0 | feature | 新增 show-delete 属性
| 1.0.0 | bugfix | 修复在数据变更时未正确选中省市区的问题