AddressEdit 地址编辑

引入

  1. import Vue from 'vue';
  2. import { AddressEdit } from 'vant';
  3. Vue.use(AddressEdit);

代码演示

基础用法

  1. <van-address-edit
  2. :area-list="areaList"
  3. show-postal
  4. show-delete
  5. show-set-default
  6. show-search-result
  7. :search-result="searchResult"
  8. :area-columns-placeholder="['请选择', '请选择', '请选择']"
  9. @save="onSave"
  10. @delete="onDelete"
  11. @change-detail="onChangeDetail"
  12. />
  1. import { Toast } from 'vant';
  2. export default {
  3. data() {
  4. return {
  5. areaList,
  6. searchResult: []
  7. }
  8. },
  9. methods: {
  10. onSave() {
  11. Toast('save');
  12. },
  13. onDelete() {
  14. Toast('delete');
  15. },
  16. onChangeDetail(val) {
  17. if (val) {
  18. this.searchResult = [{
  19. name: '黄龙万科中心',
  20. address: '杭州市西湖区'
  21. }];
  22. } else {
  23. this.searchResult = [];
  24. }
  25. }
  26. }
  27. }

API

Props

参数说明类型默认值
area-list地区列表object-
area-columns-placeholder v2.2.5地区选择列占位提示文字string[][]
address-info收货人信息初始值AddressInfo{}
search-result详细地址搜索结果SearchResult[][]
show-postal是否显示邮政编码booleanfalse
show-delete是否显示删除按钮booleanfalse
show-set-default是否显示默认地址栏booleanfalse
show-search-result是否显示搜索结果booleanfalse
save-button-text保存按钮文字string保存
delete-button-text删除按钮文字string删除
detail-rows详细地址输入框行数number1
detail-maxlength v2.0.4详细地址最大长度number200
is-saving是否显示保存按钮加载动画booleanfalse
is-deleting是否显示删除按钮加载动画booleanfalse
tel-validator手机号格式校验函数string => boolean-
postal-validator v2.1.2邮政编码格式校验函数string => boolean-
validator自定义校验函数(key, value) => string-

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 可以获取到 AddressEdit 实例并调用实例方法

方法名说明参数返回值
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 组件。

AddressEdit 地址编辑 - 图1