Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Component properties for the Object list

Component property enables you to configure the behavior of the Object list component on a third-party website.

Component propertyDescription
TypeAll Records shows the complete list with options to edit, filter, and take bulk actions. Top Records shows a prioritized, read-only list with a view all link.
TableTable data to display in the list.
Edit queryQuery filters to refine the list results. These filters cannot be modified.
Edit default filterUsers can edit or remove this filter. When a query is set, it adds more conditions to narrow down the displayed records.
ColumnsSelect columns to be displayed. If both columns and List view are chosen, columns take priority.
List viewUses preconfigured columns from the UI view table. If both columns and a list view are selected, columns take priority.
Nest byColumn used to define the hierarchy. If this property is not set, the list is displayed as a flat list.
Default group byGroup records by a specific column. User can choose to group by another column.
Hide when emptyEnable to hide the component when there are no records to show for the user.
Component propertyDescription
Hide headerOption to show or hide the header.
TitleDisplays the title of the list. You can set a custom title or use the table name as the default title.
SubtitleSubtitle to display near the title. When empty, no subtitle will be displayed.
Hide record countOption to show or hide the count badge on the header.
Hide searchOption to show or hide the search bar. Search works only for indexed tables.
Hide filtersOption to show or hide the filter with condition-builder.
Disable column selectionOption to disable or enable column selection and arrangement.
Hide actionsOption to show or hide the action buttons.
Action configGlobal actions and actions set at the table or view level will automatically be displayed.To display additional actions specific to this component, select an Action Config record.
Component propertyDescription
Disable clickable recordsWhen unchecked, values in the first column appear as clickable links to open record details.
Enable clickable reference recordsWhen checked, values in the reference column appear as clickable links to open the related record details.
Disable column highlightingWhen unchecked, column values are highlighted.
Highlighted value configSelect UX Highlighted Value Configuration record that defines which fields and values to highlight.
Component propertyDescription
Disable quick editWhen unchecked, users with required permissions can edit the records.
Component propertyDescription
Disable cell wrappingWhen unchecked, automatically moves content to a new line within a cell when it exceeds the cell’s width. Long text may still be truncated.
Max cell charactersDisplays number of characters in each cell before truncation.
Disable cell editingOption to allow inline editing of cell.
Component propertyDescription
Records per pageAllows user to choose the number of records displayed on each page.
Visible page rangeSets how many page numbers are shown between navigation arrows.
Limit records fetchedLimit the total records fetched across all pages to improve component performance. Higher values may increase load times. Leave it empty to fetch all records.
Hide errorsOption to show or hide the error messages from end user when the component fails to load initially.

Related topics

Configure the Object list component instance

Embed the Object list component on the third-party website

Event handlers in the Object list component

Sample code for the Object list component