ant-design/components/progress/index.en-US.md

31 lines
1.4 KiB
Markdown
Raw Normal View History

2016-07-26 15:42:04 +08:00
---
category: Components
type: Feedback
2016-07-26 15:42:04 +08:00
title: Progress
---
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
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
Property | Description | Type | Default
-----|-----|-----|------
type | to set the type, options: `line` `circle` `dashboard`| string | `line`
percent | to set the completion percentage | number | 0
2016-07-26 15:42:04 +08:00
format | template function of the content | function(percent) | `percent => percent + '%'`
status | to set the status of the Progress, options: `success` `exception` `active` | string | -
showInfo | whether to display the progress value and the status icon | boolean | true
strokeWidth `(type=line)` | to set the width of the progress bar, unit: `px` | number | 10
strokeWidth `(type=circle)` | to set the width of the circular progress bar, unit: percentage of the canvas width | number | 6
width `(type=circle)` | to set the canvas width of the circular progress bar, unit: `px` | number | 132
2017-07-07 14:18:57 +08:00
gapDegree `(type=circle)` | the gap degree of half circle, 0 ~ 360 | number | 0
gapPosition `(type=circle)` | the gap position, options: `top` `bottom` `left` `right` | string | `top`
2016-07-26 15:42:04 +08:00