介绍
收货地址编辑组件,用于新建、更新、删除收货地址。
实例演示
引入
通过以下方式来全局注册组件,更多注册方式请参考组件注册。
import { createApp } from vue;
import { AddressEdit } from vant;
const app = createApp();
app.use(AddressEdit);
代码演示
基础用法
<van-address-edit
:area-list="areaList"
show-postal
show-delete
show-set-default
show-search-result
:search-result="searchResult"
:area-columns-placeholder="[请选择, 请选择, 请选择]"
@save="onSave"
@delete="onDelete"
@change-detail="onChangeDetail"
/>
import { ref } from vue;
import { Toast } from vant;
export default {
setup() {
const searchResult = ref([]);
const onSave = () => Toast(save);
const onDelete = () => Toast(delete);
const onChangeDetail = (val) => {
if (val) {
searchResult.value = [
{
name: 黄龙万科中心,
address: 杭州市西湖区,
},
];
} else {
searchResult.value = [];
}
};
return {
onSave,
onDelete,
areaList,
searchResult,
onChangeDetail,
};
},
};
API
Props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
area-list | 地区列表 | object | – |
area-columns-placeholder | 地区选择列占位提示文字 | string[] | [] |
area-placeholder | 地区输入框占位提示文字 | string | 选择省 / 市 / 区 |
address-info | 收货人信息初始值 | AddressInfo | {} |
search-result | 详细地址搜索结果 | SearchResult[] | [] |
show-postal | 是否显示邮政编码 | boolean | false |
show-delete | 是否显示删除按钮 | boolean | false |
show-set-default | 是否显示默认地址栏 | boolean | false |
show-search-result | 是否显示搜索结果 | boolean | false |
show-area | 是否显示地区 | boolean | true |
show-detail | 是否显示详细地址 | boolean | true |
disable-area | 是否禁用地区选择 | boolean | false |
save-button-text | 保存按钮文字 | string | 保存 |
delete-button-text | 删除按钮文字 | string | 删除 |
detail-rows | 详细地址输入框行数 | number | string | 1 |
detail-maxlength | 详细地址最大长度 | number | string | 200 |
is-saving | 是否显示保存按钮加载动画 | boolean | false |
is-deleting | 是否显示删除按钮加载动画 | boolean | false |
tel-validator | 手机号格式校验函数 | string => boolean | – |
tel-maxlength | 手机号最大长度 | number | string | – |
postal-validator | 邮政编码格式校验函数 | string => boolean | – |
validator | 自定义校验函数 | (key, val) => string | – |
Events
事件名 | 说明 | 回调参数 |
---|---|---|
save | 点击保存按钮时触发 | content:表单内容 |
focus | 输入框聚焦时触发 | key: 聚焦的输入框对应的 key |
delete | 确认删除地址时触发 | content:表单内容 |
cancel-delete | 取消删除地址时触发 | content:表单内容 |
select-search | 选中搜索结果时触发 | value: 搜索结果 |
click-area | 点击收件地区时触发 | – |
change-area | 修改收件地区时触发 | values: 地区信息 |
change-detail | 修改详细地址时触发 | value: 详细地址内容 |
change-default | 切换是否使用默认地址时触发 | value: 是否选中 |
Slots
名称 | 说明 |
---|---|
default | 在邮政编码下方插入内容 |
方法
通过 ref 可以获取到 AddressEdit 实例并调用实例方法,详见组件实例方法。
方法名 | 说明 | 参数 | 返回值 |
---|---|---|---|
setAddressDetail | 设置详细地址 | addressDetail: string | – |
类型定义
通过 AddressEditInstance 获取 AddressEdit 实例的类型定义。
import { ref } from vue;
import type { AddressEditInstance } from vant;
const addressEditRef = ref<AddressEditInstance>();
addressEditRef.value?.setAddressDetail();
AddressInfo 数据格式
注意:AddressInfo 仅作为初始值传入,表单最终内容可以在 save 事件中获取。
key | 说明 | 类型 |
---|---|---|
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 组件。
样式变量
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
–van-address-edit-padding | var(–van-padding-sm) | – |
–van-address-edit-buttons-padding | var(–van-padding-xl) var(–van-padding-base) | – |
–van-address-edit-button-margin-bottom | var(–van-padding-sm) | – |
–van-address-edit-button-font-size | var(–van-font-size-lg) | – |
–van-address-edit-detail-finish-color | var(–van-primary-color) | – |
–van-address-edit-detail-finish-font-size | var(–van-font-size-sm) | – |
作者:terry,如若转载,请注明出处:https://www.web176.com/vant3/18682.html