blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs(ContactList): fix type (#11868)

Browse Source
This commit is contained in:
Zhousg 2023-05-17 22:12:16 +08:00 committed by GitHub
parent 2250013978
commit 83a11a8aee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
packages/vant/src/contact-list/README.md
View File

@ -74,7 +74,7 @@ export default {
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| v-model | Id of chosen contact | _number \| string_ | - |
| list | Contact list | _Contact[]_ | `[]` |
| list | Contact list | _ContactListItem[]_ | `[]` |
| add-text | Add button text | _string_ | `Add new contact` |
| default-tag-text | Default tag text | _string_ | - |
@ -83,17 +83,17 @@ export default {
| 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_ |
| edit | Emitted when the edit button is clicked | _contact: ContactListItem, index: number_ |
| select | Emitted when a contact is selected | _contact: ContactListItem, index: number_ |
### Data Structure of Contact
### Data Structure of ContactListItem
| key | Description | Type |
| --------- | ------------------ | ------------------ |
| id | ID | _number \| string_ |
| name | Name | _string_ |
| tel | Phone | _string_ |
| isDefault | Is default contact | _boolean_ |
| key | Description | Type |
| --------- | ------------------ | ---------------------- |
| id | ID | _number \| string_ |
| name | Name | _string_ |
| tel | Phone | _string_ |
| isDefault | Is default contact | _boolean \| undefined_ |
### Types

36
packages/vant/src/contact-list/README.zh-CN.md
View File

@ -71,29 +71,29 @@ export default {
### Props
| 参数 | 说明 | 类型 | 默认值 |
| ---------------- | ------------------- | ------------------ | ------------ |
| v-model | 当前选中联系人的 id | _number \| string_ | - |
| list | 联系人列表 | _Contact[]_ | `[]` |
| add-text | 新建按钮文案 | _string_ | `新建联系人` |
| default-tag-text | 默认联系人标签文案 | _string_ | - |
| 参数 | 说明 | 类型 | 默认值 |
| ---------------- | ------------------- | ------------------- | ------------ |
| v-model | 当前选中联系人的 id | _number \| string_ | - |
| list | 联系人列表 | _ContactListItem[]_ | `[]` |
| add-text | 新建按钮文案 | _string_ | `新建联系人` |
| default-tag-text | 默认联系人标签文案 | _string_ | - |
### Events
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------------- | --------------------------------- |
| add | 点击新增按钮时触发 | - |
| edit | 点击编辑按钮时触发 | _contact: Contact，index: number_ |
| select | 切换选中的联系人时触发 | _contact: Contact，index: number_ |
| 事件名 | 说明 | 回调参数 |
| ------ | ---------------------- | ----------------------------------------- |
| add | 点击新增按钮时触发 | - |
| edit | 点击编辑按钮时触发 | _contact: ContactListItem，index: number_ |
| select | 切换选中的联系人时触发 | _contact: ContactListItem，index: number_ |
### Contact 数据结构
### ContactListItem 数据结构
| 键名 | 说明 | 类型 |
| --------- | -------------------- | ------------------ |
| id | 每位联系人的唯一标识 | _number \| string_ |
| name | 联系人姓名 | _string_ |
| tel | 联系人手机号 | _number \| string_ |
| isDefault | 是否为默认联系人 | _boolean_ |
| 键名 | 说明 | 类型 |
| --------- | -------------------- | ---------------------- |
| id | 每位联系人的唯一标识 | _number \| string_ |
| name | 联系人姓名 | _string_ |
| tel | 联系人手机号 | _number \| string_ |
| isDefault | 是否为默认联系人 | _boolean \| undefined_ |
### 类型定义