Browse Source

Fix documentation to min/max props

Mathieu DARTIGUES 8 years ago
parent
commit
71f1f511b2
2 changed files with 19 additions and 6 deletions
  1. 9 3
      examples/docs/en-US/checkbox.md
  2. 10 3
      examples/docs/zh-CN/checkbox.md

+ 9 - 3
examples/docs/en-US/checkbox.md

@@ -157,7 +157,7 @@ The `indeterminate` property can help you to achieve a 'check all' effect.
 
 
 ### Minimum / Maximum items checked
 ### Minimum / Maximum items checked
 
 
-The `minimum` and `maximum` properties can help you to limit the number of checked items.
+The `min` and `max` properties can help you to limit the number of checked items.
 
 
 :::demo
 :::demo
 
 
@@ -165,8 +165,8 @@ The `minimum` and `maximum` properties can help you to limit the number of check
 <template>
 <template>
   <el-checkbox-group 
   <el-checkbox-group 
     v-model="checkedCities1"
     v-model="checkedCities1"
-    minimum="1"
-    maximum="2">
+    :min="1"
+    :max="2">
     <el-checkbox v-for="city in cities" :label="city">{{city}}</el-checkbox>
     <el-checkbox v-for="city in cities" :label="city">{{city}}</el-checkbox>
   </el-checkbox-group>
   </el-checkbox-group>
 </template>
 </template>
@@ -199,6 +199,12 @@ The `minimum` and `maximum` properties can help you to limit the number of check
 | checked  | if the checkbox is checked   | boolean   |  — | false   |
 | checked  | if the checkbox is checked   | boolean   |  — | false   |
 | indeterminate  | same as `indeterminate` in native checkbox | boolean   |  — | false   |
 | indeterminate  | same as `indeterminate` in native checkbox | boolean   |  — | false   |
 
 
+### Checkbox-group Attributes
+| Attribute      | Description         | Type    | Options                         | Default|
+|---------- |-------- |---------- |-------------  |-------- |
+| min     | minimum number of checkbox checked   | number    |       —        |     —    |
+| max     | maximum number of checkbox checked   | number    |       —        |     —    |
+
 ### Checkbox-group Events
 ### Checkbox-group Events
 | Event Name | Description | Parameters |
 | Event Name | Description | Parameters |
 |---------- |-------- |---------- |
 |---------- |-------- |---------- |

+ 10 - 3
examples/docs/zh-CN/checkbox.md

@@ -166,7 +166,7 @@
 
 
 ### Minimum / Maximum items checked (to be translated)
 ### Minimum / Maximum items checked (to be translated)
 
 
-The `minimum` and `maximum` properties can help you to limit the number of checked items.
+The `min` and `max` properties can help you to limit the number of checked items.
 
 
 :::demo
 :::demo
 
 
@@ -174,8 +174,8 @@ The `minimum` and `maximum` properties can help you to limit the number of check
 <template>
 <template>
   <el-checkbox-group 
   <el-checkbox-group 
     v-model="checkedCities1"
     v-model="checkedCities1"
-    minimum="1"
-    maximum="2">
+    :min="1"
+    :max="2">
     <el-checkbox v-for="city in cities" :label="city">{{city}}</el-checkbox>
     <el-checkbox v-for="city in cities" :label="city">{{city}}</el-checkbox>
   </el-checkbox-group>
   </el-checkbox-group>
 </template>
 </template>
@@ -207,6 +207,13 @@ The `minimum` and `maximum` properties can help you to limit the number of check
 | checked  | 当前是否勾选    | boolean   |  — | false   |
 | checked  | 当前是否勾选    | boolean   |  — | false   |
 | indeterminate  | 设置 indeterminate 状态,只负责样式控制    | boolean   |  — | false   |
 | indeterminate  | 设置 indeterminate 状态,只负责样式控制    | boolean   |  — | false   |
 
 
+### Checkbox-group Attributes (to be translated)
+| Attribute      | Description         | Type    | Options                         | Default|
+|---------- |-------- |---------- |-------------  |-------- |
+| min     | minimum number of checkbox checked   | number    |       —        |     —    |
+| max     | maximum number of checkbox checked   | number    |       —        |     —    |
+
+
 ### Checkbox-group Events
 ### Checkbox-group Events
 | 事件名称      | 说明    | 回调参数      |
 | 事件名称      | 说明    | 回调参数      |
 |---------- |-------- |---------- |
 |---------- |-------- |---------- |