Interface: VirtualTableProps<T>
See
Table
Type parameters​
| Name | Type |
|---|---|
T | extends 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​
| Name | Type |
|---|---|
params | CellRendererParams<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​
| Name | Type |
|---|---|
filterValues | Partial<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​
| Name | Type |
|---|---|
props | FilterFormFieldProps<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​
| Name | Type |
|---|---|
params | OnTableColumnResizeParams |
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​
| Name | Type |
|---|---|
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​
| Name | Type |
|---|---|
props | OnRowClickParams<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​
| Name | Type |
|---|---|
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