Interface: TableProps<T>
see Table
Type parameters​
| Name |
|---|
T |
Properties​
columns​
• columns: TableColumn<T>[]
Properties displayed in this collection. If this property is not set every property is displayed, you can filter
Defined in​
core/components/Table/TableProps.tsx:18
data​
• Optional data: T[]
Array of arbitrary data
Defined in​
core/components/Table/TableProps.tsx:12
emptyMessage​
• Optional emptyMessage: string
Message displayed when there is no data
Defined in​
core/components/Table/TableProps.tsx:105
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​
core/components/Table/TableProps.tsx:100
filter​
• Optional filter: TableFilterValues<any>
In case this table should have some filters set by default
Defined in​
core/components/Table/TableProps.tsx:77
frozenIdColumn​
• Optional frozenIdColumn: boolean
Is the id column frozen to the left.
Defined in​
core/components/Table/TableProps.tsx:46
hoverRow​
• Optional hoverRow: boolean
Should apply a different style when hovering
Defined in​
core/components/Table/TableProps.tsx:115
loading​
• Optional loading: boolean
Is the table in a loading state
Defined in​
core/components/Table/TableProps.tsx:110
paginationEnabled​
• paginationEnabled: boolean
If enabled, content is loaded in batch
Defined in​
core/components/Table/TableProps.tsx:32
size​
• size: TableSize
Size of the table
Defined in​
core/components/Table/TableProps.tsx:72
sortBy​
• Optional sortBy: [string, "asc" | "desc"]
Default sort applied to this collection
Defined in​
core/components/Table/TableProps.tsx:88
Methods​
checkFilterCombination​
â–¸ Optional checkFilterCombination(filterValues, sortBy?): boolean
Set this callback if you want to support some combinations of
Parameters​
| Name | Type |
|---|---|
filterValues | TableFilterValues<T> |
sortBy? | [string, "asc" | "desc"] |
Returns​
boolean
Defined in​
core/components/Table/TableProps.tsx:40
idColumnBuilder​
â–¸ idColumnBuilder(props): ReactNode
Builder function for the column id
Parameters​
| Name | Type |
|---|---|
props | Object |
props.entry | T |
props.size | TableSize |
Returns​
ReactNode
Defined in​
core/components/Table/TableProps.tsx:24
onColumnResize​
â–¸ Optional onColumnResize(params): void
Callback when a column is resized
Parameters​
| Name | Type |
|---|---|
params | OnTableColumnResizeParams<T> |
Returns​
void
Defined in​
core/components/Table/TableProps.tsx:67
onEndReached​
â–¸ Optional onEndReached(): void
A callback function when scrolling the table to near the end
Returns​
void
Defined in​
core/components/Table/TableProps.tsx:51
onFilterUpdate​
â–¸ Optional onFilterUpdate(filter?): void
Callback used when filters are updated
Parameters​
| Name | Type |
|---|---|
filter? | TableFilterValues<any> |
Returns​
void
Defined in​
core/components/Table/TableProps.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​
core/components/Table/TableProps.tsx:57
onRowClick​
â–¸ Optional onRowClick(props): void
Callback when a row is clicked
Parameters​
| Name | Type |
|---|---|
props | Object |
props.event | SyntheticEvent<Element, Event> |
props.rowData | T |
props.rowIndex | number |
props.rowKey | string |
Returns​
void
Defined in​
core/components/Table/TableProps.tsx:62
onSortByUpdate​
â–¸ Optional onSortByUpdate(sortBy?): void
Callback used when sorting is updated
Parameters​
| Name | Type |
|---|---|
sortBy? | [string, "asc" | "desc"] |
Returns​
void