docs(Circle): currentRate should be kebab-case

This commit is contained in:
chenjiahan 2020-10-09 19:30:06 +08:00
parent d207902e47
commit 8356831711
3 changed files with 21 additions and 21 deletions

View File

@ -16,7 +16,7 @@ app.use(Circle);
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="30"
:speed="100"
:text="text"
@ -42,7 +42,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:stroke-width="60"
text="Custom Width"
@ -53,7 +53,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
layer-color="#ebedf0"
text="Custom Color"
@ -64,7 +64,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:color="gradientColor"
text="Gradient"
@ -89,7 +89,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:clockwise="false"
text="Counter Clockwise"
@ -100,7 +100,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
size="120px"
text="Custom Size"
@ -113,7 +113,7 @@ export default {
| Attribute | Description | Type | Default |
| --- | --- | --- | --- |
| v-model:currentRate | Current rate | _number_ | - |
| v-model:current-rate | Current rate | _number_ | - |
| rate | Target rate | _number \| string_ | `100` |
| size | Circle size | _number \| string_ | `100px` |
| color | Progress color, passing object to render gradient | _string \| object_ | `#1989fa` |

View File

@ -14,11 +14,11 @@ app.use(Circle);
### 基础用法
`rate` 属性表示进度条的目标进度,`v-model:currentRate` 表示动画过程中的实时进度。当 `rate` 发生变化时,`v-model:currentRate` 会以 `speed` 的速度变化,直至达到 `rate` 设定的值。
`rate` 属性表示进度条的目标进度,`v-model:current-rate` 表示动画过程中的实时进度。当 `rate` 发生变化时,`v-model:current-rate` 会以 `speed` 的速度变化,直至达到 `rate` 设定的值。
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="30"
:speed="100"
:text="text"
@ -46,7 +46,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:stroke-width="60"
text="宽度定制"
@ -59,7 +59,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
layer-color="#ebedf0"
text="颜色定制"
@ -72,7 +72,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:color="gradientColor"
text="渐变色"
@ -99,7 +99,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
:clockwise="false"
text="逆时针方向"
@ -112,7 +112,7 @@ export default {
```html
<van-circle
v-model:currentRate="currentRate"
v-model:current-rate="currentRate"
:rate="rate"
size="120px"
text="大小定制"
@ -125,7 +125,7 @@ export default {
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| v-model:currentRate | 当前进度 | _number_ | - |
| v-model:current-rate | 当前进度 | _number_ | - |
| rate | 目标进度 | _number \| string_ | `100` |
| size | 圆环直径,默认单位为 `px` | _number \| string_ | `100px` |
| color | 进度条颜色,传入对象格式可以定义渐变色 | _string \| object_ | `#1989fa` |

View File

@ -2,7 +2,7 @@
<demo-section>
<demo-block :title="t('basicUsage')">
<van-circle
v-model:currentRate="currentRate1"
v-model:current-rate="currentRate1"
:rate="rate"
:speed="100"
:text="currentRate1.toFixed(0) + '%'"
@ -11,7 +11,7 @@
<demo-block :title="t('customStyle')">
<van-circle
v-model:currentRate="currentRate3"
v-model:current-rate="currentRate3"
:rate="rate"
:speed="100"
:stroke-width="60"
@ -19,7 +19,7 @@
/>
<van-circle
v-model:currentRate="currentRate3"
v-model:current-rate="currentRate3"
color="#ee0a24"
:rate="rate"
layer-color="#ebedf0"
@ -28,7 +28,7 @@
/>
<van-circle
v-model:currentRate="currentRate2"
v-model:current-rate="currentRate2"
:rate="rate"
:speed="100"
:color="gradientColor"
@ -36,7 +36,7 @@
/>
<van-circle
v-model:currentRate="currentRate4"
v-model:current-rate="currentRate4"
color="#07c160"
:rate="rate"
:speed="100"
@ -46,7 +46,7 @@
/>
<van-circle
v-model:currentRate="currentRate4"
v-model:current-rate="currentRate4"
color="#7232dd"
:rate="rate"
:speed="100"