mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-24 11:10:01 +08:00
2113c25664
* feat: <Progress steps /> could accept string[] as strokeColor close #35852 close #26858 * fix: tsx demo * docs: add version column
2.7 KiB
2.7 KiB
| category | subtitle | type | title | cover |
|---|---|---|---|---|
| Components | 进度条 | 反馈 | Progress | https://gw.alipayobjects.com/zos/alicdn/xqsDu4ZyR/Progress.svg |
展示操作的当前进度。
何时使用
在操作需要较长时间才能完成时，为用户显示该操作的当前进度和状态。
- 当一个操作会打断当前界面，或者需要在后台运行，且耗时可能超过 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 } | - |
| trailColor | 未完成的分段的颜色 | string | - |
| type | 类型，可选 line circle dashboard |
string | line |
type="line"
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| steps | 进度条总共步数 | number | - | - |
| strokeColor | 进度条的色彩，传入 object 时为渐变。当有 steps 时支持传入一个数组。 |
string | string[] | { from: string; to: string; direction: string } | - | 4.21.0: string[] |
| strokeWidth | 进度条线的宽度，单位 px | number | 10 | - |
type="circle"
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| strokeColor | 圆形进度条线的色彩，传入 object 时为渐变 | string | object | - |
| strokeWidth | 圆形进度条线的宽度，单位是进度条画布宽度的百分比 | number | 6 |
| width | 圆形进度条画布宽度，单位 px | number | 132 |
type="dashboard"
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| gapDegree | 仪表盘进度条缺口角度，可取值 0 ~ 295 | number | 75 |
| gapPosition | 仪表盘进度条缺口位置 | top | bottom | left | right |
bottom |
| strokeWidth | 仪表盘进度条线的宽度，单位是进度条画布宽度的百分比 | number | 6 |
| width | 仪表盘进度条画布宽度，单位 px | number | 132 |