mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-26 04:00:13 +08:00
0519111a99
* fix: gapDegree=0 in Dashboard progress is now working * update jest snapshot for Progress * Add use case of gapDegree and test cases. Also doc error correction
2.4 KiB
2.4 KiB
| category | subtitle | type | title |
|---|---|---|---|
| Components | 进度条 | 反馈 | Progress |
展示操作的当前进度。
何时使用
在操作需要较长时间才能完成时，为用户显示该操作的当前进度和状态。
- 当一个操作会打断当前界面，或者需要在后台运行，且耗时可能超过 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 |