jc-progress-bar
The schema defines the following properties:
Property | Type | Required | Description |
type | component.progress-bar | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | |
options | Progress Bar Options | true | |
Properties of the options object:
Property | Type | Required | Description |
size | tiny | small | medium | large | extra-large | string | false | Size of the progress bar |
value | Value | true | |
color | ColorOrConditionalColor | false | Color of the progress bar |
steps | number | string | false | Number of steps will split the progress bar into sections. The maximum amount is 20. |
style | Style | false | |
title | Title | false | Title of the progress bar |
subtitle | Subtitle | false | Subtitle of the progress bar |
errorText | string | Expression | TextWithFormat | TextLocale | false | Error text of the progress bar |
helperText | string | Expression | TextWithFormat | TextLocale | false | Helper text of the progress bar |
onPress | false | Action to be executed when the progress bar is pressed |
Size of the progress bar
The object must be any of the following types:
Properties of the value object:
Property | Type | Required | Description |
current | number | string | true | Current value of the progress bar |
max | number | string | true | Max value of the progress bar |
Current value of the progress bar
The object must be any of the following types:
Max value of the progress bar
The object must be any of the following types:
Color of the progress bar
Number of steps will split the progress bar into sections. The maximum amount is 20.
The object must be any of the following types:
Default: 1
Properties of the style object:
Property | Type | Required | Description |
isDisabled | boolean | string | false | If true, the progress bar will be disabled |
If true, the progress bar will be disabled
The object must be any of the following types:
Title of the progress bar
Properties of the title object:
Property | Type | Required | Description |
value | string | Expression | TextWithFormat | TextLocale | true | Text of the title |
align | left | right | center | string | false | Alignment of the title |
position | top | bottom | string | false | Position of the title |
color | ColorOrConditionalColor | false | Color of the title |
Text of the title
Alignment of the title
The object must be any of the following types:
Position of the title
The object must be any of the following types:
Default: "top"
Color of the title
Subtitle of the progress bar
Properties of the subtitle object:
Property | Type | Required | Description |
value | string | Expression | TextWithFormat | TextLocale | true | Text of the subtitle |
align | left | right | center | string | false | Alignment of the subtitle |
color | ColorOrConditionalColor | false | Color of the subtitle |
position | top | bottom | string | false | Position of the subtitle |
Text of the subtitle
Alignment of the subtitle
The object must be any of the following types:
Default: "left"
Color of the subtitle
Position of the subtitle
The object must be any of the following types:
Default: "top"
Error text of the progress bar
Helper text of the progress bar
Action to be executed when the progress bar is pressed
The schema defines the following additional types:
The object must be any of the following types:
The object is an array with all elements of the type object.
The array object has the following properties:
This element must be one of the following enum values:
- color1
- color2
- color3
- color4
- color5
- color6
- color7
- color8
- color9
- color10
- color11
- color12
- color13
- color14
This element must be one of the following enum values:
- positive
- negative
- warning
![Doc contributor](https://s3.amazonaws.com/archbee-animals/rabbit.png)