Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | import React, { type JSX, useCallback, useMemo } from 'react';
import { Box, MenuItem, TextField, useTheme } from '@mui/material';
import {
MaterialReactTable as MRTTable,
MRT_Cell,
MRT_Column,
MRT_ColumnDef,
MRT_Row,
MRT_TableInstance,
MRT_TableOptions,
useMaterialReactTable,
} from 'material-react-table';
export type ColumnEditConfig<TData extends Record<string, any>> = {
/** Function to call when a cell value is saved (on blur) */
onSave?: (row: TData, value: any, columnId: string) => void | Promise<void>;
/** Edit variant: 'text' (default), 'select', or 'custom' */
editVariant?: 'text' | 'select' | 'custom';
/** Options for select variant */
selectOptions?: { label: string; value: string | number }[];
/** Custom edit component */
customEditComponent?: (props: {
cell: MRT_Cell<TData>;
row: MRT_Row<TData>;
column: MRT_Column<TData>;
table: MRT_TableInstance<TData>;
}) => JSX.Element;
};
export type EditableTableColumn<TData extends Record<string, any>> = {
id: string;
/** Column header text */
header: string;
/** Key to access data in row object */
accessorKey?: keyof TData;
/** Custom accessor function for computed values */
accessorFn?: (row: TData) => any;
/** Width of the column in pixels */
size?: number;
/** Whether the column is editable. Can be a boolean or a function that receives the row and returns a boolean */
enableEditing?: boolean | ((row: MRT_Row<TData>) => boolean);
/** Whether the column can be hidden */
enableHiding?: boolean;
/** Edit configuration for this column */
editConfig?: ColumnEditConfig<TData>;
/** Custom cell renderer */
Cell?: (props: { cell: MRT_Cell<TData>; row: MRT_Row<TData> }) => JSX.Element | null;
/** Filter variant: 'text', 'select', 'multi-select', 'range', 'date-range' */
filterVariant?: 'text' | 'select' | 'multi-select' | 'range' | 'date-range';
/** Options for select/multi-select filters */
filterSelectOptions?: string[];
/** Custom filter function */
filterFn?: 'fuzzy' | 'between' | 'arrIncludesSome' | ((row: TData, columnId: string, filterValue: any) => boolean);
};
export type EditableTableProps<TData extends Record<string, any>> = {
/** Array of column definitions */
columns: EditableTableColumn<TData>[];
/** Array of data rows */
data: TData[];
/** Whether to enable editing (default: false) */
enableEditing?: boolean;
/** Whether to enable column ordering (default: false) */
enableColumnOrdering?: boolean;
/** Whether to enable column pinning (default: false) */
enableColumnPinning?: boolean;
/** Whether to enable sorting (default: true) */
enableSorting?: boolean;
/** Whether to enable global filter/search (default: false) */
enableGlobalFilter?: boolean;
/** Whether to enable column filters (default: false) */
enableColumnFilters?: boolean;
/** Whether to enable pagination (default: true) */
enablePagination?: boolean;
/** Whether to show the bottom toolbar (default: true) */
enableBottomToolbar?: boolean;
/** Whether to show the top toolbar (default: true) */
enableTopToolbar?: boolean;
initialSorting?: { id: string; desc: boolean }[];
/** Callback when a row is clicked */
onRowClick?: (row: TData) => void;
/** Custom toolbar actions */
renderToolbarInternalActions?: (props: { table: MRT_TableInstance<TData> }) => JSX.Element;
/** Additional MRT table options to override defaults */
tableOptions?: Partial<MRT_TableOptions<TData>>;
};
export default function EditableTable<TData extends Record<string, any>>({
columns,
data,
enableEditing = false,
enableColumnOrdering = false,
enableColumnPinning = false,
enableSorting = true,
enableGlobalFilter = false,
enableColumnFilters = false,
enablePagination = true,
enableBottomToolbar = true,
enableTopToolbar = true,
initialSorting,
onRowClick,
renderToolbarInternalActions,
tableOptions = {},
}: EditableTableProps<TData>): JSX.Element {
const theme = useTheme();
// Convert simplified column definitions to MRT column definitions
const mrtColumns = useMemo<MRT_ColumnDef<TData>[]>(() => {
return columns.map((col) => {
const mrtCol: MRT_ColumnDef<TData> = {
id: col.id,
header: col.header,
accessorKey: col.accessorKey as string,
accessorFn: col.accessorFn,
size: col.size,
enableEditing: col.enableEditing ?? enableEditing,
enableHiding: col.enableHiding ?? true,
Cell: col.Cell,
filterVariant: col.filterVariant,
filterSelectOptions: col.filterSelectOptions,
filterFn: col.filterFn as any,
enableColumnFilter: col.filterVariant !== undefined,
};
// Handle edit configuration
if (col.editConfig) {
const { editVariant = 'text', selectOptions, customEditComponent, onSave } = col.editConfig;
if (editVariant === 'custom' && customEditComponent) {
mrtCol.Edit = customEditComponent;
} else if (editVariant === 'select' && selectOptions) {
mrtCol.editVariant = 'select';
mrtCol.editSelectOptions = selectOptions;
const SelectEditComponent = ({
cell,
row,
table: iTable,
}: {
cell: MRT_Cell<TData>;
row: MRT_Row<TData>;
table: MRT_TableInstance<TData>;
}) => {
const [value, setValue] = React.useState(cell.getValue() || '');
const handleSave = useCallback(() => {
if (onSave) {
void onSave(row.original, value, col.id);
}
iTable.setEditingCell(null);
}, [value]);
return (
<TextField
select
value={value}
onChange={(e) => setValue(e.target.value)}
onBlur={handleSave}
onKeyDown={(e) => {
if (e.key === 'Enter') {
handleSave();
} else if (e.key === 'Escape') {
iTable.setEditingCell(null);
}
}}
size='small'
fullWidth
>
{selectOptions.map((option) => (
<MenuItem key={option.value} value={option.value}>
{option.label}
</MenuItem>
))}
</TextField>
);
};
mrtCol.Edit = SelectEditComponent;
} else {
// Default text input with onBlur save
mrtCol.muiEditTextFieldProps = ({ row }: { row: MRT_Row<TData> }) => ({
onBlur: (event: React.FocusEvent<HTMLInputElement>) => {
if (onSave) {
const value = event.target.value;
void onSave(row.original, value, col.id);
}
},
});
}
}
return mrtCol;
});
}, [columns, enableEditing]);
const initialStateConfig = {
...(initialSorting ? { sorting: initialSorting } : {}),
...(enableColumnFilters ? { showColumnFilters: true } : {}),
...(enableGlobalFilter ? { showGlobalFilter: true } : {}),
};
const table = useMaterialReactTable({
columns: mrtColumns,
data,
editDisplayMode: 'cell',
enableColumnOrdering,
enableColumnPinning,
enableEditing,
enableSorting,
enableGlobalFilter,
enableColumnFilters,
enableFilters: enableColumnFilters || enableGlobalFilter,
enablePagination,
enableBottomToolbar: enablePagination ? enableBottomToolbar : false,
enableTopToolbar,
positionGlobalFilter: enableGlobalFilter ? 'left' : undefined,
...(Object.keys(initialStateConfig).length > 0 ? { initialState: initialStateConfig } : {}),
renderToolbarInternalActions,
muiTableBodyProps: {
sx: {
'& tr:nth-of-type(odd) > td': {
backgroundColor: theme.palette.TwClrBaseGray025 || theme.palette.grey[50],
},
},
},
muiTablePaperProps: {
elevation: 0,
},
muiTableBodyRowProps: ({ row }) => ({
onClick: onRowClick ? () => onRowClick(row.original) : undefined,
sx: {
cursor: onRowClick ? 'pointer' : 'default',
'& td': {
borderBottom: 'none',
},
},
}),
// Merge any additional table options
...tableOptions,
});
return (
<Box minHeight='160px' padding={2}>
<MRTTable table={table} />
</Box>
);
}
|