Progress
The <Progress> component is used to provide a progress indicator that displays the progress of content loading or an operation.
NOTE
This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
Child Components
Not supported
APIs
Progress(options: {value: number, total?: number, type?: ProgressType})
Creates a progress indicator.
Since API version 9, this API is supported in ArkTS widgets.
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
value | number | Yes | Current progress. If the value is less than 0, the value 0 is used. If the value is greater than that of total, the value of total is used. Since API version 9, this API is supported in ArkTS widgets. |
total | number | No | Total progress. Default value: 100 Since API version 9, this API is supported in ArkTS widgets. |
type8+ | ProgressType | No | Style the progress indicator. Default value: ProgressType.Linear Since API version 9, this API is supported in ArkTS widgets. |
styledeprecated | ProgressStyle | No | Type of the progress indicator. This parameter is deprecated since API version 8. You are advised to use type instead. Default value: ProgressStyle.Linear |
ProgressType
Since API version 9, this API is supported in ArkTS widgets.
Name | Description |
---|---|
Linear | Linear type. Since API version 9, the progress indicator adaptively switches to vertical layout if the height is greater than the width. |
Ring8+ | Indeterminate ring type. The ring fills up as the progress increases. |
Eclipse8+ | Eclipse type, which visualizes the progress in a way similar to the moon waxing from new to full. |
ScaleRing8+ | Determinate ring type, which is similar to the clock scale. Since API version 9, when the outer circles of scales overlap, the progress indicator is automatically converted to the Ring type. |
Capsule8+ | Capsule type. At both ends, the progress indicator works in a same manner as the eclipse type. In the middle part of the capsule, the progress indicator works in a same manner as the linear type. If the height is greater than the width, the progress indicator adaptively switches to vertical layout. |
ProgressStyle
Since API version 9, this API is supported in ArkTS widgets.
Name | Description |
---|---|
Linear | Linear type. |
Ring | Indeterminate ring type. The ring fills up as the progress increases. |
Eclipse | Eclipse type, which visualizes the progress in a way similar to the moon waxing from new to full. |
ScaleRing | Determinate ring type, which is similar to the clock scale. |
Capsule | Capsule type. At both ends, the progress indicator works in a same manner as the eclipse type. In the middle part of the capsule, the progress indicator works in a same manner as the linear type. If the height is greater than the width, the progress indicator adaptively switches to vertical layout. |
Attributes
Name | Type | Description |
---|---|---|
value | number | Current progress. If the value is less than 0, the value 0 is used. If the value is greater than that of total, the value of total is used. Invalid values do not take effect. Since API version 9, this API is supported in ArkTS widgets. |
color | ResourceColor | Background color of the progress indicator. Since API version 9, this API is supported in ArkTS widgets. |
backgroundColor | ResourceColor | Background color of the progress indicator. Since API version 9, this API is supported in ArkTS widgets. |
style8+ | { strokeWidth?: Length, scaleCount?: number, scaleWidth?: Length } |
Component style. - strokeWidth: stroke width of the progress indicator. It cannot be set in percentage. Since API version 9, if the stroke width of the ring progress bar is greater than or equal to the radius, the width is changed to half of the radius. Default value: 4.0Vp - scaleCount: number of divisions on the determinate ring-type process indicator. Default value: 120 - scaleWidth: scale width of the ring progress bar. It cannot be set in percentage. If it is greater than the value of strokeWidth, the default scale width is used. Default value: 2.0Vp Since API version 9, this API is supported in ArkTS widgets. |
Events
The universal events are supported.
Example
// xxx.ets
@Entry
@Component
struct ProgressExample {
build() {
Column({ space: 15 }) {
Text('Linear Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
Progress({ value: 10, type: ProgressType.Linear }).width(200)
Progress({ value: 20, total: 150, type: ProgressType.Linear }).color(Color.Grey).value(50).width(200)
Text('Eclipse Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
Row({ space: 40 }) {
Progress({ value: 10, type: ProgressType.Eclipse }).width(100)
Progress({ value: 20, total: 150, type: ProgressType.Eclipse }).color(Color.Grey).value(50).width(100)
}
Text('ScaleRing Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
Row({ space: 40 }) {
Progress({ value: 10, type: ProgressType.ScaleRing }).width(100)
Progress({ value: 20, total: 150, type: ProgressType.ScaleRing })
.color(Color.Grey).value(50).width(100)
.style({ strokeWidth: 15, scaleCount: 15, scaleWidth: 5 })
}
// scaleCount vs. scaleWidth
Row({ space: 40 }) {
Progress({ value: 20, total: 150, type: ProgressType.ScaleRing })
.color(Color.Grey).value(50).width(100)
.style({ strokeWidth: 20, scaleCount: 20, scaleWidth: 5 })
Progress({ value: 20, total: 150, type: ProgressType.ScaleRing })
.color(Color.Grey).value(50).width(100)
.style({ strokeWidth: 20, scaleCount: 30, scaleWidth: 3 })
}
Text('Ring Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
Row({ space: 40 }) {
Progress({ value: 10, type: ProgressType.Ring }).width(100)
Progress({ value: 20, total: 150, type: ProgressType.Ring })
.color(Color.Grey).value(50).width(100)
.style({ strokeWidth: 20, scaleCount: 30, scaleWidth: 20 })
}
Text('Capsule Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
Row({ space: 40 }) {
Progress({ value: 10, type: ProgressType.Capsule }).width(100).height(50)
Progress({ value: 20, total: 150, type: ProgressType.Capsule })
.color(Color.Grey)
.value(50)
.width(100)
.height(50)
}
}.width('100%').margin({ top: 30 })
}
}