From 6189b7539500152f7fdc648b546fa7ad3e93101f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=98=89=E6=B6=B5?= Date: Sat, 8 Feb 2020 20:08:54 +0800 Subject: [PATCH] docs(Checkbox): improve param type --- src/checkbox/README.md | 14 +++++++------- src/checkbox/README.zh-CN.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 0249a0b36..199c42852 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -187,9 +187,9 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| +| v-model (value) | Check status | *boolean* | `false` | | name | Checkbox name | *any* | - | | shape | Can be set to `square` | *string* | `round` | -| v-model | Check status | *boolean* | `false` | | disabled | Disable checkbox | *boolean* | `false` | | label-disabled | Whether to disable label click | *boolean* | `false` | | label-position | Can be set to `left` | *string* | `right` | @@ -201,7 +201,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | Names of all checked checkboxes | *any[]* | - | +| v-model (value) | Names of all checked checkboxes | *any[]* | - | | max | Maximum amount of checked options | *number \| string* | `0`(Unlimited) | | disabled | Disable all checkboxes | *boolean* | `false` | | icon-size `v2.2.3` | Icon size of all checkboxes | *number \| string* | `20px` | @@ -211,14 +211,14 @@ export default { | Event | Description | Parameters | |------|------|------| -| change | Triggered when value changed | current value | -| click | Triggered when click checkbox | event: Event | +| change | Triggered when value changed | *checked: boolean* | +| click | Triggered when click checkbox | *event: Event* | ### CheckboxGroup Events | Event | Description | Parameters | |------|------|------| -| change | Triggered when value changed | current value | +| change | Triggered when value changed | *names: any[]* | ### Checkbox Slots @@ -233,7 +233,7 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get CheckboxGroup instance and call | Name | Description | Attribute | Return value | |------|------|------|------| -| toggleAll | Toggle check status of all checkboxes | checked?: boolean | - | +| toggleAll | Toggle check status of all checkboxes | *checked?: boolean* | - | ### Checkbox Methods @@ -241,4 +241,4 @@ Use [ref](https://vuejs.org/v2/api/#ref) to get Checkbox instance and call insta | Name | Description | Attribute | Return value | |------|------|------|------| -| toggle | Toggle check status | checked?: boolean | - | +| toggle | Toggle check status | *checked?: boolean* | - | diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index c5bf85d41..45fb56ac1 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -203,9 +203,9 @@ export default { | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| +| v-model (value) | 是否为选中状态 | *boolean* | `false` | | name | 标识符 | *any* | - | | shape | 形状，可选值为 `square` | *string* | `round` | -| v-model | 是否为选中状态 | *boolean* | `false` | | disabled | 是否禁用复选框 | *boolean* | `false` | | label-disabled | 是否禁用复选框文本点击 | *boolean* | `false` | | label-position | 文本位置，可选值为 `left` | *string* | `right` | @@ -217,7 +217,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| -| v-model | 所有选中项的标识符 | *any[]* | - | +| v-model (value) | 所有选中项的标识符 | *any[]* | - | | disabled | 是否禁用所有复选框 | *boolean* | `false` | | max | 最大可选数，0 为无限制 | *number \| string* | `0` | | icon-size `v2.2.3` | 所有复选框的图标大小，默认单位为`px` | *number \| string* | `20px` | @@ -227,14 +227,14 @@ export default { | 事件名 | 说明 | 回调参数 | |------|------|------| -| change | 当绑定值变化时触发的事件 | 当前组件的值 | -| click | 点击复选框时触发 | event: Event | +| change | 当绑定值变化时触发的事件 | *checked: boolean* | +| click | 点击复选框时触发 | *event: Event* | ### CheckboxGroup Events | 事件名 | 说明 | 回调参数 | |------|------|------| -| change | 当绑定值变化时触发的事件 | 当前组件的值 | +| change | 当绑定值变化时触发的事件 | *names: any[]* | ### Checkbox Slots @@ -249,7 +249,7 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | |------|------|------|------| -| toggleAll | 切换所有复选框，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - | +| toggleAll | 切换所有复选框，传`true`为选中，`false`为取消选中，不传参为取反 | *checked?: boolean* | - | ### Checkbox 方法 @@ -257,4 +257,4 @@ export default { | 方法名 | 说明 | 参数 | 返回值 | |------|------|------|------| -| toggle | 切换选中状态，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - | +| toggle | 切换选中状态，传`true`为选中，`false`为取消选中，不传参为取反 | *checked?: boolean* | - |