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.
|
|
|
|
|
|
2017-10-25 10:25:44 +08:00
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| -------- | ----------- | ---- | ------- |
|
2019-01-29 15:23:23 +08:00
|
|
|
| type | to set the type, options: `line` `circle` `dashboard` | string | `line` |
|
2018-04-22 14:00:49 +08:00
|
|
|
| format | template function of the content | function(percent, successPercent) | `percent => percent + '%'` |
|
2017-10-25 10:25:44 +08:00
|
|
|
| percent | to set the completion percentage | number | 0 |
|
|
|
|
|
| showInfo | whether to display the progress value and the status icon | boolean | true |
|
2018-12-04 21:42:04 +08:00
|
|
|
| status | to set the status of the Progress, options: `success` `exception` `active` `normal` | string | - |
|
2018-08-01 00:19:06 +08:00
|
|
|
| strokeLinecap | to set the style of the progress linecap | Enum{ 'round', 'square' } | `round` |
|
2018-06-06 16:18:00 +08:00
|
|
|
| strokeColor | color of progress bar | string | - |
|
2019-01-18 15:19:36 +08:00
|
|
|
| successPercent | segmented success percent | number | 0 |
|
2019-01-29 15:23:23 +08:00
|
|
|
|
|
|
|
|
### `type="line"`
|
|
|
|
|
|
|
|
|
|
| strokeWidth | to set the width of the progress bar, unit: `px` | number | 10 |
|
|
|
|
|
|
|
|
|
|
### `type="circle"`
|
|
|
|
|
|
|
|
|
|
| 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 |
|
|
|
|
|
|
|
|
|
|
### `type="dashboard"`
|
|
|
|
|
|
|
|
|
|
| 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` |
|
