mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-03 12:19:15 +08:00
153 lines
2.9 KiB
Markdown
153 lines
2.9 KiB
Markdown
# Circle
|
||
|
||
### Install
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
import { Circle } from 'vant';
|
||
|
||
const app = createApp();
|
||
app.use(Circle);
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Basic Usage
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="30"
|
||
:speed="100"
|
||
:text="text"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
import { ref, computed } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const currentRate = ref(0);
|
||
const text = computed(() => currentRate.value.toFixed(0) + '%');
|
||
|
||
return {
|
||
text,
|
||
currentRate,
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### Custom Width
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="rate"
|
||
:stroke-width="60"
|
||
text="Custom Width"
|
||
/>
|
||
```
|
||
|
||
### Custom Color
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="rate"
|
||
layer-color="#ebedf0"
|
||
text="Custom Color"
|
||
/>
|
||
```
|
||
|
||
### Gradient
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="rate"
|
||
:color="gradientColor"
|
||
text="Gradient"
|
||
/>
|
||
```
|
||
|
||
```js
|
||
import { ref } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const currentRate = ref(0);
|
||
const gradientColor = {
|
||
'0%': '#3fecff',
|
||
'100%': '#6149f6',
|
||
};
|
||
|
||
return {
|
||
currentRate,
|
||
gradientColor,
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### Counter Clockwise
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="rate"
|
||
:clockwise="false"
|
||
text="Counter Clockwise"
|
||
/>
|
||
```
|
||
|
||
### Custom Size
|
||
|
||
```html
|
||
<van-circle
|
||
v-model:current-rate="currentRate"
|
||
:rate="rate"
|
||
size="120px"
|
||
text="Custom Size"
|
||
/>
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| Attribute | Description | Type | Default |
|
||
| --- | --- | --- | --- |
|
||
| 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` |
|
||
| layer-color | Layer color | _string_ | `white` |
|
||
| fill | Fill color | _string_ | `none` |
|
||
| speed | Animate speed（rate/s） | _number \| string_ | `0` |
|
||
| text | Text | _string_ | - |
|
||
| stroke-width | Stroke width | _number \| string_ | `40` |
|
||
| stroke-linecap | Stroke linecap，can be set to `sqaure` `butt` | _string_ | `round` |
|
||
| clockwise | Whether to be clockwise | _boolean_ | `true` |
|
||
|
||
### Slots
|
||
|
||
| Name | Description |
|
||
| ------- | ------------------- |
|
||
| default | custom text content |
|
||
|
||
### Less Variables
|
||
|
||
How to use: [Custom Theme](#/en-US/theme).
|
||
|
||
| Name | Default Value | Description |
|
||
| ------------------------ | ------------------- | ----------- |
|
||
| @circle-size | `100px` | - |
|
||
| @circle-color | `@blue` | - |
|
||
| @circle-layer-color | `@white` | - |
|
||
| @circle-text-color | `@text-color` | - |
|
||
| @circle-text-font-weight | `@font-weight-bold` | - |
|
||
| @circle-text-font-size | `@font-size-md` | - |
|
||
| @circle-text-line-height | `@line-height-md` | - |
|