blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(ContactEdit): fix docs type and emit (#11866)

Browse Source
This commit is contained in:
Zhousg 2023-05-17 14:04:18 +08:00 committed by GitHub
parent be0d498c0e
commit c58b66ee33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -58,7 +58,7 @@ export default {
| Attribute | Description | Type | Default | | Attribute | Description | Type | Default |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| contact-info | Contact Info | _Contact_ | `[]` | | contact-info | Contact Info | _ContactEditInfo_ | `{}` |
| is-edit | Whether is editing | _boolean_ | `false` | | is-edit | Whether is editing | _boolean_ | `false` |
| is-saving | Whether to show save button loading status | _boolean_ | `false` | | is-saving | Whether to show save button loading status | _boolean_ | `false` |
| is-deleting | Whether to show delete button loading status | _boolean_ | `false` | | is-deleting | Whether to show delete button loading status | _boolean_ | `false` |
@ -68,17 +68,19 @@ export default {
### Events ### Events
| Event | Description | Arguments | | Event | Description | Arguments |
| ------ | ----------------------------------------- | --------------------- | | --- | --- | --- |
| save | Emitted when the save button is clicked | content: contact info | | save | Emitted when the save button is clicked | content: contact info |
| delete | Emitted when the delete button is clicked | content: contact info | | delete | Emitted when the delete button is clicked | content: contact info |
| change-default | Emitted when the default contact is switched | checked：contact is not the default |
### Data Structure of Contact ### Data Structure of ContactEditInfo
| key | Description | Type | | key | Description | Type |
| ---- | ----------- | -------- | | --------- | ----------- | ---------------------- |
| name | Name | _string_ | | name | Name | _string_ |
| tel | Phone | _string_ | | tel | Phone | _string_ |
| isDefault | Is Default | _boolean \| undefined_ |
### Types ### Types

22
packages/vant/src/contact-edit/README.zh-CN.md
View File

@ -58,7 +58,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| contact-info | 联系人信息 | _Contact_ | `{}` | | contact-info | 联系人信息 | _ContactEditInfo_ | `{}` |
| is-edit | 是否为编辑联系人 | _boolean_ | `false` | | is-edit | 是否为编辑联系人 | _boolean_ | `false` |
| is-saving | 是否显示保存按钮加载动画 | _boolean_ | `false` | | is-saving | 是否显示保存按钮加载动画 | _boolean_ | `false` |
| is-deleting | 是否显示删除按钮加载动画 | _boolean_ | `false` | | is-deleting | 是否显示删除按钮加载动画 | _boolean_ | `false` |
@ -68,17 +68,19 @@ export default {
### Events ### Events
| 事件名 | 说明 | 回调参数 | | 事件名 | 说明 | 回调参数 |
| ------ | ------------------ | ----------------- | | -------------- | -------------------------- | ----------------- |
| save | 点击保存按钮时触发 | content：表单内容 | | save | 点击保存按钮时触发 | content：表单内容 |
| delete | 点击删除按钮时触发 | content：表单内容 | | delete | 点击删除按钮时触发 | content：表单内容 |
| change-default | 切换是否为默认联系人时触发 | checked：是否默认 |
### Contact 数据结构 ### ContactEditInfo 数据结构
| 键名 | 说明 | 类型 | | 键名 | 说明 | 类型 |
| ---- | ------------ | ------------------ | | --------- | ------------ | ---------------------- |
| name | 联系人姓名 | _string_ | | name | 联系人姓名 | _string_ |
| tel | 联系人手机号 | _number \| string_ | | tel | 联系人手机号 | _string_ |
| isDefault | 是否默认 | _boolean \| undefined_ |
### 类型定义 ### 类型定义