Skip to main content
Version: 2.0.0

Interface: VirtualTableProps<T>

See

Table

Type parameters

NameType
Textends Record<string, any>

Properties

cellRenderer

cellRenderer: (params: CellRendererParams<T>) => ReactNode

Type declaration

▸ (params): ReactNode

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

Parameters
NameType
paramsCellRendererParams<T>
Returns

ReactNode

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:28


checkFilterCombination

Optional checkFilterCombination: (filterValues: Partial<Record<Extract<keyof T, string>, [WhereFilterOp, any]>>, sortBy?: [string, "asc" | "desc"]) => boolean

Type declaration

▸ (filterValues, sortBy?): boolean

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

Parameters
NameType
filterValuesPartial<Record<Extract<keyof T, string>, [WhereFilterOp, any]>>
sortBy?[string, "asc" | "desc"]
Returns

boolean

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:41


columns

columns: TableColumn<any>[]

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

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:22


createFilterField

Optional createFilterField: (props: FilterFormFieldProps<any>) => ReactNode

Type declaration

▸ (props): ReactNode

Parameters
NameType
propsFilterFormFieldProps<any>
Returns

ReactNode

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:113


data

Optional data: T[]

Array of arbitrary data

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:16


emptyMessage

Optional emptyMessage: string

Message displayed when there is no data

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:101


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

lib/src/core/components/Table/VirtualTableProps.tsx:96


filter

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

In case this table should have some filters set by default

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:73


hoverRow

Optional hoverRow: boolean

Should apply a different style when hovering

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:111


loading

Optional loading: boolean

Is the table in a loading state

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:106


onColumnResize

Optional onColumnResize: (params: OnTableColumnResizeParams) => void

Type declaration

▸ (params): void

Callback when a column is resized

Parameters
NameType
paramsOnTableColumnResizeParams
Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:63


onEndReached

Optional onEndReached: () => void

Type declaration

▸ (): void

A callback function when scrolling the table to near the end

Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:47


onFilterUpdate

Optional onFilterUpdate: (filter?: Partial<Record<any, [WhereFilterOp, any]>>) => void

Type declaration

▸ (filter?): void

Callback used when filters are updated

Parameters
NameType
filter?Partial<Record<any, [WhereFilterOp, any]>>
Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:79


onResetPagination

Optional onResetPagination: () => void

Type declaration

▸ (): void

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

Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:53


onRowClick

Optional onRowClick: (props: OnRowClickParams<T>) => void

Type declaration

▸ (props): void

Callback when a row is clicked

Parameters
NameType
propsOnRowClickParams<T>
Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:58


onSortByUpdate

Optional onSortByUpdate: (sortBy?: [string, "asc" | "desc"]) => void

Type declaration

▸ (sortBy?): void

Callback used when sorting is updated

Parameters
NameType
sortBy?[string, "asc" | "desc"]
Returns

void

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:90


paginationEnabled

Optional paginationEnabled: boolean

If enabled, content is loaded in batch

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:33


size

Optional size: TableSize

Size of the table

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:68


sortBy

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

Default sort applied to this collection

Defined in

lib/src/core/components/Table/VirtualTableProps.tsx:84

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!