2016-07-26 15:42:04 +08:00
---
category: Components
2016-11-09 14:43:32 +08:00
type: Feedback
2016-07-26 15:42:04 +08:00
title: Progress
---
2017-09-11 10:13:21 +08:00
Display the current progress of an operation flow.
2016-07-26 15:42:04 +08:00
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-26 15:42:04 +08:00
2017-09-11 10:13:21 +08:00
If it will take a long time to complete an operation, you can use `Progress` to show the current progress and status.
2016-07-26 15:42:04 +08:00
- When an operation will interrupt the current interface, or it needs to run in the background for more than 2 seconds.
- When you need to display the completion percentage of an operation.
## API
2019-01-29 15:23:23 +08:00
Properties that shared by all types.
2019-11-20 17:46:50 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| type | to set the type, options: `line` `circle` `dashboard` | string | `line` |
| format | template function of the content | function(percent, successPercent) | `percent => percent + '%'` |
| percent | to set the completion percentage | number | 0 |
| showInfo | whether to display the progress value and the status icon | boolean | true |
| status | to set the status of the Progress, options: `success` `exception` `normal` `active` (line only) | string | - |
2020-01-17 17:23:48 +08:00
| strokeLinecap | to set the style of the progress linecap | `round` \| `square` | `round` |
2019-11-20 17:46:50 +08:00
| strokeColor | color of progress bar | string | - |
| successPercent | segmented success percent | number | 0 |
2019-01-29 15:23:23 +08:00
### `type="line"`
2019-11-20 17:46:50 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| strokeWidth | to set the width of the progress bar, unit: `px` | number | 10 |
| strokeColor | color of progress bar, render `linear-gradient` when passing an object | string \| { from: string; to: string; direction: string } | - |
2019-11-22 10:46:33 +08:00
| steps | the total step count | number | - |
2019-01-29 15:23:23 +08:00
### `type="circle"`
2019-11-20 17:46:50 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| width | to set the canvas width of the circular progress, unit: `px` | number | 132 |
| strokeWidth | to set the width of the circular progress, unit: percentage of the canvas width | number | 6 |
| strokeColor | color of circular progress, render `linear-gradient` when passing an object | string \| object | - |
2019-01-29 15:23:23 +08:00
### `type="dashboard"`
2019-11-20 17:46:50 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| width | to set the canvas width of the dashboard progress, unit: `px` | number | 132 |
| strokeWidth | to set the width of the dashboard progress, unit: percentage of the canvas width | number | 6 |
| gapDegree | the gap degree of half circle, 0 ~ 360 | number | 0 |
| gapPosition | the gap position, options: `top` `bottom` `left` `right` | string | `top` |
