Interface: VirtualTableProps<T>

See

Table

Type Parameters

• T extends Record<string, any>

Properties

AddColumnComponent?

optional AddColumnComponent: ComponentType<object>

If adding this callback, a button to add a new column is displayed.

Param

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:148

---

cellRenderer

cellRenderer: ComponentType<CellRendererParams<T>>

Custom cell renderer The renderer receives props { cellData, columns, column, columnIndex, rowData, rowIndex, container, isScrolling }

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:32

---

checkFilterCombination()?

optional checkFilterCombination: (filterValues, sortBy?) => boolean

Set this callback if you want to support some combinations of filter combinations only.

Parameters

• filterValues: Partial<Record<Extract<keyof T, string>, [WhereFilterOp, any]>>

• sortBy?: [string, "asc" | "desc"]

Returns

boolean

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:40

---

className?

optional className: string

Class name applied to the table

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:132

---

columns

columns: VirtualTableColumn<any>[]

Properties displayed in this collection. If this property is not set every property is displayed, you can filter

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:26

---

createFilterField()?

optional createFilterField: (props) => ReactNode

Callback to create a filter field, displayed in the header as a dropdown

Parameters

• props: FilterFormFieldProps<any>

Returns

ReactNode

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:127

---

data?

optional data: T[]

Array of arbitrary data

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:20

---

debug?

optional debug: boolean

Debug mode

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:153

---

emptyComponent?

optional emptyComponent: ReactNode

Message displayed when there is no data

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:105

---

endAdornment?

optional endAdornment: ReactNode

Component rendered at the end of the table, after scroll

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:142

---

endOffset?

optional endOffset: number

Offset in pixels where the onEndReached callback is triggered

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:51

---

error?

optional error: Error

If there is an error loading data you can pass it here, so it gets displayed instead of the content

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:100

---

filter?

optional filter: Partial<Record<any, [WhereFilterOp, any]>>

In case this table should have some filters set by default

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:77

---

hoverRow?

optional hoverRow: boolean

Should apply a different style when hovering

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:115

---

loading?

optional loading: boolean

Is the table in a loading state

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:110

---

onColumnResize()?

optional onColumnResize: (params) => void

Callback when a column is resized

Parameters

• params: OnVirtualTableColumnResizeParams

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:67

---

onEndReached()?

optional onEndReached: () => void

A callback function when scrolling the table to near the end

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:46

---

onFilterUpdate()?

optional onFilterUpdate: (filter?) => void

Callback used when filters are updated

Parameters

• filter?: Partial<Record<any, [WhereFilterOp, any]>>

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:83

---

onResetPagination()?

optional onResetPagination: () => void

When the pagination should be reset. E.g. the filters or sorting has been reset.

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:57

---

onRowClick()?

optional onRowClick: (props) => void

Callback when a row is clicked

Parameters

• props: OnRowClickParams<T>

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:62

---

onSortByUpdate()?

optional onSortByUpdate: (sortBy?) => void

Callback used when sorting is updated

Parameters

• sortBy?: [string, "asc" | "desc"]

Returns

void

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:94

---

rowClassName()?

optional rowClassName: (rowData) => string

Apply a custom class name to the row

Parameters

• rowData: T

Returns

string

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:121

---

rowHeight?

optional rowHeight: number

Size of the table

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:72

---

sortBy?

optional sortBy: [string, "asc" | "desc"]

Default sort applied to this collection

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:88

---

style?

optional style: CSSProperties

Style applied to the table

Defined in

packages/firecms_core/src/components/VirtualTable/VirtualTableProps.tsx:137