javascript/element-plus
1
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2026-03-13 07:51:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): [progress] use new display tag (#14956)

Browse Source 
* docs(components): [progress] use new display tag

* docs(components): [progress] add type th for slots

* docs(components): [progress] fix format error
This commit is contained in:
wzc520pyfm
2023-12-04 21:22:10 +08:00
committed by GitHub
parent e14fcf65ac
commit 69a4af072d
1 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/en-US/component/progress.md
View File

@@ -81,25 +81,25 @@ progress/striped-progress
### Attributes
| Name | Description | Type | Default |
| --------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| percentage | percentage, **required** | ^[number]`(0-100)` | 0 |
| type | the type of progress bar | ^[enum]`'line' \| 'circle' \| 'dashboard'` | line |
| stroke-width | the width of progress bar | ^[number] | 6 |
| text-inside | whether to place the percentage inside progress bar, only works when `type` is 'line' | ^[boolean] | false |
| status | the current status of progress bar | ^[enum]`'success' \| 'exception' \| 'warning'` | — |
| indeterminate | set indeterminate progress | ^[boolean] | false |
| duration | control the animation duration of indeterminate progress or striped flow progress | ^[number] | 3 |
| color | background color of progress bar. Overrides `status` prop | ^[string] / ^[function]`(percentage: number) => string` / ^[Array]`{ color: string; percentage: number }[]` | '' |
| width | the canvas width of circle progress bar | ^[number] | 126 |
| show-text | whether to show percentage | ^[boolean] | true |
| stroke-linecap | circle/dashboard type shape at the end path | ^[enum]`'butt' \| 'round' \| 'square'` | round |
| format | custom text format | ^[Function]`(percentage: number) => string` | — |
| striped ^(2.3.4) | stripe over the progress bar's color | ^[boolean] | false |
| striped-flow ^(2.3.4) | get the stripes to flow | ^[boolean] | false |
| Name | Description | Type | Default |
| ---------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| percentage ^(required) | percentage | ^[number]`(0-100)` | 0 |
| type | the type of progress bar | ^[enum]`'line' \| 'circle' \| 'dashboard'` | line |
| stroke-width | the width of progress bar | ^[number] | 6 |
| text-inside | whether to place the percentage inside progress bar, only works when `type` is 'line' | ^[boolean] | false |
| status | the current status of progress bar | ^[enum]`'success' \| 'exception' \| 'warning'` | — |
| indeterminate | set indeterminate progress | ^[boolean] | false |
| duration | control the animation duration of indeterminate progress or striped flow progress | ^[number] | 3 |
| color | background color of progress bar. Overrides `status` prop | ^[string] / ^[function]`(percentage: number) => string` / ^[Array]`{ color: string; percentage: number }[]` | '' |
| width | the canvas width of circle progress bar | ^[number] | 126 |
| show-text | whether to show percentage | ^[boolean] | true |
| stroke-linecap | circle/dashboard type shape at the end path | ^[enum]`'butt' \| 'round' \| 'square'` | round |
| format | custom text format | ^[Function]`(percentage: number) => string` | — |
| striped ^(2.3.4) | stripe over the progress bar's color | ^[boolean] | false |
| striped-flow ^(2.3.4) | get the stripes to flow | ^[boolean] | false |
### Slots
| Name | Description |
| ------- | ------------------------------------------------- |
| default | Customized content, parameter is `{ percentage }` |
| Name | Description | Type |
| ------- | ------------------ | --------------------------------- |
| default | Customized content | ^[object]`{ percentage: number }` |