[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,64 @@
+# Progress 进度条
+
+### 引入
+
+``` javascript
+import { Progress } from 'vant';
+
+Vue.use(Progress);
+```
+
+## 代码演示
+
+### 基础用法
+
+进度条默认为蓝色，使用`percentage`属性来设置当前进度
+
+```html
+<van-progress :percentage="50" />
+```
+
+### 置灰
+
+```html
+<van-progress inactive :percentage="50" />
+```
+
+### 样式定制
+
+可以使用`pivot-text`属性自定义文字，`color`属性自定义进度条颜色
+
+```html
+<van-progress
+  pivot-text="橙色"
+  color="#f2826a"
+  :percentage="25"
+/>
+
+<van-progress
+  pivot-text="红色"
+  color="#f44"
+  :percentage="50"
+/>
+
+<van-progress
+  :percentage="75"
+  pivot-text="紫色"
+  pivot-color="#7232dd"
+  color="linear-gradient(to right, #be99ff, #7232dd)"
+/>
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| inactive | 是否置灰 | `Boolean` | `false` | - |
+| percentage | 进度百分比 | `Number` | `0` | - |
+| show-pivot | 是否显示进度文字 | `Boolean` | `true` | - |
+| color | 进度条颜色 | `String` | `#1989fa` | - |
+| text-color | 进度条文字颜色 | `String` | `#fff` | - |
+| pivot-text | 文字显示 | `String` | 百分比文字 | - |
+| pivot-color | 文字背景色 | `String` | 与进度条颜色一致 | - |