[Improvement] Rate: add english document (#1010)

docs/demos/views/rate.vue

@@ -1,21 +1,21 @@
 <template>
   <demo-section>
     <demo-block :title="$t('basicUsage')">
-      <van-rate v-model="valueA" />
+      <van-rate v-model="value1" />
     </demo-block>
 
     <demo-block :title="$t('customColor')">
       <van-rate
-        v-model="valueB"
+        v-model="value2"
         :size="25"
-        :todal="6"
-        :color="'#2ba'"
-        :default-color="'#ceefe8'"
+        :count="6"
+        color="#2ba"
+        void-color="#ceefe8"
       />
     </demo-block>
 
-     <demo-block :title="$t('disabled')">
-      <van-rate disabled v-model="valueC" />
+    <demo-block :title="$t('disabled')">
+      <van-rate disabled v-model="value3" />
     </demo-block>
   </demo-section>
 </template>
@@ -35,9 +35,9 @@ export default {
 
   data() {
     return {
-      valueA: 3,
-      valueB: 4,
-      valueC: 2
+      value1: 3,
+      value2: 4,
+      value3: 2
     };
   }
 };

docs/markdown/en-US/rate.md

@@ -0,0 +1,56 @@
+## Rate
+
+### Install
+``` javascript
+import { Rate } from 'vant';
+
+Vue.use(Rate);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<van-rate v-model="value" />
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      value: 3
+    };
+  }
+}
+```
+
+#### Custom Color
+
+```html
+<van-rate
+  v-model="value"
+  :size="25"
+  :count="6"
+  color="#2ba"
+  void-color="#ceefe8"
+/>
+```
+
+#### Disabled
+
+```html
+ <van-rate v-model="value" disabled />
+```
+
+### Rate API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| v-model | Current rate | `Number` | - |
+| count | Count | `Number` | `5` |
+| size | Icon size (px) | `Number` | `20` |
+| color | Selected color | `String` | `#ffd21e`  |
+| void-color | Void color | `String` | `#c7c7c7` |
+| disabled-color | Disabled color | `String` | `#bdbdbd` | 
+| disabled | Whether to disable rate | `Boolean` | `false` |

docs/markdown/index.js

@@ -112,6 +112,7 @@ export default {
   'en-US/pull-refresh': wrapper(r => require.ensure([], () => r(require('./en-US/pull-refresh.md')), 'en-US/pull-refresh')),
   'en-US/quickstart': wrapper(r => require.ensure([], () => r(require('./en-US/quickstart.md')), 'en-US/quickstart')),
   'en-US/radio': wrapper(r => require.ensure([], () => r(require('./en-US/radio.md')), 'en-US/radio')),
+  'en-US/rate': wrapper(r => require.ensure([], () => r(require('./en-US/rate.md')), 'en-US/rate')),
   'en-US/search': wrapper(r => require.ensure([], () => r(require('./en-US/search.md')), 'en-US/search')),
   'en-US/sku': wrapper(r => require.ensure([], () => r(require('./en-US/sku.md')), 'en-US/sku')),
   'en-US/slider': wrapper(r => require.ensure([], () => r(require('./en-US/slider.md')), 'en-US/slider')),

docs/markdown/zh-CN/rate.md

@@ -31,9 +31,9 @@ export default {
 <van-rate
   v-model="value"
   :size="25"
-  :todal="6"
-  :color="color",
-  :defaultColor="defaultColor"
+  :count="6"
+  color="#2ba"
+  void-color="#ceefe8"
 />
 ```
 
@@ -47,10 +47,10 @@ export default {
 
 | 参数 | 说明 | 类型 | 默认值 |
 |-----------|-----------|-----------|-------------|
-| v-model | 当前分数 | `Number` | - |
-| size | 星标大小，单位为`px` | `Number` | `20` |
-| total | 总分 | `Number` | `5` |
-| color | 选中时的星标颜色 | `String` | `#ffd21e`  |
-| default-color | 未选中时的星标颜色 | `String` | `#c7c7c7` |
-| disabled-color | 不可选时的星标颜色 | `String` | `#bdbdbd` | 
+| v-model | 当前分值 | `Number` | - |
+| count | 图标总数 | `Number` | `5` |
+| size | 图标大小 (px) | `Number` | `20` |
+| color | 选中时的颜色 | `String` | `#ffd21e`  |
+| void-color | 未选中时的颜色 | `String` | `#c7c7c7` |
+| disabled-color | 不可选时的颜色 | `String` | `#bdbdbd` | 
 | disabled | 是否禁用评分 | `Boolean` | `false` |

docs/src/doc.config.js

@@ -438,6 +438,10 @@ module.exports = {
                 path: '/progress',
                 title: 'Progress'
               },
+              {
+                path: '/rate',
+                title: 'Rate'
+              },
               {
                 path: '/slider',
                 title: 'Slider'