Skip to main content

Progress List

Rocket 2.0

The Progress List component shows a list of items, each with a progress bar toward a target, such as budgets, sales quotas or project goals. Each row can add a status chip and a caption.

Properties​

Property
Description
Expected Value
DataRows to list, one bar per row.Array
Label fieldField shown as the name of each row.Text. Default: label
Value fieldField with the current amount, such as money spent.Text. Default: spent
Target fieldField with the amount to reach, such as the budget. The bar fills to the value as a share of the target.Text. Default: budget
Percent field (0 to 100; overrides value / target)Field with a ready-made percent from 0 to 100. When set, it fills the bar instead of Value field and Target field.Text
Caption field (a line under the bar)Field shown as a small line of text under the bar.Text. Default: note
Status field (a chip, or a tone name)Field shown as a colored chip next to the label. A tone name such as success or danger colors the bar without a chip.Text. Default: status
Value formatHow the value and target are written, such as plain numbers, currency, percent or short forms like 12K.Auto, Number, Currency, Percent, Compact. Default: Number
Currency (ISO code, e.g. USD)Currency code used when Value format is Currency, such as USD or EUR.Text. Default: USD
LocaleLocale used to format numbers and currency, such as en-US. Leave empty to follow the currency.Text
Id fieldField that identifies each row. It fills selectedItemId when the user clicks a row.Text. Default: id
Tone from progressColors bars by their percent when the row has no status. Goal turns a bar green at 100%; Limit turns it amber from 80% and red past 100%.None, Goal, Limit. Default: None
Show value of targetShows the value and the target as text, such as 18,400 of 25,000.On or off. Default: On
Show percentageShows each row's percent as a number.On or off. Default: On
Bar sizeThickness of the bars.Thin, Default, Thick. Default: Default
List styleCard draws the list in a bordered box; Plain shows the rows without one.Card, Plain. Default: Card
Empty textMessage shown when there are no rows.Text. Default: Nothing to track yet
Loading lookWhat shows while the list is loading: a spinner or skeleton rows.Spinner, Skeleton. Default: Spinner

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.

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
dataRows to list, one bar per row.{{components.progresslist1.data}}
labelFieldField shown as the name of each row.{{components.progresslist1.labelField}}
valueFieldField with the current amount, such as money spent.{{components.progresslist1.valueField}}
targetFieldField with the amount to reach, such as the budget. The bar fills to the value as a share of the target.{{components.progresslist1.targetField}}
percentFieldField with a ready-made percent from 0 to 100. When set, it fills the bar instead of Value field and Target field.{{components.progresslist1.percentField}}
captionFieldField shown as a small line of text under the bar.{{components.progresslist1.captionField}}
statusFieldField shown as a colored chip next to the label. A tone name such as success or danger colors the bar without a chip.{{components.progresslist1.statusField}}
valueFormatHow the value and target are written, such as plain numbers, currency, percent or short forms like 12K.{{components.progresslist1.valueFormat}}
currencyCurrency code used when Value format is Currency, such as USD or EUR.{{components.progresslist1.currency}}
localeLocale used to format numbers and currency, such as en-US. Leave empty to follow the currency.{{components.progresslist1.locale}}
idFieldField that identifies each row. It fills selectedItemId when the user clicks a row.{{components.progresslist1.idField}}
autoToneColors bars by their percent when the row has no status. Goal turns a bar green at 100%; Limit turns it amber from 80% and red past 100%.{{components.progresslist1.autoTone}}
showValuesShows the value and the target as text, such as 18,400 of 25,000.{{components.progresslist1.showValues}}
showPercentShows each row's percent as a number.{{components.progresslist1.showPercent}}
barSizeThickness of the bars.{{components.progresslist1.barSize}}
listStyleCard draws the list in a bordered box; Plain shows the rows without one.{{components.progresslist1.listStyle}}
emptyTextMessage shown when there are no rows.{{components.progresslist1.emptyText}}
loadingIndicatorWhat shows while the list is loading: a spinner or skeleton rows.{{components.progresslist1.loadingIndicator}}
selectedItemThe data row the user clicked last.{{components.progresslist1.selectedItem}}
selectedItemIdThe id of the clicked row, from Id field.{{components.progresslist1.selectedItemId}}
selectedItemIndexThe position of the clicked row in the data, starting at 0, or -1 when none 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
List backgroundTheme: Surface 1
Border and divider colorTheme: Default border
Label and value colorTheme: Primary text
Caption colorTheme: Placeholder text
Bar color (rows without a tone)Theme: Brand primary
Bar track colorTheme: Primary text
List radius—
Label typefaceTheme font
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.