mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
110 lines
2.4 KiB
Markdown
110 lines
2.4 KiB
Markdown
# AddressList
|
||
|
||
### Install
|
||
|
||
``` javascript
|
||
import Vue from 'vue';
|
||
import { AddressList } from 'vant';
|
||
|
||
Vue.use(AddressList);
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Basic Usage
|
||
|
||
```html
|
||
<van-address-list
|
||
v-model="chosenAddressId"
|
||
:list="list"
|
||
:disabled-list="disabledList"
|
||
disabled-text="The following address is out of range"
|
||
default-tag-text="Default"
|
||
@add="onAdd"
|
||
@edit="onEdit"
|
||
/>
|
||
```
|
||
|
||
```javascript
|
||
export default {
|
||
data() {
|
||
return {
|
||
chosenAddressId: '1',
|
||
list: [
|
||
{
|
||
id: '1',
|
||
name: 'John Snow',
|
||
tel: '13000000000',
|
||
address: 'Somewhere'
|
||
},
|
||
{
|
||
id: '2',
|
||
name: 'Ned Stark',
|
||
tel: '1310000000',
|
||
address: 'Somewhere'
|
||
}
|
||
],
|
||
disabledList: [
|
||
{
|
||
id: '3',
|
||
name: 'Tywin',
|
||
tel: '1320000000',
|
||
address: 'Somewhere'
|
||
}
|
||
]
|
||
}
|
||
},
|
||
|
||
methods: {
|
||
onAdd() {
|
||
Toast('Add');
|
||
},
|
||
onEdit(item, index) {
|
||
Toast('Edit:' + index);
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| Attribute | Description | Type | Default | Version |
|
||
|------|------|------|------|------|
|
||
| v-model | Id of chosen address | *string* | - | - |
|
||
| list | Address list | *Address[]* | `[]` | - |
|
||
| disabled-list | Disabled address list | *Address[]* | `[]` | - |
|
||
| disabled-text | Disabled text | *string* | - | - |
|
||
| switchable | Whether to allow switch address | *boolean* | `true` | - |
|
||
| add-button-text | Add button text | *string* | `Add new address` | - |
|
||
| default-tag-text | Default tag text | *string* | - | 2.3.0 |
|
||
|
||
### Events
|
||
|
||
| Event | Description | Arguments |
|
||
|------|------|------|
|
||
| add | Triggered when click add button | - |
|
||
| edit | Triggered when edit address | item: address object，index |
|
||
| select | Triggered when select address | item: address object，index |
|
||
| edit-disabled | Triggered when edit disabled address | item: address object，index |
|
||
| select-disabled | Triggered when select disabled address | item: address object，index |
|
||
| click-item | Triggered when click address item | item: address object，index |
|
||
|
||
### Data Structure of Address
|
||
|
||
| Key | Description | Type |
|
||
|------|------|------|
|
||
| id | Id | *string \| number* |
|
||
| name | Name | *string* |
|
||
| tel | Phone | *string \| number* |
|
||
| address | Address | *string* |
|
||
| isDefault | Is default address | *boolean* |
|
||
|
||
### Slots
|
||
|
||
| Name | Description |
|
||
|------|------|
|
||
| default | Custom content after list |
|
||
| top | Custom content before list |
|