List

Backing view/query and the fields used for row identity and workflow state. Most other options depend on a chosen view.

View NamerequiredTextInside `dataSource`

Database view that supplies rows or form data.

Default: none

Identifier NameoptionalTextInside `dataSource`

Primary-key field used to load a single record (edit/detail).

Default: none

State Column NameoptionalTextInside `dataSource`

Optional workflow/state column. When set, per-row metadata (permissions/state) is resolved from metadata.rows[stateValue].

Default: none

Maps foreign-key columns on the source view to another view so row-template expressions can resolve readable values.

ReferencesoptionalKey-value mapInside `dataSource`

Map of source foreign-key field → { viewName, identifierName }. Loaded reference rows are exposed to the row template as props.references.

Good to know

• Key each entry by the foreign-key column name on the list’s source view.
• The reference loads the related row; the display field is chosen in the row template expression.

Avoid

• Do not expect References alone to pick the label column — bind props.references[“airline_id”][“airline_name”] (or similar) in the row grid.

Example { "airline_id": { "viewName": "v_airline", "identifierName": "airline_id" } }

Default: none

Whether rows are selectable, whether the first row is selected after load, and single vs multi select.

Can Select RowoptionalYes / no

Allows the user to select a single table row.

Good to know

• Enable only when another element or action reads the selection.

Default: none

First Row SelectedoptionalYes / no

After each load, selects the first row when selection is enabled so a detail panel always has a current record.

Good to know

• Only active when canSelectRow is true.

Avoid

• Avoid on destructive workflows where an implicit selection may surprise the user.

Default: none

Can Select Multiple RowsoptionalYes / no

Allows multi-row selection in the table.

Good to know

• Only active when canSelectRow is true.

Avoid

• Do not enable multi-select if consumers only understand a single current row.

Default: none

Initial page size and the page-size choices shown in the list footer.

Default Rows per PageoptionalNumber

Initial page size used when the list loads (footer page-size control).

Avoid

• Avoid very large defaults for heavy views or narrow layouts.

Default: none

Rows per PageoptionalList of Number

Page-size options offered in the list footer. Defaults to [10, 25, 50, 100, 1000] when omitted.

Example [10, 25, 50, 100, 1000]

Default: none

Initial sort applied when the list loads. List has no clickable column headers — this is the main way to control order.

Default SortoptionalList of Settings group

Initial sort clauses (fieldName + asc). Earlier entries win; later entries break ties. List has no interactive column headers, so this largely defines order.

Good to know

• Pick business-meaningful fields so the first page is predictable.

Avoid

• Do not rely on undefined database order for important work queues.

Example [{ "fieldName": "status", "asc": true, "hidden": true }, { "fieldName": "created_at", "asc": false, "hidden": true }]

Default: none

Builder-authored filters applied on every load (visual rules and/or expression). List has no end-user filter UI.

Fixed FilteroptionalCustom expression or combinator + filters

Builder-authored filter (expression and/or structured group) applied on every data request. Configured in Filter by.

Good to know

• Use to scope the list (e.g. only open items, or rows matching a parent form id).

Example null

Default: none

Elements FilteroptionalList of Settings group

Visual Filter-by rules stored as a flat list of field/operator/value (or selector) entries. Written by the Filter by editor together with the combinator.

Default: none

Elements Filter CombinatoroptionalOne of: AND, OR

How visual Filter-by rules combine: AND or OR.

Choices

• AND — Every rule must match.
• OR — Any rule may match.

Default: none

Background refresh polling interval in seconds.

IntervaloptionalNumber

Automatic refresh interval in seconds. 0 disables polling.

Avoid

• Do not poll aggressively for static lists or expensive queries.

Default: none

Present because List shares the data-element config codec with Table. The List designer does not expose search, allowed-filter, or column-hidden editors, and the List runtime has no ToolsPanel.

FilterrequiredSettings group

Row filter applied when loading data.

Avoid

• Do not expect end users to build filters from this on a List — there is no filter dialog.

Default: {"fields":[]}

Simple FilteroptionalList of Settings group

Fields that participate in a simple search box. List has no search UI; configuring this has no effect unless you add custom tooling. Prefer Table for searchable lists.

Default: none

Hide Simple FilteroptionalYes / no

Hides the simple search input. Relevant to Table only; List never renders that input.

Default: none

Full Text SearchoptionalYes / no

When true, simple-search values are wrapped for PostgREST full-text matching. Only meaningful with a simple search UI (Table).

Default: none

HiddenoptionalList of Not set (null)

Per-column visibility expressions used by Table. List does not read this — hide content inside the row grid template instead.

Default: none