ant-design/components/progress/index.zh-CN.md
偏右 882cec62d6
docs: 🌈 Add Components overview page (#24491)
* docs: Add components overview page

* fix detail

* remove ContributorsList form overview page

* fix components url

* improve code style

* remove extra file

* fix detail

* fix lint

* fix lint

* docs: Finish components overview page

* fix lint

* docs: Update cover

* fix lint

* update cover

* update menu

* improve overview page

* refactor code

* fix order

* update title

* add components count

* fix overview page ssr bug

* move less file

* update title margin

Co-authored-by: arvinxx <arvinx@foxmail.com>
2020-05-31 11:48:34 +08:00

2.5 KiB

category subtitle type title cover
Components 进度条 反馈 Progress https://gw.alipayobjects.com/zos/antfincdn/%24X8q%26OILIY/Progress.svg

展示操作的当前进度。

何时使用

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

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

API

各类型共用的属性。

属性 说明 类型 默认值
type 类型,可选 line circle dashboard string line
format 内容的模板函数 function(percent, successPercent) percent => percent + '%'
percent 百分比 number 0
showInfo 是否显示进度数值或状态图标 boolean true
status 状态,可选:success exception normal active(仅限 line) string -
strokeLinecap - round | square round
strokeColor 进度条的色彩 string -
successPercent 已完成的分段百分比 number 0
trailColor 未完成的分段的颜色 string -

type="line"

属性 说明 类型 默认值
strokeWidth 进度条线的宽度,单位 px number 10
strokeColor 进度条的色彩,传入 object 时为渐变 string | { from: string; to: string; direction: string } -
steps 进度条总共步数 number -

type="circle"

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

type="dashboard"

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