Interface TableControlProps<T>

Properties of the TableControl React component.

interface TableControlProps<T> {
    columns: TableColumn<T>[];
    data: T[];
    dataKey: (row: T) => Key;
    hasRemoveButton?: boolean;
    hover?: boolean;
    label?: string;
    labelVariant?: Variant;
    maxHeight?: string | number;
    onClickRow?: (row: T) => void;
    onRemoveRow?: (row: T) => void;
    removeButtonTitle?: string;
    selectedKey?: Key;
    size?: "small" | "medium";
    stickyHeader?: boolean;
}

Type Parameters

  • T

Properties

columns data dataKey hasRemoveButton? hover? label? labelVariant? maxHeight? onClickRow? onRemoveRow? removeButtonTitle? selectedKey? size? stickyHeader?

Properties

columns

columns: TableColumn<T>[]

Column definitions.

data

data: T[]

Data rows to be displayed.

dataKey

dataKey: (row: T) => Key

Callback to get a unique data key for the specified row.

OptionalhasRemoveButton

hasRemoveButton?: boolean

If each row should have a remove button

Optionalhover

hover?: boolean

If true, the table row will shade on hover, defaults to false.

Optionallabel

label?: string

An optional table label.

OptionallabelVariant

labelVariant?: Variant

An optional Typography variant to be used for the label.

OptionalmaxHeight

maxHeight?: string | number

Optional max height.

OptionalonClickRow

onClickRow?: (row: T) => void

Callback to inform that a data row has been clicked.

OptionalonRemoveRow

onRemoveRow?: (row: T) => void

Callback to be run when clicking on the remove button

OptionalremoveButtonTitle

removeButtonTitle?: string

A title for the remove button

OptionalselectedKey

selectedKey?: Key

The key of the currently selected data row.

Optionalsize

size?: "small" | "medium"

Table size, defaults to 'medium'.

OptionalstickyHeader

stickyHeader?: boolean

Set the header sticky, defaults to false.

Settings

Member Visibility

On This Page

Properties