ant-design-vue/components/progress/index.zh-CN.md
Cherry7 7db4265616
feat(Progress): enhance size prop and add variants (#6409)
* refactor(progress): Progress size and add variants

* feat(progress): add `getsize`

* refactor(progress): Progress size and add variants

* chore(progress): update props type

* chore(progress): update props type

* feat(progress): update demo

* feat(progress): update docs

* test(progress): update test snap

* fix(Circle): Merging classes

* test(progress): update test snap

* feat(progress): add size demo

* test(progress): add size snapshot

* chore(Progress): reback Circle svg class change
2023-04-06 15:11:58 +08:00

2.7 KiB

category type title subtitle cover coverDark
Components 反馈 Progress 进度条 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*gK_4S6fDRfgAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*HJH8Tb1lcYAAAAAAAAAAAAAADrJ8AQ/original

展示操作的当前进度。

何时使用

在操作需要较长时间才能完成时,为用户显示该操作的当前进度和状态。

  • 当一个操作会打断当前界面,或者需要在后台运行,且耗时可能超过 2 秒时;
  • 当需要显示一个操作完成的百分比时。

API

各类型共用的属性。

属性 说明 类型 默认值 版本
format 内容的模板函数 function(percent, successPercent) (percent) => percent + %
percent 百分比 number 0
showInfo 是否显示进度数值或状态图标 boolean true
status 状态,可选:success exception normal active(仅限 line) string -
strokeColor 进度条的色彩 string -
strokeLinecap 进度条的样式 round | butt | square,区别详见 stroke-linecap round -
success 成功进度条相关配置 { percent: number, strokeColor: string } -
title html 标签 title string - 3.0
trailColor 未完成的分段的颜色 string -
type 类型,可选 line circle dashboard string line
size 进度条的尺寸 number | [number, number] | "small" | "default" "default"

type="line"

属性 说明 类型 默认值 版本
steps 进度条总共步数 number - -
strokeColor 进度条的色彩,传入 object 时为渐变。当有 steps 时支持传入一个数组。 string | string[] | { from: string; to: string; direction: string } - -

type="circle"

属性 说明 类型 默认值 版本
strokeColor 圆形进度条线的色彩,传入 object 时为渐变 string | object - -
strokeWidth 圆形进度条线的宽度,单位是进度条画布宽度的百分比 number 6 -

type="dashboard"

属性 说明 类型 默认值 版本
gapDegree 仪表盘进度条缺口角度,可取值 0 ~ 295 number 75 -
gapPosition 仪表盘进度条缺口位置 top | bottom | left | right bottom -
strokeWidth 仪表盘进度条线的宽度,单位是进度条画布宽度的百分比 number 6 -