Interface DataTableHeadingProps<T, ColName, ItemProps>

Props passed when rendering a single heading in a DataTable.

interface DataTableHeadingProps<
    T,
    ColName = string,
    ItemProps = DefaultRowProps,
> {
    column: DataTableColumn<T, T, ColName, ItemProps>;
    headingRowProps?: ItemProps;
    getColumnSortIndicator(colName: ColName): SortDirection | undefined;
    getColumnWidth(colName: ColName): number | undefined;
    onHeadingClick(colName: ColName): void;
    setColumnWidth(colName: ColName, width: number): void;
}

Type Parameters

T
ColName = string
ItemProps = DefaultRowProps

Hierarchy (View Summary)

DataTableHeadingRowProps<ColName, ItemProps>
- DataTableHeadingProps

Index

Properties

column headingRowProps?

Methods

getColumnSortIndicator getColumnWidth onHeadingClick setColumnWidth

Properties

column

column: DataTableColumn<T, T, ColName, ItemProps>

Information about the column being rendered

`Optional`headingRowProps

headingRowProps?: ItemProps

Methods

getColumnSortIndicator

getColumnSortIndicator(colName: ColName): SortDirection | undefined
A function to get which sort icon (ascending or descending) to show
Parameters
- colName: ColName
Returns SortDirection | undefined
Inherited from DataTableHeadingRowProps.getColumnSortIndicator
- Defined in src/DataTable.tsx:360

getColumnWidth

getColumnWidth(colName: ColName): number | undefined
A function to gets the current width of column width, if set.
Parameters
- colName: ColName
Returns number | undefined
Inherited from DataTableHeadingRowProps.getColumnWidth
- Defined in src/DataTable.tsx:362

onHeadingClick

onHeadingClick(colName: ColName): void
A function to change the table's sort order.
Parameters
- colName: ColName
Returns void
Inherited from DataTableHeadingRowProps.onHeadingClick
- Defined in src/DataTable.tsx:366

setColumnWidth

setColumnWidth(colName: ColName, width: number): void
A function to save a column width. Called as the resize handle is dragged by the user.
Parameters
- colName: ColName
- width: number
Returns void
Inherited from DataTableHeadingRowProps.setColumnWidth
- Defined in src/DataTable.tsx:364