a!progressBarField( label, instructions, percentage, labelPosition, helpTooltip, accessibilityText, color, showWhen, style, showPercentage, marginAbove, marginBelow )
Displays a completion percentage, such as receiving all the necessary approval tasks, completing a certain number of on-boarding processes, or completing a single process. Similar to the Gauge, but with a bar style rather than a circular style.
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Instructions |
|
Text |
Supplemental text about this field. |
Percentage |
|
Number (Integer) |
Number to display between 0 and 100. |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Help Tooltip |
|
Text |
Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Color |
|
Text |
Determines the color. Valid values: Any valid hex color or |
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Style |
|
Text |
Thickness of the progress bar. Valid values: |
Show Percentage |
|
Boolean |
Determines whether the progress bar displays the percentage. Default: true. |
Margin Above |
|
Text |
Determines how much space is added above the layout. Valid values: |
Margin Below |
|
Text |
Determines how much space is added below the layout. Valid values: |
Use the interactive editor below to test out your code:
Feature | Compatibility | Note |
---|---|---|
Portals | Compatible | |
Offline Mobile | Compatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Progress Bar Component