Circle 环形进度条

介绍

圆环形的进度条组件,支持进度渐变动画。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Circle } from 'vant';
  3. const app = createApp();
  4. app.use(Circle);

代码演示

基础用法

rate 属性表示进度条的目标进度,v-model:current-rate 表示动画过程中的实时进度。当 rate 发生变化时,v-model:current-rate 会以 speed 的速度变化,直至达到 rate 设定的值。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="30"
  4. :speed="100"
  5. :text="text"
  6. />
  1. import { ref, computed } from 'vue';
  2. export default {
  3. setup() {
  4. const currentRate = ref(0);
  5. const text = computed(() => currentRate.value.toFixed(0) + '%');
  6. return {
  7. text,
  8. currentRate,
  9. };
  10. },
  11. };

宽度定制

通过 stroke-width 属性来控制进度条宽度。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. :stroke-width="60"
  5. text="宽度定制"
  6. />

颜色定制

通过 color 属性来控制进度条颜色,layer-color 属性来控制轨道颜色。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. layer-color="#ebedf0"
  5. text="颜色定制"
  6. />

渐变色

color 属性支持传入对象格式来定义渐变色。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. :color="gradientColor"
  5. text="渐变色"
  6. />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const currentRate = ref(0);
  5. const gradientColor = {
  6. '0%': '#3fecff',
  7. '100%': '#6149f6',
  8. };
  9. return {
  10. currentRate,
  11. gradientColor,
  12. };
  13. },
  14. };

逆时针方向

clockwise 设置为 false,进度会从逆时针方向开始。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. :clockwise="false"
  5. text="逆时针方向"
  6. />

大小定制

通过 size 属性设置圆环直径。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. size="120px"
  5. text="大小定制"
  6. />

起始位置

进度条默认从顶部开始,可以通过 start-position 属性设置起始位置。

  1. <van-circle
  2. v-model:current-rate="currentRate"
  3. :rate="rate"
  4. :text="左侧"
  5. start-position="left"
  6. />
  7. <van-circle
  8. v-model:current-rate="currentRate"
  9. :rate="rate"
  10. text="右侧"
  11. start-position="right"
  12. />
  13. <van-circle
  14. v-model:current-rate="currentRate"
  15. :rate="rate"
  16. text="底部"
  17. start-position="bottom"
  18. />

API

Props

参数说明类型默认值
v-model:current-rate当前进度number-
rate目标进度number | string100
size圆环直径,默认单位为 pxnumber | string100px
color进度条颜色,传入对象格式可以定义渐变色string | object#1989fa
layer-color轨道颜色stringwhite
fill填充颜色stringnone
speed动画速度(单位为 rate/s)number | string0
text文字string-
stroke-width进度条宽度number | string40
stroke-linecap进度条端点的形状,可选值为 square buttstringround
clockwise是否顺时针增加booleantrue
start-position v3.2.1进度起始位置,可选值为 leftrightbottomCircleStartPositiontop

Slots

名称说明
default自定义文字内容

类型定义

组件导出以下类型定义:

  1. import type { CircleProps, CircleStartPosition } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
—van-circle-size100px-
—van-circle-colorvar(—van-primary-color)-
—van-circle-layer-colorvar(—van-white)-
—van-circle-text-colorvar(—van-text-color)-
—van-circle-text-font-weightvar(—van-font-bold)-
—van-circle-text-font-sizevar(—van-font-size-md)-
—van-circle-text-line-heightvar(—van-line-height-md)-

Circle 环形进度条 - 图1