/*! 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:'

AddressList

\n

Intro

\n

Display a list of receiving addresses.

\n

Install

\n

Register component globally via app.use, refer to Component Registration for more registration ways.

\n
import { createApp } from 'vue';\nimport { AddressList } from 'vant';\n\nconst app = createApp();\napp.use(AddressList);\n
\n

Usage

\n

Basic Usage

\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
\n
import { 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

API

\n

Props

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeDescriptionTypeDefault
v-modelId of chosen addressnumber | string-
listAddress listAddress[][]
disabled-listDisabled address listAddress[][]
disabled-textDisabled textstring-
switchableWhether to allow switch addressbooleantrue
show-add-buttonWhether to show add buttonbooleantrue
add-button-textAdd button textstringAdd new address
default-tag-textDefault tag textstring-
right-icon v4.5.0Right Iconstringedit
\n

Events

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EventDescriptionArguments
addEmitted when the add button is clicked-
editEmitted when the edit icon of address is clickeditem: Address, index: number
selectEmitted when an address is selecteditem: Address, index: number
edit-disabledEmitted when the edit icon of disabled address is clickeditem: Address, index: number
select-disabledEmitted when a disabled address is selecteditem: Address, index: number
click-itemEmitted when an address item is clickeditem: Address, index: number, { event }
\n

Data Structure of Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescriptionType
idIdnumber | string
nameNamestring
telPhonenumber | string
addressAddressstring
isDefaultIs default addressboolean
\n

Slots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescriptionSlotProps
defaultCustom content after list-
topCustom content before list-
item-bottomCustom content after list itemitem: Address
tagCustom tag of list itemitem: Address
\n

Types

\n

The component exports the following type definitions:

\n
import type { AddressListProps, AddressListAddress } from 'vant';\n
\n

Theming

\n

CSS Variables

\n

The component provides the following CSS variables, which can be used to customize styles. Please refer to ConfigProvider component.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDefault ValueDescription
--van-address-list-paddingvar(--van-padding-sm) var(--van-padding-sm) 80px-
--van-address-list-disabled-text-colorvar(--van-text-color-2)-
--van-address-list-disabled-text-paddingvar(--van-padding-base) * 5 0 var(--van-padding-md)-
--van-address-list-disabled-text-font-sizevar(--van-font-size-md)-
--van-address-list-disabled-text-line-heightvar(--van-line-height-md)-
--van-address-list-add-button-z-index999-
--van-address-list-item-paddingvar(--van-padding-sm)-
--van-address-list-item-text-colorvar(--van-text-color)-
--van-address-list-item-disabled-text-colorvar(--van-text-color-3)-
--van-address-list-item-font-size13px-
--van-address-list-item-line-heightvar(--van-line-height-sm)-
--van-address-list-radio-colorvar(--van-primary-color)-
--van-address-list-edit-icon-size20px-
\n
'},null,8,a))}}}]);