ReferenceComponentsTables
DataTableProps
DataTableProps component contract.
Type
export interface DataTableProps<TData extends RowData>
extends CommonComponentProps,
SlottedComponentProps<TableSlots> {
readonly table: TanStackTable<typeof dataTableFeatures, TData>;
readonly height?: number;
readonly width?: number;
readonly focusMode?: "row" | "cell";
readonly frozenColumns?: number;
readonly minColumnWidth?: number;
readonly maxColumnWidth?: number;
readonly staticLimit?: number;
readonly onActivate?: (row: TData, columnId: string) => void | Promise<void>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
table | TanStackTable<{ columnPinningFeature: import("@tanstack/react-table").TableFeature; columnSizingFeature: import("@tanstack/react-table").TableFeature; rowSelectionFeature: import("@tanstack/react-table").TableFeature; rowSortingFeature: import("@tanstack/react-table").TableFeature; sortedRowModel: (table: TanStackTable<any, any>) => () => import("@tanstack/react-table").RowModel<any, any>; }, TData> | Yes | The table member uses the TanStackTable<{ columnPinningFeature: import("@tanstack/react-table").TableFeature; columnSizingFeature: import("@tanstack/react-table").TableFeature; rowSelectionFeature: import("@tanstack/react-table").TableFeature; rowSortingFeature: import("@tanstack/react-table").TableFeature; sortedRowModel: (table: TanStackTable<any, any>) => () => import("@tanstack/react-table").RowModel<any, any>; }, TData> contract. | — |
height | number | undefined | No | The height member uses the number | undefined contract. | — |
width | number | undefined | No | The width member uses the number | undefined contract. | — |
focusMode | "row" | "cell" | undefined | No | The focusMode member uses the "row" | "cell" | undefined contract. | — |
frozenColumns | number | undefined | No | The frozenColumns member uses the number | undefined contract. | — |
minColumnWidth | number | undefined | No | The minColumnWidth member uses the number | undefined contract. | — |
maxColumnWidth | number | undefined | No | The maxColumnWidth member uses the number | undefined contract. | — |
staticLimit | number | undefined | No | The staticLimit member uses the number | undefined contract. | — |
onActivate | ((row: TData, columnId: string) => void | Promise<void>) | undefined | No | The onActivate member uses the ((row: TData, columnId: string) => void | Promise<void>) | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import("ink").BoxProps; header: import("ink").BoxProps; headerCell: import("ink").TextProps; body: import("ink").BoxProps; row: import("ink").BoxProps; cell: import("ink").TextProps; overflow: import("ink").TextProps; empty: import("ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("ink").BoxProps; header: import("ink").BoxProps; headerCell: import("ink").TextProps; body: import("ink").BoxProps; row: import("ink").BoxProps; cell: import("ink").TextProps; overflow: import("ink").TextProps; empty: import("ink").TextProps; }>> | undefined contract. | BoxProps, SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import("ink").BoxProps; header: import("ink").BoxProps; headerCell: import("ink").TextProps; body: import("ink").BoxProps; row: import("ink").BoxProps; cell: import("ink").TextProps; overflow: import("ink").TextProps; empty: import("ink").TextProps; }, object>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("ink").BoxProps; header: import("ink").BoxProps; headerCell: import("ink").TextProps; body: import("ink").BoxProps; row: import("ink").BoxProps; cell: import("ink").TextProps; overflow: import("ink").TextProps; empty: import("ink").TextProps; }, object>> | undefined contract. | BoxProps, SlotProps, TextProps |