[Doc] rename component README file (#3662)

2019-06-27 14:22:40 +08:00
parent a56f96c246
commit ddb24e6762
119 changed files with 4 additions and 3 deletions
@@ -0,0 +1,112 @@
+# Rate 评分
+
+### 引入
+``` javascript
+import { Rate } from 'vant';
+
+Vue.use(Rate);
+```
+
+## 代码演示
+
+### 基础用法
+
+```html
+<van-rate v-model="value" />
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      value: 3
+    };
+  }
+}
+```
+
+### 自定义图标
+
+```html
+<van-rate
+  v-model="value"
+  icon="like"
+  void-icon="like-o"
+/>
+```
+
+### 自定义样式
+
+```html
+<van-rate
+  v-model="value"
+  :size="25"
+  color="#f44"
+  void-icon="star"
+  void-color="#eee"
+/>
+```
+
+### 半星
+
+```html
+<van-rate
+  v-model="value"
+  allow-half
+  void-icon="star"
+  void-color="#eee"
+/>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      value: 2.5
+    };
+  }
+}
+```
+
+### 自定义数量
+
+```html
+<van-rate v-model="value" :count="6" />
+```
+
+### 禁用状态
+
+```html
+<van-rate v-model="value" disabled />
+```
+
+### 只读状态
+
+```html
+<van-rate v-model="value" readonly />
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| v-model | 当前分值 | `Number` | - | - |
+| count | 图标总数 | `Number` | `5` | - |
+| size | 图标大小，默认单位为`px` | `String | Number` | `20px` | - |
+| gutter | 图标间距，默认单位为`px` | `String | Number` | `4px` | 2.0.0 |
+| color | 选中时的颜色 | `String` | `#ffd21e` | - |
+| void-color | 未选中时的颜色 | `String` | `#c7c7c7` | - |
+| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | `String` | `star` | 1.4.7 |
+| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | `String` | `star-o`  | 1.4.7 |
+| allow-half | 是否允许半选 | `Boolean` | `false` | 1.6.14 |
+| readonly | 是否为只读状态 | `Boolean` | `false` | 1.3.0 |
+| disabled | 是否禁用评分 | `Boolean` | `false` | - |
+| disabled-color | 禁用时的颜色 | `String` | `#bdbdbd` | - |
+
+### Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| change | 当前分值变化时触发的事件 | 当前分值 |