Skip to main content

Record List

Rocket 2.0

The Record List component shows rows of data as a compact list, each with an avatar, a title, a line of details, a status chip and a value on the right. Use it for invoices, customers, tickets or any records the user picks from.

Properties​

Property
Description
Expected Value
DataRows to list, one item per row.Array
Title fieldField shown as the bold title of each item.Text. Default: customer
Avatar field (image URL or a name; empty uses the title)Field with an image URL, or a name to show as initials. Leave empty to use the initials of the title.Text
Meta fields (comma list; 'total|currency', 'due|date:Due {}')Comma-separated fields shown on the line under the title. Add a format after a pipe (total|currency, due|date) and a label after a colon, where {} marks the value (due|date:Due {}).Text. Default: contact, due|date:Due {}
Status field (a chip toned by its words)Field shown as a chip. Common words such as Paid or Overdue get a matching color.Text. Default: status
Progress field (a percentage, 0 to 100)Field with a percent from 0 to 100, shown as a small progress bar.Text
Trailing value fieldField shown on the right of each item, such as an amount.Text. Default: total
Trailing value formatHow the value on the right is written, such as currency, a short number like 12K, or a date.auto, number, currency, percent, compact, date, datetime. Default: currency
Currency (ISO code, e.g. USD)Currency code used when a value is formatted as currency, such as USD or EUR.Text. Default: USD
LocaleLocale used to format numbers, currency and dates, such as en-US. Leave empty to follow the currency.Text
Status colorsA color for each status value, for example { "Paid": "#16a34a" }. Overrides the automatic color.Object
Id fieldField that identifies each row. It fills selectedItemId when the user clicks an item.Text. Default: id
Show avatarShows the avatar at the start of each item.On or off. Default: On
Avatar shapeShape of the avatars.circle, rounded. Default: circle
DensitySpacing of the items, from compact to comfortable.compact, default, comfortable. Default: default
Show dividersDraws a line between items.On or off. Default: On
List styleCard draws the list in a bordered box; Plain shows the items without one.card, plain. Default: card
Highlight the selected rowMarks the clicked item as selected. Clicking it again clears the selection.On or off. Default: On
Empty textMessage shown when there are no rows.Text. Default: Nothing here 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 an item.

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 item.components.recordlist1.clearSelection()
Set visibilityShows the component when true, hides it when false.components.recordlist1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.recordlist1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.recordlist1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataRows to list, one item per row.{{components.recordlist1.data}}
titleFieldField shown as the bold title of each item.{{components.recordlist1.titleField}}
avatarFieldField with an image URL, or a name to show as initials. Leave empty to use the initials of the title.{{components.recordlist1.avatarField}}
metaFieldsComma-separated fields shown on the line under the title. Add a format after a pipe (total|currency, due|date) and a label after a colon, where {} marks the value (due|date:Due {}).{{components.recordlist1.metaFields}}
statusFieldField shown as a chip. Common words such as Paid or Overdue get a matching color.{{components.recordlist1.statusField}}
progressFieldField with a percent from 0 to 100, shown as a small progress bar.{{components.recordlist1.progressField}}
valueFieldField shown on the right of each item, such as an amount.{{components.recordlist1.valueField}}
valueFormatHow the value on the right is written, such as currency, a short number like 12K, or a date.{{components.recordlist1.valueFormat}}
currencyCurrency code used when a value is formatted as currency, such as USD or EUR.{{components.recordlist1.currency}}
localeLocale used to format numbers, currency and dates, such as en-US. Leave empty to follow the currency.{{components.recordlist1.locale}}
statusColorsA color for each status value, for example { "Paid": "#16a34a" }. Overrides the automatic color.{{components.recordlist1.statusColors}}
idFieldField that identifies each row. It fills selectedItemId when the user clicks an item.{{components.recordlist1.idField}}
showAvatarShows the avatar at the start of each item.{{components.recordlist1.showAvatar}}
avatarShapeShape of the avatars.{{components.recordlist1.avatarShape}}
densitySpacing of the items, from compact to comfortable.{{components.recordlist1.density}}
showDividersDraws a line between items.{{components.recordlist1.showDividers}}
listStyleCard draws the list in a bordered box; Plain shows the items without one.{{components.recordlist1.listStyle}}
highlightSelectedMarks the clicked item as selected. Clicking it again clears the selection.{{components.recordlist1.highlightSelected}}
emptyTextMessage shown when there are no rows.{{components.recordlist1.emptyText}}
loadingIndicatorWhat shows while the list is loading: a spinner or skeleton rows.{{components.recordlist1.loadingIndicator}}
selectedItemIdThe id of the selected item, from Id field.{{components.recordlist1.selectedItemId}}
selectedItemThe data row of the selected item.{{components.recordlist1.selectedItem}}
selectedItemIndexThe position of the selected item in the data, starting at 0, or -1 when none is selected.{{components.recordlist1.selectedItemIndex}}
isVisibleWhether the component is visible.{{components.recordlist1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.recordlist1.isLoading}}
isDisabledWhether the component is disabled.{{components.recordlist1.isDisabled}}

Styles​

Style
Default
List backgroundTheme: Surface 1
Border and divider colorTheme: Default border
Title and value colorTheme: Primary text
Meta line colorTheme: Placeholder text
Selected row accentTheme: Brand primary
List radius—
Title 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.