Skip to main content

Progress List

Ant Design

The Progress List component shows rows of labeled progress bars, such as budget used per team or progress toward each sales target.

Properties​

Property
Description
Expected Value
Data sourceRows to show, one bar each, such as the data from a query.Array
Label fieldField shown as each bar's label.Text. Default: label
Value fieldField with each row's value. Without a target, a plain number is read as the percent, or as a share of the largest value when Value format is number, currency or compact.Text. Default: value
Target fieldField with each row's target. The bar shows value divided by target.Text
Percent fieldField with the bar's fill as a fraction, such as 0.75 for 75%. It takes priority over value and target.Text
Caption fieldField shown as small text under the bar.Text
Status fieldField whose words color the bar, such as On track for green, At risk for amber and Over budget for red.Text
Value formatHow values and targets are written. percent reads 0.25 as 25%, and compact shortens large numbers to 12K or 1.2M.auto, number, currency, percent, compact. Default: auto
CurrencyCurrency code, such as USD or EUR, used when Value format is currency.Text. Default: USD
LocaleLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.Text
Id fieldField that identifies each row. It's read into selectedItemId.Text. Default: id
Auto toneColors bars by their percent. goal turns a bar green at 100%; limit turns it amber from 80% and red over 100%.none, goal, limit. Default: none
Show valuesShows each row's value, and its target when set, above the bar.On or off. Default: On
Show percentShows each row's percent above the bar.On or off. Default: On
SizeThickness of the bars.small, default, large. Default: default
BorderedDraws a border around the list.On or off. Default: Off
Empty textText shown when there are no rows.Text. Default: No data

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On item clickedTriggers when the user clicks a row to select it. Clicking the selected row again clears the selection without triggering the event.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Clear selectionClears the selected row.components.progresslist1.clearSelection()
Set visibilityShows the component when true, hides it when false.components.progresslist1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.progresslist1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.progresslist1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataSourceRows to show, one bar each, such as the data from a query.{{components.progresslist1.dataSource}}
labelFieldField shown as each bar's label.{{components.progresslist1.labelField}}
valueFieldField with each row's value. Without a target, a plain number is read as the percent, or as a share of the largest value when Value format is number, currency or compact.{{components.progresslist1.valueField}}
targetFieldField with each row's target. The bar shows value divided by target.{{components.progresslist1.targetField}}
percentFieldField with the bar's fill as a fraction, such as 0.75 for 75%. It takes priority over value and target.{{components.progresslist1.percentField}}
captionFieldField shown as small text under the bar.{{components.progresslist1.captionField}}
statusFieldField whose words color the bar, such as On track for green, At risk for amber and Over budget for red.{{components.progresslist1.statusField}}
valueFormatHow values and targets are written. percent reads 0.25 as 25%, and compact shortens large numbers to 12K or 1.2M.{{components.progresslist1.valueFormat}}
currencyCurrency code, such as USD or EUR, used when Value format is currency.{{components.progresslist1.currency}}
localeLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.{{components.progresslist1.locale}}
idFieldField that identifies each row. It's read into selectedItemId.{{components.progresslist1.idField}}
autoToneColors bars by their percent. goal turns a bar green at 100%; limit turns it amber from 80% and red over 100%.{{components.progresslist1.autoTone}}
showValuesShows each row's value, and its target when set, above the bar.{{components.progresslist1.showValues}}
showPercentShows each row's percent above the bar.{{components.progresslist1.showPercent}}
sizeThickness of the bars.{{components.progresslist1.size}}
borderedDraws a border around the list.{{components.progresslist1.bordered}}
emptyTextText shown when there are no rows.{{components.progresslist1.emptyText}}
selectedItemIdValue of Id field in the item the user clicked, or empty when nothing is selected.{{components.progresslist1.selectedItemId}}
selectedItemThe full data row of the item the user clicked, or {} when nothing is selected.{{components.progresslist1.selectedItem}}
selectedItemIndexPosition of the clicked item in Data source, counting from 0, or -1 when nothing is selected.{{components.progresslist1.selectedItemIndex}}
isVisibleWhether the component is visible.{{components.progresslist1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.progresslist1.isLoading}}
isDisabledWhether the component is disabled.{{components.progresslist1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.