Skip to content

Home > @liquidrazor/list-display > ListConfig

ListConfig interface

Public configuration accepted by ListDisplay.

Signature:

typescript
export interface ListConfig<TRow = any, TRowId = RowId>

Properties

Property

Modifiers

Type

Description

components?

ListComponents

(Optional) Overridable UI components (slots).

componentsProps?

ListComponentsProps

(Optional) Optional props passed to slot components.

dataSource

DataSource<TRow, TRowId>

Data source adapter.

fields

Array<FieldSchema<TRow>>

Column definitions.

generalActions?

Array<GeneralAction<TRow, TRowId>>

(Optional) General (toolbar-level) actions.

idKey

keyof TRow & string

Property name on TRow used as identifier.

initialFilters?

ActiveFilterState

(Optional) Initial filters map.

initialPagination?

PaginationState

(Optional) Initial pagination state.

initialSort?

SortDescriptor<TRow>

(Optional) Initial sort descriptor.

rowActions?

Array<RowAction<TRow, TRowId>>

(Optional) Row-level actions.

selectionMode?

SelectionMode

(Optional) Selection mode for the list.