Progress Bar Component (a!progressBarField)

Display

Progress Bar Component

Function

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.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Instructions	`instructions`	Text	Supplemental text about this field.
Percentage	`percentage`	Number (Integer)	Number to display between 0 and 100.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Help Tooltip	`helpTooltip`	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 `"COLLAPSED"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Color	`color`	Text	Determines the color. Valid values: Any valid hex color or `"ACCENT"` (default), `"POSITIVE"`, `"NEGATIVE"`, `"WARN"`.
Visibility	`showWhen`	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	`style`	Text	Thickness of the progress bar. Valid values: `"THIN"` (default), `"THICK"`.
Show Percentage	`showPercentage`	Boolean	Determines whether the progress bar displays the percentage. Default: true.
Margin Above	`marginAbove`	Text	Determines how much space is added above the layout. Valid values: `"NONE"` (default), `"EVEN_LESS"`, `"LESS"`, `"STANDARD"`, `"MORE"`, `"EVEN_MORE"`.
Margin Below	`marginBelow`	Text	Determines how much space is added below the layout. Valid values: `"NONE"`, `"EVEN_LESS"`, `"LESS"`, `"STANDARD"` (default), `"MORE"`, `"EVEN_MORE"`.

Usage considerations

Using the percentage parameter

If an expression for the percentage parameter results in a decimal number, the system automatically casts the value to an integer.
If the percentage parameter is negative or null, the bar renders with 0% filled and displays the provided percentage as a label on the bar.
If the percentage parameter is greater than 100, the bar renders with 100% filled and displays the provided percentage as a label on the bar.

Bar thickness

We recommend you use thin styling on the progress bar when working with a small space on an interface, such as within grids.

Examples

Use the interactive editor below to test out your code:

Thick progress bar with details

Thin progress bar with color based on value

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

Progress Bar Component