mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-09-29 05:29:57 +08:00
4ccd7c1cb5
* style: add --van-warning-color * style: add --van-success-color * feat: add more color variables
109 lines
2.6 KiB
Markdown
109 lines
2.6 KiB
Markdown
# ContactList
|
||
|
||
### Intro
|
||
|
||
Used to display the contact list.
|
||
|
||
### Install
|
||
|
||
Register component globally via `app.use`, refer to [Component Registration](#/en-US/advanced-usage#zu-jian-zhu-ce) for more registration ways.
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
import { ContactList } from 'vant';
|
||
|
||
const app = createApp();
|
||
app.use(ContactList);
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Basic Usage
|
||
|
||
```html
|
||
<van-contact-list
|
||
v-model="chosenContactId"
|
||
:list="list"
|
||
default-tag-text="default"
|
||
@add="onAdd"
|
||
@edit="onEdit"
|
||
@select="onSelect"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
import { reactive } from 'vue';
|
||
import { Toast } from 'vant';
|
||
|
||
export default {
|
||
setup() {
|
||
const state = reactive({
|
||
chosenContactId: '1',
|
||
list: [
|
||
{
|
||
id: '1',
|
||
name: 'John Snow',
|
||
tel: '13000000000',
|
||
isDefault: true,
|
||
},
|
||
{
|
||
id: '2',
|
||
name: 'Ned Stark',
|
||
tel: '1310000000',
|
||
},
|
||
],
|
||
});
|
||
|
||
const onAdd = () => Toast('Add');
|
||
const onEdit = (contact) => Toast('Edit' + contact.id);
|
||
const onSelect = (contact) => Toast('Select' + contact.id);
|
||
|
||
return {
|
||
state,
|
||
onAdd,
|
||
onEdit,
|
||
onSelect,
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| Attribute | Description | Type | Default |
|
||
| --- | --- | --- | --- |
|
||
| v-model | Id of chosen contact | _number \| string_ | - |
|
||
| list | Contact list | _Contact[]_ | `[]` |
|
||
| add-text | Add button text | _string_ | `Add new contact` |
|
||
| default-tag-text | Default tag text | _string_ | - |
|
||
|
||
### Events
|
||
|
||
| Event | Description | Arguments |
|
||
| --- | --- | --- |
|
||
| add | Emitted when the add button is clicked | - |
|
||
| edit | Emitted when the edit button is clicked | _contact: Contact，index: number_ |
|
||
| select | Emitted when a contact is selected | _contact: Contact, index: number_ |
|
||
|
||
### Data Structure of Contact
|
||
|
||
| key | Description | Type |
|
||
| --------- | ------------------ | ------------------ |
|
||
| id | ID | _number \| string_ |
|
||
| name | Name | _string_ |
|
||
| tel | Phone | _string_ |
|
||
| isDefault | Is default contact | _boolean_ |
|
||
|
||
### CSS Variables
|
||
|
||
The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).
|
||
|
||
| Name | Default Value | Description |
|
||
| --- | --- | --- |
|
||
| --van-contact-list-edit-icon-size | _16px_ | - |
|
||
| --van-contact-list-add-button-z-index | _999_ | - |
|
||
| --van-contact-list-item-padding | _var(--van-padding-md)_ | - |
|
||
| --van-contact-list-item-radio-icon-color | _var(--van-danger-color)_ | - |
|