Skip to main content

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

NameType
filterValuesTableFilterValues<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

NameType
propsObject
props.entryT
props.sizeTableSize

Returns

ReactNode

Defined in

core/components/Table/TableProps.tsx:24


onColumnResize

โ–ธ Optional onColumnResize(params): void

Callback when a column is resized

Parameters

NameType
paramsOnTableColumnResizeParams<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

NameType
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

NameType
propsObject
props.eventSyntheticEvent<Element, Event>
props.rowDataT
props.rowIndexnumber
props.rowKeystring

Returns

void

Defined in

core/components/Table/TableProps.tsx:62


onSortByUpdate

โ–ธ Optional onSortByUpdate(sortBy?): void

Callback used when sorting is updated

Parameters

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

Returns

void

Defined in

core/components/Table/TableProps.tsx:94