[Doc] rename component README file (#3662)

2019-06-27 14:22:40 +08:00
parent a56f96c246
commit ddb24e6762
119 changed files with 4 additions and 3 deletions
@@ -0,0 +1,131 @@
+# AddressEdit 地址编辑
+
+### 引入
+``` javascript
+import { AddressEdit } from 'vant';
+
+Vue.use(AddressEdit);
+```
+
+## 代码演示
+
+### 基础用法
+
+```html
+<van-address-edit
+  :area-list="areaList"
+  show-postal
+  show-delete
+  show-set-default
+  show-search-result
+  :search-result="searchResult"
+  @save="onSave"
+  @delete="onDelete"
+  @change-detail="onChangeDetail"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      areaList,
+      searchResult: []
+    }
+  },
+
+  methods: {
+    onSave() {
+      Toast('save');
+    },
+    onDelete() {
+      Toast('delete');
+    },
+    onChangeDetail(val) {
+      if (val) {
+        this.searchResult = [{
+          name: '黄龙万科中心',
+          address: '杭州市西湖区'
+        }];
+      } else {
+        this.searchResult = [];
+      }
+    }
+  }
+}
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| 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` | - | - |
+| validator | 自定义校验函数 | `(key, value) => string` | - | 1.3.9 |
+
+### Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| save | 点击保存按钮时触发 | content：表单内容 |
+| focus | 输入框聚焦时触发 | key: 聚焦的输入框对应的 key |
+| delete | 确认删除地址时触发 | content：表单内容 |
+| cancel-delete | 取消删除地址时触发 | content：表单内容 |
+| select-search | 选中搜索结果时触发 | value: 搜索结果 |
+| change-area | 修改收件地区时触发 | values: 地区信息 |
+| change-detail | 修改详细地址时触发 | value: 详细地址内容 |
+| change-default | 切换是否使用默认地址时触发 | value: 是否选中 |
+
+### Slots
+
+| 名称 | 说明 |
+|------|------|
+| default | 在邮政编码下方插入内容 |
+
+### 方法
+
+通过 ref 可以获取到 address-edit 实例并调用实例方法
+
+| 方法名 | 参数 | 返回值 | 介绍 |
+|------|------|------|------|
+| setAddressDetail | addressDetail: string | - | 设置详细地址 |
+
+### addressInfo 数据格式
+
+注意：addressInfo 仅作为初始值传入，表单最终内容可以在 save 事件中获取
+
+| key | 说明 | 类型 |
+|------|------|------|
+| 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` |
+
+### 省市县列表数据格式
+
+请参考 [Area](#/zh-CN/area) 组件。