/
useMRT_TableInstance.ts
317 lines (304 loc) · 11.4 KB
/
useMRT_TableInstance.ts
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
import { useMemo, useRef, useState } from 'react';
import { useReactTable } from '@tanstack/react-table';
import {
type MRT_Cell,
type MRT_Column,
type MRT_ColumnDef,
type MRT_ColumnFilterFnsState,
type MRT_ColumnOrderState,
type MRT_ColumnSizingInfoState,
type MRT_DefinedTableOptions,
type MRT_DensityState,
type MRT_FilterOption,
type MRT_GroupingState,
type MRT_PaginationState,
type MRT_Row,
type MRT_RowData,
type MRT_StatefulTableOptions,
type MRT_TableInstance,
type MRT_TableState,
type MRT_Updater,
} from '../types';
import {
getAllLeafColumnDefs,
getColumnId,
getDefaultColumnFilterFn,
prepareColumns,
} from '../utils/column.utils';
import {
getDefaultColumnOrderIds,
showRowActionsColumn,
showRowDragColumn,
showRowExpandColumn,
showRowNumbersColumn,
showRowPinningColumn,
showRowSelectionColumn,
showRowSpacerColumn,
} from '../utils/displayColumn.utils';
import { createRow } from '../utils/tanstack.helpers';
import { getMRT_RowActionsColumnDef } from './display-columns/getMRT_RowActionsColumnDef';
import { getMRT_RowDragColumnDef } from './display-columns/getMRT_RowDragColumnDef';
import { getMRT_RowExpandColumnDef } from './display-columns/getMRT_RowExpandColumnDef';
import { getMRT_RowNumbersColumnDef } from './display-columns/getMRT_RowNumbersColumnDef';
import { getMRT_RowPinningColumnDef } from './display-columns/getMRT_RowPinningColumnDef';
import { getMRT_RowSelectColumnDef } from './display-columns/getMRT_RowSelectColumnDef';
import { getMRT_RowSpacerColumnDef } from './display-columns/getMRT_RowSpacerColumnDef';
import { useMRT_Effects } from './useMRT_Effects';
/**
* The MRT hook that wraps the TanStack useReactTable hook and adds additional functionality
* @param definedTableOptions - table options with proper defaults set
* @returns the MRT table instance
*/
export const useMRT_TableInstance = <TData extends MRT_RowData>(
definedTableOptions: MRT_DefinedTableOptions<TData>,
): MRT_TableInstance<TData> => {
const lastSelectedRowId = useRef<null | string>(null);
const actionCellRef = useRef<HTMLTableCellElement>(null);
const bottomToolbarRef = useRef<HTMLDivElement>(null);
const editInputRefs = useRef<Record<string, HTMLInputElement>>({});
const filterInputRefs = useRef<Record<string, HTMLInputElement>>({});
const searchInputRef = useRef<HTMLInputElement>(null);
const tableContainerRef = useRef<HTMLDivElement>(null);
const tableHeadCellRefs = useRef<Record<string, HTMLTableCellElement>>({});
const tablePaperRef = useRef<HTMLDivElement>(null);
const topToolbarRef = useRef<HTMLDivElement>(null);
const tableHeadRef = useRef<HTMLTableSectionElement>(null);
const tableFooterRef = useRef<HTMLTableSectionElement>(null);
//transform initial state with proper column order
const initialState: Partial<MRT_TableState<TData>> = useMemo(() => {
const initState = definedTableOptions.initialState ?? {};
initState.columnOrder =
initState.columnOrder ??
getDefaultColumnOrderIds({
...definedTableOptions,
state: {
...definedTableOptions.initialState,
...definedTableOptions.state,
},
} as MRT_StatefulTableOptions<TData>);
initState.globalFilterFn = definedTableOptions.globalFilterFn ?? 'fuzzy';
return initState;
}, []);
definedTableOptions.initialState = initialState;
const [actionCell, setActionCell] = useState<MRT_Cell<TData> | null>(
initialState.actionCell ?? null,
);
const [creatingRow, _setCreatingRow] = useState<MRT_Row<TData> | null>(
initialState.creatingRow ?? null,
);
const [columnFilterFns, setColumnFilterFns] =
useState<MRT_ColumnFilterFnsState>(() =>
Object.assign(
{},
...getAllLeafColumnDefs(
definedTableOptions.columns as MRT_ColumnDef<TData>[],
).map((col) => ({
[getColumnId(col)]:
col.filterFn instanceof Function
? col.filterFn.name ?? 'custom'
: col.filterFn ??
initialState?.columnFilterFns?.[getColumnId(col)] ??
getDefaultColumnFilterFn(col),
})),
),
);
const [columnOrder, onColumnOrderChange] = useState<MRT_ColumnOrderState>(
initialState.columnOrder ?? [],
);
const [columnSizingInfo, onColumnSizingInfoChange] =
useState<MRT_ColumnSizingInfoState>(
initialState.columnSizingInfo ?? ({} as MRT_ColumnSizingInfoState),
);
const [density, setDensity] = useState<MRT_DensityState>(
initialState?.density ?? 'comfortable',
);
const [draggingColumn, setDraggingColumn] =
useState<MRT_Column<TData> | null>(initialState.draggingColumn ?? null);
const [draggingRow, setDraggingRow] = useState<MRT_Row<TData> | null>(
initialState.draggingRow ?? null,
);
const [editingCell, setEditingCell] = useState<MRT_Cell<TData> | null>(
initialState.editingCell ?? null,
);
const [editingRow, setEditingRow] = useState<MRT_Row<TData> | null>(
initialState.editingRow ?? null,
);
const [globalFilterFn, setGlobalFilterFn] = useState<MRT_FilterOption>(
initialState.globalFilterFn ?? 'fuzzy',
);
const [grouping, onGroupingChange] = useState<MRT_GroupingState>(
initialState.grouping ?? [],
);
const [hoveredColumn, setHoveredColumn] = useState<Partial<
MRT_Column<TData>
> | null>(initialState.hoveredColumn ?? null);
const [hoveredRow, setHoveredRow] = useState<Partial<MRT_Row<TData>> | null>(
initialState.hoveredRow ?? null,
);
const [isFullScreen, setIsFullScreen] = useState<boolean>(
initialState?.isFullScreen ?? false,
);
const [pagination, onPaginationChange] = useState<MRT_PaginationState>(
initialState?.pagination ?? { pageIndex: 0, pageSize: 10 },
);
const [showAlertBanner, setShowAlertBanner] = useState<boolean>(
initialState?.showAlertBanner ?? false,
);
const [showColumnFilters, setShowColumnFilters] = useState<boolean>(
initialState?.showColumnFilters ?? false,
);
const [showGlobalFilter, setShowGlobalFilter] = useState<boolean>(
initialState?.showGlobalFilter ?? false,
);
const [showToolbarDropZone, setShowToolbarDropZone] = useState<boolean>(
initialState?.showToolbarDropZone ?? false,
);
definedTableOptions.state = {
actionCell,
columnFilterFns,
columnOrder,
columnSizingInfo,
creatingRow,
density,
draggingColumn,
draggingRow,
editingCell,
editingRow,
globalFilterFn,
grouping,
hoveredColumn,
hoveredRow,
isFullScreen,
pagination,
showAlertBanner,
showColumnFilters,
showGlobalFilter,
showToolbarDropZone,
...definedTableOptions.state,
};
//The table options now include all state needed to help determine column visibility and order logic
const statefulTableOptions =
definedTableOptions as MRT_StatefulTableOptions<TData>;
//don't recompute columnDefs while resizing column or dragging column/row
const columnDefsRef = useRef<MRT_ColumnDef<TData>[]>([]);
statefulTableOptions.columns =
statefulTableOptions.state.columnSizingInfo.isResizingColumn ||
statefulTableOptions.state.draggingColumn ||
statefulTableOptions.state.draggingRow
? columnDefsRef.current
: prepareColumns({
columnDefs: [
...([
showRowPinningColumn(statefulTableOptions) &&
getMRT_RowPinningColumnDef(statefulTableOptions),
showRowDragColumn(statefulTableOptions) &&
getMRT_RowDragColumnDef(statefulTableOptions),
showRowActionsColumn(statefulTableOptions) &&
getMRT_RowActionsColumnDef(statefulTableOptions),
showRowExpandColumn(statefulTableOptions) &&
getMRT_RowExpandColumnDef(statefulTableOptions),
showRowSelectionColumn(statefulTableOptions) &&
getMRT_RowSelectColumnDef(statefulTableOptions),
showRowNumbersColumn(statefulTableOptions) &&
getMRT_RowNumbersColumnDef(statefulTableOptions),
].filter(Boolean) as MRT_ColumnDef<TData>[]),
...statefulTableOptions.columns,
...([
showRowSpacerColumn(statefulTableOptions) &&
getMRT_RowSpacerColumnDef(statefulTableOptions),
].filter(Boolean) as MRT_ColumnDef<TData>[]),
],
tableOptions: statefulTableOptions,
});
columnDefsRef.current = statefulTableOptions.columns;
//if loading, generate blank rows to show skeleton loaders
statefulTableOptions.data = useMemo(
() =>
(statefulTableOptions.state.isLoading ||
statefulTableOptions.state.showSkeletons) &&
!statefulTableOptions.data.length
? [
...Array(
Math.min(statefulTableOptions.state.pagination.pageSize, 20),
).fill(null),
].map(() =>
Object.assign(
{},
...getAllLeafColumnDefs(statefulTableOptions.columns).map(
(col) => ({
[getColumnId(col)]: null,
}),
),
),
)
: statefulTableOptions.data,
[
statefulTableOptions.data,
statefulTableOptions.state.isLoading,
statefulTableOptions.state.showSkeletons,
],
);
//@ts-ignore
const table = useReactTable({
onColumnOrderChange,
onColumnSizingInfoChange,
onGroupingChange,
onPaginationChange,
...statefulTableOptions,
globalFilterFn: statefulTableOptions.filterFns?.[globalFilterFn ?? 'fuzzy'],
}) as MRT_TableInstance<TData>;
table.refs = {
actionCellRef,
bottomToolbarRef,
editInputRefs,
filterInputRefs,
lastSelectedRowId,
searchInputRef,
tableContainerRef,
tableFooterRef,
tableHeadCellRefs,
tableHeadRef,
tablePaperRef,
topToolbarRef,
};
table.setActionCell =
statefulTableOptions.onActionCellChange ?? setActionCell;
table.setCreatingRow = (row: MRT_Updater<MRT_Row<TData> | null | true>) => {
let _row = row;
if (row === true) {
_row = createRow(table);
}
statefulTableOptions?.onCreatingRowChange?.(
_row as MRT_Row<TData> | null,
) ?? _setCreatingRow(_row as MRT_Row<TData> | null);
};
table.setColumnFilterFns =
statefulTableOptions.onColumnFilterFnsChange ?? setColumnFilterFns;
table.setDensity = statefulTableOptions.onDensityChange ?? setDensity;
table.setDraggingColumn =
statefulTableOptions.onDraggingColumnChange ?? setDraggingColumn;
table.setDraggingRow =
statefulTableOptions.onDraggingRowChange ?? setDraggingRow;
table.setEditingCell =
statefulTableOptions.onEditingCellChange ?? setEditingCell;
table.setEditingRow =
statefulTableOptions.onEditingRowChange ?? setEditingRow;
table.setGlobalFilterFn =
statefulTableOptions.onGlobalFilterFnChange ?? setGlobalFilterFn;
table.setHoveredColumn =
statefulTableOptions.onHoveredColumnChange ?? setHoveredColumn;
table.setHoveredRow =
statefulTableOptions.onHoveredRowChange ?? setHoveredRow;
table.setIsFullScreen =
statefulTableOptions.onIsFullScreenChange ?? setIsFullScreen;
table.setShowAlertBanner =
statefulTableOptions.onShowAlertBannerChange ?? setShowAlertBanner;
table.setShowColumnFilters =
statefulTableOptions.onShowColumnFiltersChange ?? setShowColumnFilters;
table.setShowGlobalFilter =
statefulTableOptions.onShowGlobalFilterChange ?? setShowGlobalFilter;
table.setShowToolbarDropZone =
statefulTableOptions.onShowToolbarDropZoneChange ?? setShowToolbarDropZone;
useMRT_Effects(table);
return table;
};