2016-07-26 15:42:04 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Feedback
2016-07-26 15:42:04 +08:00
title: Progress
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*gK_4S6fDRfgAAAAAAAAAAAAADrJ8AQ/original
2023-02-09 22:17:31 +08:00
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*HJH8Tb1lcYAAAAAAAAAAAAAADrJ8AQ/original
2022-11-09 12:28:04 +08:00
demo:
cols: 2
2016-07-26 15:42:04 +08:00
---
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.
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/line.tsx" > Progress bar< / code >
< code src = "./demo/circle.tsx" > Circular progress bar< / code >
< code src = "./demo/line-mini.tsx" > Mini size progress bar< / code >
< code src = "./demo/circle-micro.tsx" > Responsive circular progress bar< / code >
< code src = "./demo/circle-mini.tsx" > Mini size circular progress bar< / code >
< code src = "./demo/circle-dynamic.tsx" > Dynamic circular progress bar< / code >
< code src = "./demo/dynamic.tsx" > Dynamic< / code >
< code src = "./demo/format.tsx" > Custom text format< / code >
< code src = "./demo/dashboard.tsx" > Dashboard< / code >
< code src = "./demo/segment.tsx" > Progress bar with success segment< / code >
< code src = "./demo/linecap.tsx" > Stroke Linecap< / code >
< code src = "./demo/gradient-line.tsx" > Custom line gradient< / code >
< code src = "./demo/steps.tsx" > Progress bar with steps< / code >
2023-03-01 11:49:42 +08:00
< code src = "./demo/size.tsx" > Progress size< / code >
2022-11-09 12:28:04 +08:00
2016-07-26 15:42:04 +08:00
## API
2019-01-29 15:23:23 +08:00
Properties that shared by all types.
2023-03-01 11:49:42 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| format | The template function of the content | function(percent, successPercent) | (percent) => percent + `%` | - |
| percent | To set the completion percentage | number | 0 | - |
2022-11-17 17:31:26 +08:00
| 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 | - |
2023-03-01 11:49:42 +08:00
| strokeColor | The color of progress bar | string | - | - |
| strokeLinecap | To set the style of the progress linecap | `round` \| `butt` \| `square` , see [stroke-linecap ](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap ) | `round` | - |
| success | Configs of successfully progress bar | { percent: number, strokeColor: string } | - | - |
| trailColor | The color of unfilled part | string | - | - |
2022-11-17 17:31:26 +08:00
| type | To set the type, options: `line` `circle` `dashboard` | string | `line` |
2023-06-20 22:08:25 +08:00
| size | Progress size | number \| \[number \| string, number] \| "small" \| "default" | "default" | v5.3.0 |
2019-01-29 15:23:23 +08:00
### `type="line"`
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| steps | The total step count | number | - | - |
| strokeColor | The color of progress bar, render `linear-gradient` when passing an object, could accept `string[]` when has `steps` . | string \| string[] \| { from: string; to: string; direction: string } | - | 4.21.0: `string[]` |
2019-01-29 15:23:23 +08:00
### `type="circle"`
2023-03-01 11:49:42 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| strokeColor | The color of circular progress, render `linear-gradient` when passing an object | string \| object | - | - |
| strokeWidth | To set the width of the circular progress, unit: percentage of the canvas width | number | 6 | - |
2019-01-29 15:23:23 +08:00
### `type="dashboard"`
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| gapDegree | The gap degree of half circle, 0 ~ 295 | number | 75 |
| gapPosition | The gap position, options: `top` `bottom` `left` `right` | string | `bottom` |
| strokeWidth | To set the width of the dashboard progress, unit: percentage of the canvas width | number | 6 |
2023-04-11 10:25:24 +08:00
## Design Token
< ComponentTokenTable component = "Progress" > < / ComponentTokenTable >