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(Radio): improve param type

Browse Source
This commit is contained in:
陈嘉涵 2020-02-08 20:22:57 +08:00
parent 06513a985f
commit 779c83bd67
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/checkbox/README.md
View File

@ -225,7 +225,7 @@ export default {
| Name | Description | SlotProps | | Name | Description | SlotProps |
|------|------|------| |------|------|------|
| default | Custom label | - | | default | Custom label | - |
| icon | Custom icon | checked: whether to be checked | | icon | Custom icon | *checked: boolean* |
### CheckboxGroup Methods ### CheckboxGroup Methods

2
src/checkbox/README.zh-CN.md
View File

@ -241,7 +241,7 @@ export default {
| 名称 | 说明 | SlotProps | | 名称 | 说明 | SlotProps |
|------|------|------| |------|------|------|
| default | 自定义文本 | - | | default | 自定义文本 | - |
| icon | 自定义图标 | checked: 是否为选中状态 | | icon | 自定义图标 | *checked: boolean* |
### CheckboxGroup 方法 ### CheckboxGroup 方法

8
src/radio/README.md
View File

@ -148,7 +148,7 @@ export default {
| Attribute | Description | Type | Default | | Attribute | Description | Type | Default |
|------|------|------|------| |------|------|------|------|
| v-model | Name of checked radio | *any* | - | | v-model (v-model) | Name of checked radio | *any* | - |
| disabled | Disable all radios | *boolean* | `false` | | disabled | Disable all radios | *boolean* | `false` |
| icon-size `v2.2.3` | Icon size of all radios | *number \| string* | `20px` | | icon-size `v2.2.3` | Icon size of all radios | *number \| string* | `20px` |
| checked-color `v2.2.3` | Checked color of all radios | *string* | `#1989fa` | - | | checked-color `v2.2.3` | Checked color of all radios | *string* | `#1989fa` | - |
@ -157,17 +157,17 @@ export default {
| Event | Description | Parameters | | Event | Description | Parameters |
|------|------|------| |------|------|------|
| click | Triggered when click radio | event: Event | | click | Triggered when click radio | *event: Event* |
### RadioGroup Events ### RadioGroup Events
| Event | Description | Parameters | | Event | Description | Parameters |
|------|------|------| |------|------|------|
| change | Triggered when value changed | current value | | change | Triggered when value changed | *name: string* |
### Radio Slots ### Radio Slots
| Name | Description | SlotProps | | Name | Description | SlotProps |
|------|------|------| |------|------|------|
| default | Custom label | - | | default | Custom label | - |
| icon | Custom icon | checked: whether to be checked | | icon | Custom icon | *checked: boolean* |

8
src/radio/README.zh-CN.md
View File

@ -158,7 +158,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------| |------|------|------|------|
| v-model | 当前选中项的标识符 | *any* | - | | v-model (value) | 当前选中项的标识符 | *any* | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` | | disabled | 是否禁用所有单选框 | *boolean* | `false` |
| icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *number \| string* | `20px` | | icon-size `v2.2.3` | 所有单选框的图标大小，默认单位为`px` | *number \| string* | `20px` |
| checked-color `v2.2.3` | 所有单选框的选中状态颜色 | *string* | `#1989fa` | | checked-color `v2.2.3` | 所有单选框的选中状态颜色 | *string* | `#1989fa` |
@ -167,17 +167,17 @@ export default {
| 事件名 | 说明 | 回调参数 | | 事件名 | 说明 | 回调参数 |
|------|------|------| |------|------|------|
| click | 点击单选框时触发 | event: Event | | click | 点击单选框时触发 | *event: Event* |
### RadioGroup Events ### RadioGroup Events
| 事件名 | 说明 | 回调参数 | | 事件名 | 说明 | 回调参数 |
|------|------|------| |------|------|------|
| change | 当绑定值变化时触发的事件 | 当前选中项的 name | | change | 当绑定值变化时触发的事件 | *name: string* |
### Radio Slots ### Radio Slots
| 名称 | 说明 | SlotProps | | 名称 | 说明 | SlotProps |
|------|------|------| |------|------|------|
| default | 自定义文本 | - | | default | 自定义文本 | - |
| icon | 自定义图标 | checked: 是否为选中状态 | | icon | 自定义图标 | *checked: boolean* |