/*! For license information please see 6442.e1853b46.js.LICENSE.txt */ (self.webpackChunk=self.webpackChunk||[]).push([["6442"],{10931:function(t,s,n){"use strict";n.r(s);var d=n("80681");let a=["innerHTML"];s.default={setup:()=>({html:""}),render:()=>((0,d.wg)(),(0,d.iD)("div",{class:"van-doc-markdown-body",innerHTML:'
Display a list of receiving addresses.
\nRegister component globally via app.use, refer to Component Registration for more registration ways.
import { createApp } from 'vue';\nimport { AddressList } from 'vant';\n\nconst app = createApp();\napp.use(AddressList);\n\n<van-address-list\n v-model="chosenAddressId"\n :list="list"\n :disabled-list="disabledList"\n disabled-text="The following address is out of range"\n default-tag-text="Default"\n @add="onAdd"\n @edit="onEdit"\n/>\n\nimport { ref } from 'vue';\nimport { showToast } from 'vant';\n\nexport default {\n setup() {\n const chosenAddressId = ref('1');\n const list = [\n {\n id: '1',\n name: 'John Snow',\n tel: '13000000000',\n address: 'Somewhere',\n isDefault: true,\n },\n {\n id: '2',\n name: 'Ned Stark',\n tel: '1310000000',\n address: 'Somewhere',\n },\n ];\n const disabledList = [\n {\n id: '3',\n name: 'Tywin',\n tel: '1320000000',\n address: 'Somewhere',\n },\n ];\n\n const onAdd = () => showToast('Add');\n const onEdit = (item, index) => showToast('Edit:' + index);\n\n return {\n list,\n onAdd,\n onEdit,\n disabledList,\n chosenAddressId,\n };\n },\n};\n\n| Attribute | \nDescription | \nType | \nDefault | \n
|---|---|---|---|
| v-model | \nId of chosen address | \nnumber | string | \n- | \n
| list | \nAddress list | \nAddress[] | \n[] | \n
| disabled-list | \nDisabled address list | \nAddress[] | \n[] | \n
| disabled-text | \nDisabled text | \nstring | \n- | \n
| switchable | \nWhether to allow switch address | \nboolean | \ntrue | \n
| show-add-button | \nWhether to show add button | \nboolean | \ntrue | \n
| add-button-text | \nAdd button text | \nstring | \nAdd new address | \n
| default-tag-text | \nDefault tag text | \nstring | \n- | \n
right-icon v4.5.0 | \nRight Icon | \nstring | \nedit | \n
| Event | \nDescription | \nArguments | \n
|---|---|---|
| add | \nEmitted when the add button is clicked | \n- | \n
| edit | \nEmitted when the edit icon of address is clicked | \nitem: Address, index: number | \n
| select | \nEmitted when an address is selected | \nitem: Address, index: number | \n
| edit-disabled | \nEmitted when the edit icon of disabled address is clicked | \nitem: Address, index: number | \n
| select-disabled | \nEmitted when a disabled address is selected | \nitem: Address, index: number | \n
| click-item | \nEmitted when an address item is clicked | \nitem: Address, index: number, { event } | \n
| Key | \nDescription | \nType | \n
|---|---|---|
| id | \nId | \nnumber | string | \n
| name | \nName | \nstring | \n
| tel | \nPhone | \nnumber | string | \n
| address | \nAddress | \nstring | \n
| isDefault | \nIs default address | \nboolean | \n
| Name | \nDescription | \nSlotProps | \n
|---|---|---|
| default | \nCustom content after list | \n- | \n
| top | \nCustom content before list | \n- | \n
| item-bottom | \nCustom content after list item | \nitem: Address | \n
| tag | \nCustom tag of list item | \nitem: Address | \n
The component exports the following type definitions:
\nimport type { AddressListProps, AddressListAddress } from 'vant';\n\nThe component provides the following CSS variables, which can be used to customize styles. Please refer to ConfigProvider component.
\n| Name | \nDefault Value | \nDescription | \n
|---|---|---|
| --van-address-list-padding | \nvar(--van-padding-sm) var(--van-padding-sm) 80px | \n- | \n
| --van-address-list-disabled-text-color | \nvar(--van-text-color-2) | \n- | \n
| --van-address-list-disabled-text-padding | \nvar(--van-padding-base) * 5 0 var(--van-padding-md) | \n- | \n
| --van-address-list-disabled-text-font-size | \nvar(--van-font-size-md) | \n- | \n
| --van-address-list-disabled-text-line-height | \nvar(--van-line-height-md) | \n- | \n
| --van-address-list-add-button-z-index | \n999 | \n- | \n
| --van-address-list-item-padding | \nvar(--van-padding-sm) | \n- | \n
| --van-address-list-item-text-color | \nvar(--van-text-color) | \n- | \n
| --van-address-list-item-disabled-text-color | \nvar(--van-text-color-3) | \n- | \n
| --van-address-list-item-font-size | \n13px | \n- | \n
| --van-address-list-item-line-height | \nvar(--van-line-height-sm) | \n- | \n
| --van-address-list-radio-color | \nvar(--van-primary-color) | \n- | \n
| --van-address-list-edit-icon-size | \n20px | \n- | \n