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
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
To display the current progress of an operation flow.
|
|
|
|
|
|
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 the operation, you can use `Progress` to show the current progress and status.
|
|
|
|
|
|
|
|
|
|
- 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
|
|
|
|
|
-----|-----|-----|------
|
2017-03-17 23:57:34 +08:00
|
|
|
type | to set the type, options: `line` `circle` `dashboard`| string | line
|
2017-01-20 20:10:50 +08:00
|
|
|
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 + '%'`
|
2017-01-20 20:10:50 +08:00
|
|
|
status | to set the status of the progress, options: `success` `exception` `active` | string | -
|
|
|
|
|
showInfo | determine 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 | Enum{ 'top', 'bottom', 'left', 'right' } | `top`
|
2016-07-26 15:42:04 +08:00
|
|
|
|
