@ackplus/react-tanstack-data-table 1.1.16 → 1.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +0 -8
  2. package/dist/index.d.ts +4 -0
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +5 -1
  5. package/dist/lib/components/data-table-view.d.ts +7 -0
  6. package/dist/lib/components/data-table-view.d.ts.map +1 -0
  7. package/dist/lib/components/data-table-view.js +151 -0
  8. package/dist/lib/components/toolbar/column-filter-control.d.ts +3 -2
  9. package/dist/lib/components/toolbar/column-filter-control.d.ts.map +1 -1
  10. package/dist/lib/components/toolbar/column-filter-control.js +91 -92
  11. package/dist/lib/components/toolbar/data-table-toolbar.d.ts.map +1 -1
  12. package/dist/lib/components/toolbar/data-table-toolbar.js +14 -1
  13. package/dist/lib/components/toolbar/table-export-control.d.ts.map +1 -1
  14. package/dist/lib/components/toolbar/table-export-control.js +0 -2
  15. package/dist/lib/components/toolbar/table-refresh-control.d.ts.map +1 -1
  16. package/dist/lib/components/toolbar/table-refresh-control.js +3 -1
  17. package/dist/lib/data-table.d.ts +0 -3
  18. package/dist/lib/data-table.d.ts.map +1 -1
  19. package/dist/lib/data-table.js +9 -1638
  20. package/dist/lib/features/column-filter.feature.d.ts +2 -1
  21. package/dist/lib/features/column-filter.feature.d.ts.map +1 -1
  22. package/dist/lib/features/column-filter.feature.js +14 -0
  23. package/dist/lib/hooks/index.d.ts +3 -0
  24. package/dist/lib/hooks/index.d.ts.map +1 -0
  25. package/dist/lib/hooks/index.js +5 -0
  26. package/dist/lib/hooks/use-data-table-engine.d.ts +104 -0
  27. package/dist/lib/hooks/use-data-table-engine.d.ts.map +1 -0
  28. package/dist/lib/hooks/use-data-table-engine.js +964 -0
  29. package/dist/lib/types/data-table.types.d.ts +0 -1
  30. package/dist/lib/types/data-table.types.d.ts.map +1 -1
  31. package/package.json +1 -1
  32. package/src/index.ts +4 -0
  33. package/src/lib/components/data-table-view.tsx +386 -0
  34. package/src/lib/components/toolbar/column-filter-control.tsx +270 -212
  35. package/src/lib/components/toolbar/data-table-toolbar.tsx +15 -1
  36. package/src/lib/components/toolbar/table-export-control.tsx +0 -2
  37. package/src/lib/components/toolbar/table-refresh-control.tsx +11 -7
  38. package/src/lib/data-table.tsx +17 -2183
  39. package/src/lib/features/column-filter.feature.ts +15 -1
  40. package/src/lib/hooks/index.ts +2 -0
  41. package/src/lib/hooks/use-data-table-engine.ts +1285 -0
  42. package/src/lib/types/data-table.types.ts +0 -1
@@ -1,2195 +1,29 @@
1
1
  /**
2
- * Main DataTable Component
2
+ * Main DataTable Component (thin wrapper)
3
3
  *
4
- * A comprehensive, highly customizable data table component built with:
5
- * - Material-UI (MUI) for styling
6
- * - TanStack Table for table logic
7
- * - TypeScript for type safety
4
+ * Composes useDataTableEngine + DataTableProvider + DataTableView.
5
+ * Preserves forwardRef API and DataTableApi surface.
8
6
  */
9
- import {
10
- Table,
11
- TableContainer,
12
- TableBody,
13
- Box,
14
- Paper,
15
- useTheme,
16
- } from '@mui/material';
17
- import {
18
- getCoreRowModel,
19
- useReactTable,
20
- SortingState,
21
- getSortedRowModel,
22
- ColumnOrderState,
23
- ColumnPinningState,
24
- getPaginationRowModel,
25
- Updater,
26
- } from '@tanstack/react-table';
7
+ import React, { forwardRef, useImperativeHandle } from 'react';
27
8
 
28
- // Import custom features
29
- import { ColumnFilterFeature, getCombinedFilteredRowModel } from './features/column-filter.feature';
30
- import { SelectionFeature, SelectionState } from './features';
31
- import { useVirtualizer } from '@tanstack/react-virtual';
32
- import React, { useState, useCallback, useMemo, useRef, useEffect, forwardRef, useImperativeHandle } from 'react';
33
-
34
-
35
- // Import from new organized structure
36
9
  import { DataTableProvider } from './contexts/data-table-context';
37
- import { DataTableSize, exportClientData, exportServerData, generateRowId, createLogger, withIdsDeep } from './utils';
38
- import { useDebouncedFetch } from './utils/debounced-fetch.utils';
39
- import { getSlotComponentWithProps, mergeSlotProps } from './utils/slot-helpers';
40
- import { TableHeader } from './components/headers';
41
- import { DataTablePagination } from './components/pagination';
42
- import { DataTableRow, LoadingRows, EmptyDataRow } from './components/rows';
43
- import { DataTableToolbar, BulkActionsToolbar } from './components/toolbar';
44
- import {
45
- DataFetchMeta,
46
- DataMutationAction,
47
- DataMutationContext,
48
- DataRefreshOptions,
49
- DataTableProps,
50
- } from './types/data-table.types';
51
- import { ColumnFilterState, ExportPhase, ExportProgressPayload, ExportStateChange, TableFiltersForFetch, TableState } from './types';
52
- import { DataTableApi, DataTableExportApiOptions } from './types/data-table-api';
53
- import {
54
- createExpandingColumn,
55
- createSelectionColumn,
56
- } from './utils/special-columns.utils';
57
-
58
-
59
-
60
- // Static default initial state - defined outside component
61
- const DEFAULT_INITIAL_STATE = {
62
- sorting: [],
63
- pagination: {
64
- pageIndex: 0,
65
- pageSize: 10,
66
- },
67
- selectionState: { ids: [], type: 'include' } as SelectionState,
68
- globalFilter: '',
69
- expanded: {},
70
- columnOrder: [],
71
- columnPinning: {
72
- left: [],
73
- right: [],
74
- },
75
- columnVisibility: {},
76
- columnSizing: {},
77
- columnFilter: {
78
- filters: [],
79
- logic: 'AND',
80
- pendingFilters: [],
81
- pendingLogic: 'AND',
82
- } as ColumnFilterState,
83
- };
84
-
85
- /**
86
- * Main DataTable component with all features
87
- */
88
- export const DataTable = forwardRef<DataTableApi<any>, DataTableProps<any>>(function DataTable<T extends Record<string, any>>({
89
- initialState,
90
- columns,
91
- data = [],
92
- totalRow = 0,
93
- idKey = 'id' as keyof T,
94
- extraFilter = null,
95
- footerFilter = null,
96
-
97
- // Data management mode (MUI DataGrid style)
98
- dataMode = 'client',
99
- initialLoadData = true,
100
- onFetchData, // callback to fetch data from the server need to with response { data: T[], total: number }
101
- onFetchStateChange, // callback to fetch data from the server no need to resonce , this for filter data
102
- onDataChange, // callback to change data
103
- onDataStateChange, // callback to change data state
104
-
105
- // Selection props
106
- enableRowSelection = false,
107
- enableMultiRowSelection = true,
108
- selectMode = 'page',
109
- isRowSelectable,
110
- onSelectionChange,
111
-
112
- // Row click props
113
- onRowClick,
114
- selectOnRowClick = false,
115
-
116
- // Bulk action props
117
- enableBulkActions = false,
118
- bulkActions,
119
-
120
- // Column resizing props
121
- enableColumnResizing = false,
122
- columnResizeMode = 'onChange',
123
- onColumnSizingChange,
124
-
125
- // Column ordering props
126
- enableColumnDragging = false,
127
- onColumnDragEnd,
128
-
129
- // Column pinning props
130
- enableColumnPinning = false,
131
- onColumnPinningChange,
132
-
133
- // Column visibility props
134
- onColumnVisibilityChange,
135
- enableColumnVisibility = true,
136
-
137
- // Expandable rows props
138
- enableExpanding = false,
139
- getRowCanExpand,
140
- renderSubComponent,
141
-
142
- // Pagination props
143
- enablePagination = false,
144
- paginationMode = 'client',
145
-
146
- // Filtering props
147
- enableGlobalFilter = true,
148
- enableColumnFilter = false,
149
- filterMode = 'client',
150
-
151
- // Sorting props
152
- enableSorting = true,
153
- sortingMode = 'client',
154
- onSortingChange,
155
-
156
- //export props
157
- exportFilename = 'export',
158
- exportConcurrency = 'cancelAndRestart',
159
- exportChunkSize = 1000,
160
- exportStrictTotalCheck = false,
161
- exportSanitizeCSV = true,
162
- onExportProgress,
163
- onExportComplete,
164
- onExportError,
165
- onServerExport,
166
- onExportCancel,
167
- onExportStateChange,
168
-
169
- // Styling props
170
- enableHover = true,
171
- enableStripes = false,
172
- tableProps = {},
173
- fitToScreen = true,
174
- tableSize: initialTableSize = 'medium',
175
-
176
- // Sticky header/footer props
177
- enableStickyHeaderOrFooter = false,
178
- maxHeight = '400px',
179
-
180
- // Virtualization props
181
- enableVirtualization = false,
182
- estimateRowHeight = 52,
183
-
184
- // Toolbar props
185
- enableTableSizeControl = true,
186
- enableExport = false,
187
- enableReset = true,
188
- enableRefresh = false,
189
-
190
- // Loading and empty states
191
- loading = false,
192
- emptyMessage = 'No data available',
193
- skeletonRows = 5,
194
-
195
- // Column filters props
196
- onColumnFiltersChange,
197
- onPaginationChange,
198
- onGlobalFilterChange,
199
-
200
- // Slots
201
- slots = {},
202
- slotProps = {},
203
-
204
- // Logging
205
- logging,
206
-
207
- }: DataTableProps<T>, ref: React.Ref<DataTableApi<T>>) {
208
- // Convert mode-based props to boolean flags for internal use
209
- const isServerMode = dataMode === 'server';
210
- const isServerPagination = paginationMode === 'server' || isServerMode;
211
- const isServerFiltering = filterMode === 'server' || isServerMode;
212
- const isServerSorting = sortingMode === 'server' || isServerMode;
213
-
214
- const theme = useTheme();
215
- const logger = useMemo(() => createLogger('DataTable', logging), [logging]);
216
-
217
- useEffect(() => {
218
- if (logger.isLevelEnabled('info')) {
219
- logger.info('mounted', {
220
- dataMode,
221
- paginationMode,
222
- filterMode,
223
- sortingMode,
224
- });
225
- }
226
- return () => {
227
- if (logger.isLevelEnabled('info')) {
228
- logger.info('unmounted');
229
- }
230
- };
231
- }, [logger, dataMode, paginationMode, filterMode, sortingMode]);
232
-
233
- // -------------------------------
234
- // Memoized values (grouped together)
235
- // -------------------------------
236
- const initialStateConfig = useMemo(() => {
237
- const config = {
238
- ...DEFAULT_INITIAL_STATE,
239
- ...initialState,
240
- };
241
- if (logger.isLevelEnabled('info')) {
242
- logger.info('initialStateConfig', { config });
243
- }
244
- return config;
245
- }, [initialState, logger]);
246
-
247
-
248
- const initialSelectionState = useMemo(() => {
249
- return initialStateConfig.selectionState || DEFAULT_INITIAL_STATE.selectionState;
250
- }, [initialStateConfig.selectionState]);
251
-
252
- // -------------------------------
253
- // State hooks (grouped together)
254
- // -------------------------------
255
- // const [fetchLoading, setFetchLoading] = useState(false);
256
- const [sorting, setSorting] = useState<SortingState>(initialState?.sorting || DEFAULT_INITIAL_STATE.sorting);
257
- const [pagination, setPagination] = useState(initialState?.pagination || DEFAULT_INITIAL_STATE.pagination);
258
- const [globalFilter, setGlobalFilter] = useState(initialState?.globalFilter || DEFAULT_INITIAL_STATE.globalFilter);
259
- const [selectionState, setSelectionState] = useState<SelectionState>(initialState?.selectionState || DEFAULT_INITIAL_STATE.selectionState);
260
- const [columnFilter, setColumnFilter] = useState<ColumnFilterState>(initialState?.columnFilter || DEFAULT_INITIAL_STATE.columnFilter);
261
- const [expanded, setExpanded] = useState({});
262
- const [tableSize, setTableSize] = useState<DataTableSize>(initialTableSize || 'medium');
263
- const [columnOrder, setColumnOrder] = useState<ColumnOrderState>(initialState?.columnOrder || DEFAULT_INITIAL_STATE.columnOrder);
264
- const [columnPinning, setColumnPinning] = useState<ColumnPinningState>(initialState?.columnPinning || DEFAULT_INITIAL_STATE.columnPinning);
265
- const [columnVisibility, setColumnVisibility] = useState<Record<string, boolean>>(initialState?.columnVisibility || DEFAULT_INITIAL_STATE.columnVisibility);
266
- const [columnSizing, setColumnSizing] = useState<Record<string, number>>(initialState?.columnSizing || DEFAULT_INITIAL_STATE.columnSizing);
267
- const [serverData, setServerData] = useState<T[] | null>(null);
268
- const [serverTotal, setServerTotal] = useState(0);
269
- const [exportController, setExportController] = useState<AbortController | null>(null);
270
- const [exportProgress, setExportProgress] = useState<ExportProgressPayload>({});
271
- const [exportPhase, setExportPhase] = useState<ExportPhase | null>(null);
272
- const [queuedExportCount, setQueuedExportCount] = useState(0);
273
-
274
- // -------------------------------
275
- // Ref hooks (grouped together)
276
- // -------------------------------
277
- const tableContainerRef = useRef<HTMLDivElement>(null);
278
- const internalApiRef = useRef<DataTableApi<T>>(null);
279
- const exportControllerRef = useRef<AbortController | null>(null);
280
- const exportQueueRef = useRef<Promise<void>>(Promise.resolve());
281
-
282
- const isExternallyControlledData = useMemo(
283
- () => !onFetchData && (!!onDataChange || !!onFetchStateChange),
284
- [onFetchData, onDataChange, onFetchStateChange]
285
- );
286
-
287
- const { debouncedFetch, isLoading: fetchLoading } = useDebouncedFetch(onFetchData);
288
- const tableData = useMemo(() => {
289
- if (isExternallyControlledData) return data;
290
- return serverData !== null ? serverData : data;
291
- }, [isExternallyControlledData, serverData, data]);
292
- const tableTotalRow = useMemo(
293
- () => (isExternallyControlledData ? (totalRow || data.length) : (serverData !== null ? serverTotal : totalRow || data.length)),
294
- [isExternallyControlledData, serverData, serverTotal, totalRow, data]
295
- );
296
- const tableLoading = useMemo(() => onFetchData ? (loading || fetchLoading) : loading, [onFetchData, loading, fetchLoading]);
297
-
298
-
299
- const enhancedColumns = useMemo(
300
- () => {
301
- let columnsMap = [...columns];
302
- if (enableExpanding) {
303
- const expandingColumnMap = createExpandingColumn<T>({
304
- ...(slotProps?.expandColumn && typeof slotProps.expandColumn === 'object' ? slotProps.expandColumn : {}),
305
- });
306
- columnsMap = [expandingColumnMap, ...columnsMap];
307
- }
308
- if (enableRowSelection) {
309
- const selectionColumnMap = createSelectionColumn<T>({
310
- ...(slotProps?.selectionColumn && typeof slotProps.selectionColumn === 'object' ? slotProps.selectionColumn : {}),
311
- multiSelect: enableMultiRowSelection,
312
- });
313
- columnsMap = [selectionColumnMap, ...columnsMap];
314
- }
315
- const enhancedColumns = withIdsDeep(columnsMap);
316
- if (logger.isLevelEnabled('info')) {
317
- logger.info('enhancedColumns', { enhancedColumns });
318
- }
319
- return enhancedColumns;
320
- }, [columns, enableExpanding, enableRowSelection, logger, slotProps.expandColumn, slotProps.selectionColumn, enableMultiRowSelection]);
321
-
322
-
323
- const isExporting = useMemo(() => exportController !== null, [exportController]);
324
- const isSomeRowsSelected = useMemo(() => {
325
- if (!enableBulkActions || !enableRowSelection) return false;
326
- if (selectionState.type === 'exclude') {
327
- return selectionState.ids.length < tableTotalRow;
328
- } else {
329
- return selectionState.ids.length > 0;
330
- }
331
- }, [enableBulkActions, enableRowSelection, selectionState, tableTotalRow]);
332
- const selectedRowCount = useMemo(() => {
333
- if (!enableBulkActions || !enableRowSelection) return 0;
334
- if (selectionState.type === 'exclude') {
335
- return tableTotalRow - selectionState.ids.length;
336
- } else {
337
- return selectionState.ids.length;
338
- }
339
- }, [enableBulkActions, enableRowSelection, selectionState, tableTotalRow]);
340
- // -------------------------------
341
- // Callback hooks (grouped together)
342
- // -------------------------------
343
- const fetchData = useCallback(async (
344
- overrides: Partial<TableState> = {},
345
- options?: { delay?: number; meta?: DataFetchMeta }
346
- ) => {
347
- const filters: Partial<TableFiltersForFetch> = {
348
- globalFilter,
349
- pagination,
350
- columnFilter,
351
- sorting,
352
- ...overrides,
353
- };
354
-
355
- if (onFetchStateChange) {
356
- onFetchStateChange(filters, options?.meta);
357
- }
358
- if (!onFetchData) {
359
- if (logger.isLevelEnabled('debug')) {
360
- logger.debug('onFetchData not provided, skipping fetch', { overrides, columnFilter, sorting, pagination });
361
- }
362
- return;
363
- }
364
-
365
- if (logger.isLevelEnabled('info')) {
366
- logger.info('Requesting data', {
367
- filters,
368
- reason: options?.meta?.reason,
369
- force: options?.meta?.force,
370
- });
371
- }
372
-
373
- try {
374
- const delay = options?.delay ?? 300; // respects 0
375
- const result = await debouncedFetch(filters, {
376
- debounceDelay: delay,
377
- meta: options?.meta,
378
- });
379
-
380
- if (logger.isLevelEnabled('info')) {
381
- logger.info('Fetch resolved', {
382
- rows: result?.data?.length ?? 0,
383
- total: result?.total,
384
- });
385
- }
386
-
387
- if (result && Array.isArray(result.data) && result.total !== undefined) {
388
- setServerData(result.data);
389
- setServerTotal(result.total);
390
- } else if (logger.isLevelEnabled('warn')) {
391
- logger.warn('Fetch handler returned unexpected shape', result);
392
- }
393
-
394
- return result;
395
- } catch (error) {
396
- logger.error('Fetch failed', error);
397
- throw error;
398
- }
399
- }, [
400
- onFetchData,
401
- globalFilter,
402
- pagination,
403
- columnFilter,
404
- sorting,
405
- debouncedFetch,
406
- logger,
407
- onFetchStateChange,
408
- ]);
409
-
410
- const normalizeRefreshOptions = useCallback((
411
- options?: boolean | DataRefreshOptions,
412
- fallbackReason: string = 'refresh'
413
- ) => {
414
- if (typeof options === 'boolean') {
415
- return {
416
- resetPagination: options,
417
- force: false,
418
- reason: fallbackReason,
419
- };
420
- }
421
-
422
- return {
423
- resetPagination: options?.resetPagination ?? false,
424
- force: options?.force ?? false,
425
- reason: options?.reason ?? fallbackReason,
426
- };
427
- }, []);
428
-
429
-
430
- const handleSelectionStateChange = useCallback((updaterOrValue) => {
431
- setSelectionState((prevState) => {
432
- const next =
433
- typeof updaterOrValue === 'function' ? updaterOrValue(prevState) : updaterOrValue;
434
- onSelectionChange?.(next);
435
- return next;
436
- });
437
- }, [onSelectionChange]);
438
-
439
- const resetPageToFirst = useCallback(() => {
440
- if (logger.isLevelEnabled('info')) {
441
- logger.info('Resetting to first page due to state change', {
442
- previousPageIndex: pagination.pageIndex,
443
- pageSize: pagination.pageSize,
444
- });
445
- }
446
- const newPagination = { pageIndex: 0, pageSize: pagination.pageSize };
447
- setPagination(newPagination);
448
- onPaginationChange?.(newPagination);
449
- return newPagination;
450
- }, [pagination, logger, onPaginationChange]);
451
-
452
-
453
- const handleSortingChange = useCallback((updaterOrValue: any) => {
454
- setSorting((prev) => {
455
- const next = typeof updaterOrValue === 'function' ? updaterOrValue(prev) : updaterOrValue;
456
- const cleaned = next.filter((s: any) => s?.id);
457
- onSortingChange?.(cleaned);
458
- const nextPagination = resetPageToFirst();
459
- if (isServerMode || isServerSorting) {
460
- fetchData({ sorting: cleaned, pagination: nextPagination }, { delay: 0 });
461
- }
462
- return cleaned;
463
- });
464
- }, [onSortingChange, isServerMode, isServerSorting, resetPageToFirst, fetchData]);
465
-
466
- const handleColumnOrderChange = useCallback((updatedColumnOrder: Updater<ColumnOrderState>) => {
467
- const newColumnOrder = typeof updatedColumnOrder === 'function'
468
- ? updatedColumnOrder(columnOrder)
469
- : updatedColumnOrder;
470
- setColumnOrder(newColumnOrder);
471
- if (onColumnDragEnd) {
472
- onColumnDragEnd(newColumnOrder);
473
- }
474
- }, [onColumnDragEnd, columnOrder]);
475
-
476
- const handleColumnPinningChange = useCallback(
477
- (updater: Updater<ColumnPinningState>) => {
478
- setColumnPinning((prev) => {
479
- const next = typeof updater === "function" ? updater(prev) : updater;
480
- // keep direct callback here (optional)
481
- onColumnPinningChange?.(next);
482
- return next;
483
- });
484
- },
485
- [onColumnPinningChange]
486
- );
487
-
488
- // Column visibility change handler - same pattern as column order
489
- const handleColumnVisibilityChange = useCallback((updater: any) => {
490
- setColumnVisibility((prev) => {
491
- const next = typeof updater === 'function' ? updater(prev) : updater;
492
- onColumnVisibilityChange?.(next);
493
- return next;
494
- });
495
- }, [onColumnVisibilityChange]);
496
-
497
- // Column sizing change handler - same pattern as column order
498
- const handleColumnSizingChange = useCallback((updater: any) => {
499
- setColumnSizing((prev) => {
500
- const next = typeof updater === 'function' ? updater(prev) : updater;
501
- onColumnSizingChange?.(next);
502
- return next;
503
- });
504
- }, [onColumnSizingChange]);
505
-
506
- const handlePaginationChange = useCallback((updater: any) => {
507
- setPagination((prev) => {
508
- const next = typeof updater === 'function' ? updater(prev) : updater;
509
- onPaginationChange?.(next);
510
- if (isServerMode || isServerPagination) {
511
- fetchData({ pagination: next }, { delay: 0 });
512
- }
513
- return next;
514
- });
515
- }, [isServerMode, isServerPagination, fetchData, onPaginationChange]);
516
-
517
-
518
-
519
- const handleGlobalFilterChange = useCallback((updaterOrValue: any) => {
520
- setGlobalFilter((prev) => {
521
- const next = typeof updaterOrValue === 'function' ? updaterOrValue(prev) : updaterOrValue;
522
-
523
- onGlobalFilterChange?.(next);
524
-
525
- if (isServerMode || isServerFiltering) {
526
- const nextPagination = { pageIndex: 0, pageSize: pagination.pageSize };
527
- setPagination(nextPagination);
528
- fetchData({ globalFilter: next, pagination: nextPagination }, { delay: 0 });
529
- }
530
-
531
- return next;
532
- });
533
- }, [isServerMode, isServerFiltering, onGlobalFilterChange, fetchData, pagination?.pageSize]);
534
-
535
- const handleColumnFilterChangeHandler = useCallback((updater: any, isApply = false) => {
536
- setColumnFilter((prev) => {
537
- const newState = typeof updater === 'function' ? updater(prev) : updater
538
- if (isApply){
539
- if (isServerMode || isServerFiltering) {
540
- const nextPagination = { pageIndex: 0, pageSize: pagination.pageSize };
541
- setPagination(nextPagination);
542
- fetchData({ columnFilter: newState, pagination: nextPagination }, { delay: 0 });
543
- }
544
- }
545
- onColumnFiltersChange?.(newState, isApply);
546
- return newState;
547
- });
548
- }, [fetchData, isServerFiltering, isServerMode, onColumnFiltersChange, pagination.pageSize]);
549
-
550
- // -------------------------------
551
- // Table creation (after callbacks/memo)
552
- // -------------------------------
553
- const table = useReactTable({
554
- _features: [ColumnFilterFeature, SelectionFeature],
555
- data: tableData,
556
- columns: enhancedColumns,
557
- // Use merged initial state so built-in reset helpers align with our controlled state defaults
558
- initialState: initialStateConfig,
559
- state: {
560
- ...(enableSorting ? { sorting } : {}),
561
- ...(enablePagination ? { pagination } : {}),
562
- ...(enableGlobalFilter ? { globalFilter } : {}),
563
- ...(enableExpanding ? { expanded } : {}),
564
- ...(enableColumnDragging ? { columnOrder } : {}),
565
- ...(enableColumnPinning ? { columnPinning } : {}),
566
- ...(enableColumnVisibility ? { columnVisibility } : {}),
567
- ...(enableColumnResizing ? { columnSizing } : {}),
568
- ...(enableColumnFilter ? { columnFilter } : {}),
569
- ...(enableRowSelection ? { selectionState } : {}),
570
- },
571
- // Selection options (same pattern as column filter)
572
- // Add custom features
573
- selectMode: selectMode,
574
- enableAdvanceSelection: !!enableRowSelection,
575
- isRowSelectable: isRowSelectable,
576
- ...(enableRowSelection ? { onSelectionStateChange: handleSelectionStateChange } : {}),
577
- // Column filter
578
- enableAdvanceColumnFilter: enableColumnFilter,
579
- onColumnFilterChange: handleColumnFilterChangeHandler, // Handle column filters change
580
- onColumnFilterApply: (state: ColumnFilterState) => handleColumnFilterChangeHandler(state, true), // Handle when filters are actually applied
581
-
582
-
583
- ...(enableSorting ? { onSortingChange: handleSortingChange } : {}),
584
- ...(enablePagination ? { onPaginationChange: handlePaginationChange } : {}),
585
- ...(enableGlobalFilter ? { onGlobalFilterChange: handleGlobalFilterChange } : {}),
586
- ...(enableExpanding ? { onExpandedChange: setExpanded } : {}),
587
- ...(enableColumnDragging ? { onColumnOrderChange: handleColumnOrderChange } : {}),
588
- ...(enableColumnPinning ? { onColumnPinningChange: handleColumnPinningChange } : {}),
589
- ...(enableColumnVisibility ? { onColumnVisibilityChange: handleColumnVisibilityChange } : {}),
590
- ...(enableColumnResizing ? { onColumnSizingChange: handleColumnSizingChange } : {}),
591
-
592
- // Row model
593
- getCoreRowModel: getCoreRowModel(),
594
- ...(enableSorting ? { getSortedRowModel: getSortedRowModel() } : {}),
595
- ...(enableColumnFilter || enableGlobalFilter ? { getFilteredRowModel: getCombinedFilteredRowModel<T>() } : {}),
596
- // Only use getPaginationRowModel for client-side pagination
597
- ...(enablePagination && !isServerPagination ? { getPaginationRowModel: getPaginationRowModel() } : {}),
598
- // Sorting
599
- enableSorting: enableSorting,
600
- manualSorting: isServerSorting,
601
- // Filtering
602
- manualFiltering: isServerFiltering,
603
- // Column resizing
604
- enableColumnResizing: enableColumnResizing,
605
- columnResizeMode: columnResizeMode,
606
- columnResizeDirection: theme.direction,
607
- // Column pinning
608
- enableColumnPinning: enableColumnPinning,
609
- // Expanding
610
- ...(enableExpanding ? { getRowCanExpand: getRowCanExpand } : {}),
611
- // Pagination
612
- manualPagination: isServerPagination,
613
- autoResetPageIndex: false, // Prevent automatic page reset on state changes
614
- // pageCount: enablePagination ? Math.ceil(tableTotalRow / pagination.pageSize) : -1,
615
- rowCount: enablePagination ? (tableTotalRow ?? tableData.length) : tableData.length,
616
- // Row ID
617
- getRowId: (row: any, index: number) => generateRowId(row, index, idKey),
618
- // Debug
619
- debugAll: false, // Disabled for production
620
- });
621
-
622
- // Compute width after table is created so column resizing is safe and reflects changes
623
- const allLeafColumns = table.getAllLeafColumns();
624
- const visibleLeafColumns = table.getVisibleLeafColumns();
625
- const hasExplicitSizing = allLeafColumns.some((column) => {
626
- const { size, minSize, maxSize } = column.columnDef;
627
- return size !== undefined || minSize !== undefined || maxSize !== undefined;
628
- });
629
- const useFixedLayout = fitToScreen || enableColumnResizing || hasExplicitSizing;
630
- const tableTotalSize = table.getTotalSize();
631
- const tableWidth = fitToScreen ? '100%' : (useFixedLayout ? tableTotalSize : '100%');
632
- const tableStyle = {
633
- width: tableWidth,
634
- minWidth: fitToScreen ? tableTotalSize : undefined,
635
- tableLayout: useFixedLayout ? 'fixed' : 'auto',
636
- };
637
-
638
-
639
- // -------------------------------
640
- // Virtualization and row memo
641
- // -------------------------------
642
- // Note: globalFilter is needed in dependencies to trigger recalculation when filter changes
643
- // The table object is stable, so we need to depend on the filter state directly
644
- const rows = table.getRowModel().rows;
645
- const rowVirtualizer = useVirtualizer({
646
- count: rows.length,
647
- getScrollElement: () => tableContainerRef.current,
648
- estimateSize: () => estimateRowHeight,
649
- overscan: 10,
650
- enabled: enableVirtualization && !enablePagination && rows.length > 0,
651
- });
652
-
653
-
654
- // -------------------------------
655
- // Callbacks (after table creation)
656
- // -------------------------------
657
- const handleColumnReorder = useCallback((draggedColumnId: string, targetColumnId: string) => {
658
- const currentOrder = columnOrder.length > 0 ? columnOrder : enhancedColumns.map((col, index) => {
659
- if (col.id) return col.id;
660
- const anyCol = col as any;
661
- if (anyCol.accessorKey && typeof anyCol.accessorKey === 'string') {
662
- return anyCol.accessorKey;
663
- }
664
- return `column_${index}`;
665
- });
666
- const draggedIndex = currentOrder.indexOf(draggedColumnId);
667
- const targetIndex = currentOrder.indexOf(targetColumnId);
668
- if (draggedIndex === -1 || targetIndex === -1) return;
669
- const newOrder = [...currentOrder];
670
- newOrder.splice(draggedIndex, 1);
671
- newOrder.splice(targetIndex, 0, draggedColumnId);
672
- handleColumnOrderChange(newOrder);
673
- }, [columnOrder, enhancedColumns, handleColumnOrderChange]);
674
-
675
- // -------------------------------
676
- // Effects (after callbacks)
677
- // -------------------------------
678
- useEffect(() => {
679
- if (!isExternallyControlledData || serverData === null) return;
680
- setServerData(null);
681
- setServerTotal(0);
682
- }, [isExternallyControlledData, serverData]);
683
-
684
- useEffect(() => {
685
- if (initialLoadData && (onFetchData || onFetchStateChange)) {
686
- if (logger.isLevelEnabled('info')) {
687
- logger.info('Initial data load triggered', { initialLoadData });
688
- }
689
- fetchData({}, {
690
- delay: 0,
691
- meta: { reason: 'initial' },
692
- });
693
- } else if (logger.isLevelEnabled('debug')) {
694
- logger.debug('Skipping initial data load', {
695
- initialLoadData,
696
- hasOnFetchData: !!onFetchData
697
- });
698
- }
699
- // eslint-disable-next-line react-hooks/exhaustive-deps
700
- }, []);
701
-
702
- useEffect(() => {
703
- if (enableColumnDragging && columnOrder.length === 0) {
704
- const initialOrder = enhancedColumns.map((col, index) => {
705
- if (col.id) return col.id;
706
- const anyCol = col as any;
707
- if (anyCol.accessorKey && typeof anyCol.accessorKey === 'string') {
708
- return anyCol.accessorKey;
709
- }
710
- return `column_${index}`;
711
- });
712
- setColumnOrder(initialOrder);
713
- }
714
- }, [enableColumnDragging, enhancedColumns, columnOrder.length]);
715
-
716
-
717
- const lastSentRef = useRef<string>("");
718
-
719
- const emitTableState = useCallback(() => {
720
- if (!onDataStateChange) return;
721
-
722
- const live = table.getState();
723
- const liveColumnFilter = live.columnFilter;
724
-
725
- // only keep what you persist/store
726
- const payload = {
727
- sorting: live.sorting,
728
- pagination: live.pagination,
729
- globalFilter: live.globalFilter,
730
- columnFilter: liveColumnFilter,
731
- columnVisibility: live.columnVisibility,
732
- columnSizing: live.columnSizing,
733
- columnOrder: live.columnOrder,
734
- columnPinning: live.columnPinning,
735
- };
736
-
737
- const key = JSON.stringify(payload);
738
- if (key === lastSentRef.current) return;
739
-
740
- lastSentRef.current = key;
741
- onDataStateChange(payload);
742
- }, [onDataStateChange, table]);
743
-
744
- useEffect(() => {
745
- emitTableState();
746
- }, [
747
- emitTableState,
748
- sorting,
749
- pagination,
750
- globalFilter,
751
- columnFilter,
752
- columnVisibility,
753
- columnSizing,
754
- columnOrder,
755
- columnPinning,
756
- ]);
757
-
758
-
759
- const getResetState = useCallback((): Partial<TableState> => {
760
- const resetSorting = initialStateConfig.sorting || [];
761
- const resetGlobalFilter = initialStateConfig.globalFilter ?? '';
762
- const resetColumnFilter = initialStateConfig.columnFilter;
763
-
764
- const resetPagination = enablePagination
765
- ? (initialStateConfig.pagination || { pageIndex: 0, pageSize: 10 })
766
- : undefined;
767
-
768
- return {
769
- sorting: resetSorting,
770
- globalFilter: resetGlobalFilter,
771
- columnFilter: resetColumnFilter,
772
- ...(resetPagination ? { pagination: resetPagination } : {}),
773
- };
774
- }, [initialStateConfig, enablePagination]);
775
-
776
- const applyDataMutation = useCallback((
777
- action: DataMutationAction,
778
- updater: (rows: T[]) => T[],
779
- details: Partial<Omit<DataMutationContext<T>, 'action' | 'previousData' | 'nextData'>> = {}
780
- ) => {
781
- const previousData = [...tableData];
782
- const nextData = updater(previousData);
783
-
784
- if (nextData === previousData) return nextData;
785
-
786
- const nextTotal = Math.max(0, tableTotalRow + (nextData.length - previousData.length));
787
-
788
- if (!isExternallyControlledData) {
789
- setServerData(nextData);
790
- setServerTotal(nextTotal);
791
- }
792
- onDataChange?.(nextData, {
793
- action,
794
- previousData,
795
- nextData,
796
- totalRow: nextTotal,
797
- ...details,
798
- });
799
-
800
- if (logger.isLevelEnabled('debug')) {
801
- logger.debug('Applied data mutation', {
802
- action,
803
- previousCount: previousData.length,
804
- nextCount: nextData.length,
805
- totalRow: nextTotal,
806
- });
807
- }
808
-
809
- return nextData;
810
- }, [isExternallyControlledData, logger, onDataChange, tableData, tableTotalRow]);
811
-
812
- const triggerRefresh = useCallback(async (
813
- options?: boolean | DataRefreshOptions,
814
- fallbackReason: string = 'refresh'
815
- ) => {
816
- const normalizedOptions = normalizeRefreshOptions(options, fallbackReason);
817
- const nextPagination = enablePagination
818
- ? {
819
- pageIndex: normalizedOptions.resetPagination ? 0 : pagination.pageIndex,
820
- pageSize: pagination.pageSize,
821
- }
822
- : undefined;
823
-
824
- const shouldUpdatePagination = !!nextPagination
825
- && (nextPagination.pageIndex !== pagination.pageIndex || nextPagination.pageSize !== pagination.pageSize);
826
-
827
- if (nextPagination && shouldUpdatePagination) {
828
- setPagination(nextPagination);
829
- onPaginationChange?.(nextPagination);
830
- }
831
-
832
- await fetchData(
833
- nextPagination ? { pagination: nextPagination } : {},
834
- {
835
- delay: 0,
836
- meta: {
837
- reason: normalizedOptions.reason,
838
- force: normalizedOptions.force,
839
- },
840
- }
841
- );
842
- return;
843
- }, [normalizeRefreshOptions, enablePagination, pagination, onPaginationChange, fetchData]);
844
-
845
- const resetAllAndReload = useCallback(() => {
846
- const resetState = getResetState();
10
+ import { useDataTableEngine } from './hooks/use-data-table-engine';
11
+ import { DataTableView } from './components/data-table-view';
12
+ import type { DataTableProps } from './types/data-table.types';
13
+ import type { DataTableApi } from './types/data-table-api';
847
14
 
848
- setSorting(resetState.sorting || []);
849
- setGlobalFilter(resetState.globalFilter ?? '');
850
- setColumnFilter(resetState.columnFilter as any);
851
15
 
852
- if (resetState.pagination) {
853
- setPagination(resetState.pagination);
854
- onPaginationChange?.(resetState.pagination);
855
- }
16
+ export const DataTable = forwardRef(function DataTable<T extends Record<string, any>>(
17
+ props: DataTableProps<T>,
18
+ ref: React.Ref<DataTableApi<T>>,
19
+ ) {
20
+ const engine = useDataTableEngine<T>(props);
856
21
 
857
- setSelectionState(initialSelectionState);
858
- setExpanded({});
22
+ useImperativeHandle(ref, () => engine.refs.apiRef.current!, []);
859
23
 
860
- // layout state
861
- setColumnVisibility(initialStateConfig.columnVisibility || {});
862
- setColumnSizing(initialStateConfig.columnSizing || {});
863
- setColumnOrder(initialStateConfig.columnOrder || []);
864
- setColumnPinning(initialStateConfig.columnPinning || { left: [], right: [] });
865
-
866
- const resetOptions = normalizeRefreshOptions({
867
- resetPagination: true,
868
- force: true,
869
- reason: 'reset',
870
- }, 'reset');
871
-
872
- void fetchData(resetState, {
873
- delay: 0,
874
- meta: {
875
- reason: resetOptions.reason,
876
- force: resetOptions.force,
877
- },
878
- });
879
- }, [getResetState, initialSelectionState, initialStateConfig, onPaginationChange, normalizeRefreshOptions, fetchData]);
880
-
881
- const setExportControllerSafely = useCallback((
882
- value: AbortController | null | ((current: AbortController | null) => AbortController | null)
883
- ) => {
884
- setExportController((current) => {
885
- const next = typeof value === 'function' ? (value as any)(current) : value;
886
- exportControllerRef.current = next;
887
- return next;
888
- });
889
- }, []);
890
-
891
- const handleExportProgressInternal = useCallback((progress: ExportProgressPayload) => {
892
- setExportProgress(progress || {});
893
- onExportProgress?.(progress);
894
- }, [onExportProgress]);
895
-
896
- const handleExportStateChangeInternal = useCallback((state: ExportStateChange) => {
897
- setExportPhase(state.phase);
898
- if (
899
- state.processedRows !== undefined
900
- || state.totalRows !== undefined
901
- || state.percentage !== undefined
902
- ) {
903
- setExportProgress({
904
- processedRows: state.processedRows,
905
- totalRows: state.totalRows,
906
- percentage: state.percentage,
907
- });
908
- }
909
- onExportStateChange?.(state);
910
- }, [onExportStateChange]);
911
-
912
- const runExportWithPolicy = useCallback(
913
- async (
914
- options: {
915
- format: 'csv' | 'excel';
916
- filename: string;
917
- mode: 'client' | 'server';
918
- execute: (controller: AbortController) => Promise<void>;
919
- }
920
- ) => {
921
- const { format, filename, mode, execute } = options;
922
-
923
- const startExecution = async () => {
924
- const controller = new AbortController();
925
- setExportProgress({});
926
- setExportControllerSafely(controller);
927
- try {
928
- await execute(controller);
929
- } finally {
930
- setExportControllerSafely((current) => (current === controller ? null : current));
931
- }
932
- };
933
-
934
- if (exportConcurrency === 'queue') {
935
- setQueuedExportCount((prev) => prev + 1);
936
- const runQueued = async (): Promise<void> => {
937
- setQueuedExportCount((prev) => Math.max(0, prev - 1));
938
- await startExecution();
939
- };
940
- const queuedPromise = exportQueueRef.current
941
- .catch(() => undefined)
942
- .then(runQueued);
943
- exportQueueRef.current = queuedPromise;
944
- return queuedPromise;
945
- }
946
-
947
- const activeController = exportControllerRef.current;
948
- if (activeController) {
949
- if (exportConcurrency === 'ignoreIfRunning') {
950
- handleExportStateChangeInternal({
951
- phase: 'error',
952
- mode,
953
- format,
954
- filename,
955
- message: 'An export is already running',
956
- code: 'EXPORT_IN_PROGRESS',
957
- endedAt: Date.now(),
958
- });
959
- onExportError?.({
960
- message: 'An export is already running',
961
- code: 'EXPORT_IN_PROGRESS',
962
- });
963
- return;
964
- }
965
-
966
- if (exportConcurrency === 'cancelAndRestart') {
967
- activeController.abort();
968
- }
969
- }
970
-
971
- await startExecution();
972
- },
973
- [
974
- exportConcurrency,
975
- handleExportStateChangeInternal,
976
- onExportError,
977
- setExportControllerSafely,
978
- ]
979
- );
980
-
981
- const dataTableApi = useMemo(() => {
982
- // helpers (avoid repeating boilerplate)
983
- const buildInitialOrder = () =>
984
- enhancedColumns.map((col, index) => {
985
- if ((col as any).id) return (col as any).id as string;
986
- const anyCol = col as any;
987
- if (anyCol.accessorKey && typeof anyCol.accessorKey === "string") return anyCol.accessorKey;
988
- return `column_${index}`;
989
- });
990
-
991
- const applyColumnOrder = (next: ColumnOrderState) => {
992
- // handleColumnOrderChange supports both Updater<ColumnOrderState> and array in your impl
993
- handleColumnOrderChange(next as any);
994
- };
995
-
996
- const applyPinning = (next: ColumnPinningState) => {
997
- handleColumnPinningChange(next as any);
998
- };
999
-
1000
- const applyVisibility = (next: Record<string, boolean>) => {
1001
- handleColumnVisibilityChange(next as any);
1002
- };
1003
-
1004
- const applySizing = (next: Record<string, number>) => {
1005
- handleColumnSizingChange(next as any);
1006
- };
1007
-
1008
- const applyPagination = (next: any) => {
1009
- handlePaginationChange(next);
1010
- };
1011
-
1012
- const applySorting = (next: any) => {
1013
- handleSortingChange(next);
1014
- };
1015
-
1016
- const applyGlobalFilter = (next: any) => {
1017
- handleGlobalFilterChange(next);
1018
- };
1019
-
1020
- const getRowIndexById = (rowsToSearch: T[], rowId: string) =>
1021
- rowsToSearch.findIndex((row, index) => String(generateRowId(row, index, idKey)) === rowId);
1022
-
1023
- const clampInsertIndex = (rowsToMutate: T[], insertIndex?: number) => {
1024
- if (insertIndex === undefined) return rowsToMutate.length;
1025
- return Math.max(0, Math.min(insertIndex, rowsToMutate.length));
1026
- };
1027
-
1028
- return {
1029
- table: {
1030
- getTable: () => table,
1031
- },
1032
-
1033
- // -------------------------------
1034
- // Column Management
1035
- // -------------------------------
1036
- columnVisibility: {
1037
- showColumn: (columnId: string) => {
1038
- applyVisibility({ ...table.getState().columnVisibility, [columnId]: true });
1039
- },
1040
- hideColumn: (columnId: string) => {
1041
- applyVisibility({ ...table.getState().columnVisibility, [columnId]: false });
1042
- },
1043
- toggleColumn: (columnId: string) => {
1044
- const curr = table.getState().columnVisibility?.[columnId] ?? true;
1045
- applyVisibility({ ...table.getState().columnVisibility, [columnId]: !curr });
1046
- },
1047
- showAllColumns: () => {
1048
- // set all known columns true
1049
- const all: Record<string, boolean> = {};
1050
- table.getAllLeafColumns().forEach((c) => (all[c.id] = true));
1051
- applyVisibility(all);
1052
- },
1053
- hideAllColumns: () => {
1054
- const all: Record<string, boolean> = {};
1055
- table.getAllLeafColumns().forEach((c) => (all[c.id] = false));
1056
- applyVisibility(all);
1057
- },
1058
- resetColumnVisibility: () => {
1059
- const initialVisibility = initialStateConfig.columnVisibility || {};
1060
- applyVisibility(initialVisibility);
1061
- },
1062
- },
1063
-
1064
- // -------------------------------
1065
- // Column Ordering
1066
- // -------------------------------
1067
- columnOrdering: {
1068
- setColumnOrder: (nextOrder: ColumnOrderState) => {
1069
- applyColumnOrder(nextOrder);
1070
- },
1071
- moveColumn: (columnId: string, toIndex: number) => {
1072
- const currentOrder =
1073
- (table.getState().columnOrder?.length ? table.getState().columnOrder : buildInitialOrder()) || [];
1074
- const fromIndex = currentOrder.indexOf(columnId);
1075
- if (fromIndex === -1) return;
1076
-
1077
- const next = [...currentOrder];
1078
- next.splice(fromIndex, 1);
1079
- next.splice(toIndex, 0, columnId);
1080
-
1081
- applyColumnOrder(next);
1082
- },
1083
- resetColumnOrder: () => {
1084
- applyColumnOrder(buildInitialOrder());
1085
- },
1086
- },
1087
-
1088
- // -------------------------------
1089
- // Column Pinning
1090
- // -------------------------------
1091
- columnPinning: {
1092
- pinColumnLeft: (columnId: string) => {
1093
- const current = table.getState().columnPinning || { left: [], right: [] };
1094
- const next: ColumnPinningState = {
1095
- left: [...(current.left || []).filter((id) => id !== columnId), columnId],
1096
- right: (current.right || []).filter((id) => id !== columnId),
1097
- };
1098
- applyPinning(next);
1099
- },
1100
- pinColumnRight: (columnId: string) => {
1101
- const current = table.getState().columnPinning || { left: [], right: [] };
1102
- const next: ColumnPinningState = {
1103
- left: (current.left || []).filter((id) => id !== columnId),
1104
- // keep your "prepend" behavior
1105
- right: [columnId, ...(current.right || []).filter((id) => id !== columnId)],
1106
- };
1107
- applyPinning(next);
1108
- },
1109
- unpinColumn: (columnId: string) => {
1110
- const current = table.getState().columnPinning || { left: [], right: [] };
1111
- const next: ColumnPinningState = {
1112
- left: (current.left || []).filter((id) => id !== columnId),
1113
- right: (current.right || []).filter((id) => id !== columnId),
1114
- };
1115
- applyPinning(next);
1116
- },
1117
- setPinning: (pinning: ColumnPinningState) => {
1118
- applyPinning(pinning);
1119
- },
1120
- resetColumnPinning: () => {
1121
- const initialPinning = initialStateConfig.columnPinning || { left: [], right: [] };
1122
- applyPinning(initialPinning);
1123
- },
1124
- },
1125
-
1126
- // -------------------------------
1127
- // Column Resizing
1128
- // -------------------------------
1129
- columnResizing: {
1130
- resizeColumn: (columnId: string, width: number) => {
1131
- const currentSizing = table.getState().columnSizing || {};
1132
- applySizing({ ...currentSizing, [columnId]: width });
1133
- },
1134
- autoSizeColumn: (columnId: string) => {
1135
- // safe to call tanstack helper; it will feed into onColumnSizingChange if wired,
1136
- // but since you're controlled, we still prefer to update through handler:
1137
- const col = table.getColumn(columnId);
1138
- if (!col) return;
1139
-
1140
- col.resetSize();
1141
- // after resetSize, read state and emit via handler so controlled stays synced
1142
- applySizing({ ...(table.getState().columnSizing || {}) });
1143
- },
1144
- autoSizeAllColumns: () => {
1145
- const initialSizing = initialStateConfig.columnSizing || {};
1146
- applySizing(initialSizing);
1147
- },
1148
- resetColumnSizing: () => {
1149
- const initialSizing = initialStateConfig.columnSizing || {};
1150
- applySizing(initialSizing);
1151
- },
1152
- },
1153
-
1154
- // -------------------------------
1155
- // Filtering
1156
- // -------------------------------
1157
- filtering: {
1158
- setGlobalFilter: (filter: string) => {
1159
- applyGlobalFilter(filter);
1160
- },
1161
- clearGlobalFilter: () => {
1162
- applyGlobalFilter("");
1163
- },
1164
- setColumnFilters: (filters: ColumnFilterState, isApply = false) => {
1165
- handleColumnFilterChangeHandler(filters, isApply);
1166
- },
1167
- addColumnFilter: (columnId: string, operator: string, value: any) => {
1168
- const newFilter = {
1169
- id: `filter_${Date.now()}`,
1170
- columnId,
1171
- operator,
1172
- value,
1173
- };
1174
-
1175
- const current = table.getState().columnFilter;
1176
- const currentFilters = current?.filters || [];
1177
- const nextFilters = [...currentFilters, newFilter];
1178
- const nextPendingFilters = [...(current?.pendingFilters || []), newFilter];
1179
-
1180
- handleColumnFilterChangeHandler({
1181
- filters: nextFilters,
1182
- logic: current?.logic,
1183
- pendingFilters: nextPendingFilters,
1184
- pendingLogic: current?.pendingLogic || "AND",
1185
- }, true);
1186
-
1187
- if (logger.isLevelEnabled("debug")) {
1188
- logger.debug(`Adding column filter ${columnId} ${operator} ${value}`, nextFilters);
1189
- }
1190
- },
1191
- removeColumnFilter: (filterId: string) => {
1192
- const current = table.getState().columnFilter;
1193
- const currentFilters = current?.filters || [];
1194
- const isApplied = current?.pendingFilters?.some((f: any) => f.id === filterId);
1195
- const nextFilters = currentFilters.filter((f: any) => f.id !== filterId);
1196
- const nextPendingFilters = current?.pendingFilters?.filter((f: any) => f.id !== filterId) || [];
1197
- handleColumnFilterChangeHandler({
1198
- filters: nextFilters,
1199
- logic: current?.logic,
1200
- pendingFilters: nextPendingFilters,
1201
- pendingLogic: current?.pendingLogic || "AND",
1202
- }, isApplied);
1203
-
1204
- if (logger.isLevelEnabled("debug")) {
1205
- logger.debug(`Removing column filter ${filterId}`, nextFilters);
1206
- }
1207
- },
1208
- clearAllFilters: () => {
1209
- applyGlobalFilter("");
1210
- const isApplied = table.getState().columnFilter?.filters?.length > 0;
1211
- handleColumnFilterChangeHandler({
1212
- filters: [],
1213
- logic: "AND",
1214
- pendingFilters: [],
1215
- pendingLogic: "AND",
1216
- }, isApplied);
1217
- },
1218
- resetFilters: () => {
1219
- const isApplied = table.getState().columnFilter?.filters?.length > 0;
1220
- handleColumnFilterChangeHandler({
1221
- filters: [],
1222
- logic: "AND",
1223
- pendingFilters: [],
1224
- pendingLogic: "AND",
1225
- }, isApplied);
1226
-
1227
- if (logger.isLevelEnabled("debug")) {
1228
- logger.debug("Resetting filters");
1229
- }
1230
- },
1231
- },
1232
-
1233
- // -------------------------------
1234
- // Sorting
1235
- // -------------------------------
1236
- sorting: {
1237
- setSorting: (sortingState: SortingState) => {
1238
- applySorting(sortingState);
1239
- if (logger.isLevelEnabled("debug")) logger.debug("Setting sorting", sortingState);
1240
- },
1241
-
1242
- // NOTE: toggleSorting is okay, but can become "one behind" in controlled server mode.
1243
- // So we implement deterministic sorting through handler.
1244
- sortColumn: (columnId: string, direction: "asc" | "desc" | false) => {
1245
- const current = table.getState().sorting || [];
1246
- const filtered = current.filter((s: any) => s.id !== columnId);
1247
-
1248
- if (direction === false) {
1249
- applySorting(filtered);
1250
- return;
1251
- }
1252
-
1253
- applySorting([{ id: columnId, desc: direction === "desc" }, ...filtered]);
1254
- },
1255
-
1256
- clearSorting: () => {
1257
- applySorting([]);
1258
- },
1259
- resetSorting: () => {
1260
- const initialSorting = initialStateConfig.sorting || [];
1261
- applySorting(initialSorting);
1262
- },
1263
- },
1264
-
1265
- // -------------------------------
1266
- // Pagination
1267
- // -------------------------------
1268
- pagination: {
1269
- goToPage: (pageIndex: number) => {
1270
- applyPagination((prev: any) => ({ ...prev, pageIndex }));
1271
- if (logger.isLevelEnabled("debug")) logger.debug(`Going to page ${pageIndex}`);
1272
- },
1273
- nextPage: () => {
1274
- applyPagination((prev: any) => ({ ...prev, pageIndex: (prev?.pageIndex ?? 0) + 1 }));
1275
- if (logger.isLevelEnabled("debug")) logger.debug("Next page");
1276
- },
1277
- previousPage: () => {
1278
- applyPagination((prev: any) => ({ ...prev, pageIndex: Math.max(0, (prev?.pageIndex ?? 0) - 1) }));
1279
- if (logger.isLevelEnabled("debug")) logger.debug("Previous page");
1280
- },
1281
- setPageSize: (pageSize: number) => {
1282
- // usually want pageIndex reset
1283
- applyPagination(() => ({ pageIndex: 0, pageSize }));
1284
- if (logger.isLevelEnabled("debug")) logger.debug(`Setting page size to ${pageSize}`);
1285
- },
1286
- goToFirstPage: () => {
1287
- applyPagination((prev: any) => ({ ...prev, pageIndex: 0 }));
1288
- if (logger.isLevelEnabled("debug")) logger.debug("Going to first page");
1289
- },
1290
- goToLastPage: () => {
1291
- // pageCount can be derived; keep safe fallback
1292
- const pageCount = table.getPageCount?.() ?? 0;
1293
- if (pageCount > 0) {
1294
- applyPagination((prev: any) => ({ ...prev, pageIndex: pageCount - 1 }));
1295
- if (logger.isLevelEnabled("debug")) logger.debug(`Going to last page ${pageCount - 1}`);
1296
- }
1297
- },
1298
- resetPagination: () => {
1299
- const initialPagination = initialStateConfig.pagination || { pageIndex: 0, pageSize: 10 };
1300
- applyPagination(initialPagination);
1301
- },
1302
- },
1303
-
1304
- // -------------------------------
1305
- // Selection
1306
- // -------------------------------
1307
- selection: {
1308
- selectRow: (rowId: string) => table.selectRow?.(rowId),
1309
- deselectRow: (rowId: string) => table.deselectRow?.(rowId),
1310
- toggleRowSelection: (rowId: string) => table.toggleRowSelected?.(rowId),
1311
- selectAll: () => table.selectAll?.(),
1312
- deselectAll: () => table.deselectAll?.(),
1313
- toggleSelectAll: () => table.toggleAllRowsSelected?.(),
1314
- getSelectionState: () => table.getSelectionState?.() || ({ ids: [], type: "include" } as const),
1315
- getSelectedRows: () => table.getSelectedRows(),
1316
- getSelectedCount: () => table.getSelectedCount(),
1317
- isRowSelected: (rowId: string) => table.getIsRowSelected(rowId) || false,
1318
- },
1319
-
1320
- // -------------------------------
1321
- // Data Management (kept same, but ensure state changes go through handlers)
1322
- // -------------------------------
1323
- data: {
1324
- refresh: (options?: boolean | DataRefreshOptions) => {
1325
- void triggerRefresh(options, 'refresh');
1326
- },
1327
-
1328
- reload: (options: DataRefreshOptions = {}) => {
1329
- void triggerRefresh(
1330
- {
1331
- ...options,
1332
- resetPagination: options.resetPagination ?? false,
1333
- reason: options.reason ?? 'reload',
1334
- },
1335
- 'reload'
1336
- );
1337
- },
1338
-
1339
- resetAll: () => resetAllAndReload(),
1340
-
1341
- getAllData: () => [...tableData],
1342
- getRowData: (rowId: string) => {
1343
- const rowIndex = getRowIndexById(tableData, rowId);
1344
- return rowIndex === -1 ? undefined : tableData[rowIndex];
1345
- },
1346
- getRowByIndex: (index: number) => tableData[index],
1347
-
1348
- updateRow: (rowId: string, updates: Partial<T>) => {
1349
- applyDataMutation('updateRow', (rowsToMutate) => {
1350
- const rowIndex = getRowIndexById(rowsToMutate, rowId);
1351
- if (rowIndex === -1) return rowsToMutate;
1352
- const nextData = [...rowsToMutate];
1353
- nextData[rowIndex] = { ...nextData[rowIndex], ...updates };
1354
- return nextData;
1355
- }, { rowId });
1356
- },
1357
-
1358
- updateRowByIndex: (index: number, updates: Partial<T>) => {
1359
- applyDataMutation('updateRowByIndex', (rowsToMutate) => {
1360
- if (!rowsToMutate[index]) return rowsToMutate;
1361
- const nextData = [...rowsToMutate];
1362
- nextData[index] = { ...nextData[index], ...updates };
1363
- return nextData;
1364
- }, { index });
1365
- },
1366
-
1367
- insertRow: (newRow: T, index?: number) => {
1368
- applyDataMutation('insertRow', (rowsToMutate) => {
1369
- const nextData = [...rowsToMutate];
1370
- nextData.splice(clampInsertIndex(nextData, index), 0, newRow);
1371
- return nextData;
1372
- }, { index });
1373
- },
1374
-
1375
- deleteRow: (rowId: string) => {
1376
- applyDataMutation('deleteRow', (rowsToMutate) => {
1377
- const rowIndex = getRowIndexById(rowsToMutate, rowId);
1378
- if (rowIndex === -1) return rowsToMutate;
1379
- const nextData = [...rowsToMutate];
1380
- nextData.splice(rowIndex, 1);
1381
- return nextData;
1382
- }, { rowId });
1383
- },
1384
-
1385
- deleteRowByIndex: (index: number) => {
1386
- applyDataMutation('deleteRowByIndex', (rowsToMutate) => {
1387
- if (index < 0 || index >= rowsToMutate.length) return rowsToMutate;
1388
- const nextData = [...rowsToMutate];
1389
- nextData.splice(index, 1);
1390
- return nextData;
1391
- }, { index });
1392
- },
1393
-
1394
- deleteSelectedRows: () => {
1395
- const currentSelection = table.getSelectionState?.() || selectionState;
1396
- const selectedIds = new Set((currentSelection.ids || []).map((id) => String(id)));
1397
- const loadedRowIds = tableData.map((row, index) => String(generateRowId(row, index, idKey)));
1398
- const deletableRowIds = currentSelection.type === 'exclude'
1399
- ? loadedRowIds.filter((rowId) => !selectedIds.has(rowId))
1400
- : loadedRowIds.filter((rowId) => selectedIds.has(rowId));
1401
-
1402
- if (deletableRowIds.length === 0) return;
1403
- if (
1404
- currentSelection.type === 'exclude'
1405
- && table.getRowCount() > loadedRowIds.length
1406
- && logger.isLevelEnabled('info')
1407
- ) {
1408
- logger.info('deleteSelectedRows in exclude mode removed currently loaded rows only', {
1409
- removedRows: deletableRowIds.length,
1410
- totalSelected: table.getSelectedCount?.(),
1411
- });
1412
- }
1413
-
1414
- const deletableRowIdSet = new Set(deletableRowIds);
1415
- applyDataMutation(
1416
- 'deleteSelectedRows',
1417
- (rowsToMutate) =>
1418
- rowsToMutate.filter((row, index) => !deletableRowIdSet.has(String(generateRowId(row, index, idKey)))),
1419
- { rowIds: deletableRowIds }
1420
- );
1421
- table.deselectAll?.();
1422
- },
1423
-
1424
- replaceAllData: (newData: T[]) => {
1425
- applyDataMutation('replaceAllData', () => [...newData]);
1426
- },
1427
-
1428
- updateMultipleRows: (updates: Array<{ rowId: string; data: Partial<T> }>) => {
1429
- const updateMap = new Map(updates.map((update) => [update.rowId, update.data]));
1430
- applyDataMutation('updateMultipleRows', (rowsToMutate) =>
1431
- rowsToMutate.map((row, index) => {
1432
- const currentRowId = String(generateRowId(row, index, idKey));
1433
- const updateData = updateMap.get(currentRowId);
1434
- return updateData ? { ...row, ...updateData } : row;
1435
- })
1436
- );
1437
- },
1438
-
1439
- insertMultipleRows: (newRows: T[], startIndex?: number) => {
1440
- applyDataMutation('insertMultipleRows', (rowsToMutate) => {
1441
- const nextData = [...rowsToMutate];
1442
- nextData.splice(clampInsertIndex(nextData, startIndex), 0, ...newRows);
1443
- return nextData;
1444
- }, { index: startIndex });
1445
- },
1446
-
1447
- deleteMultipleRows: (rowIds: string[]) => {
1448
- const idsToDelete = new Set(rowIds);
1449
- applyDataMutation(
1450
- 'deleteMultipleRows',
1451
- (rowsToMutate) =>
1452
- rowsToMutate.filter((row, index) => !idsToDelete.has(String(generateRowId(row, index, idKey)))),
1453
- { rowIds }
1454
- );
1455
- },
1456
-
1457
- updateField: (rowId: string, fieldName: keyof T, value: any) => {
1458
- applyDataMutation('updateField', (rowsToMutate) => {
1459
- const rowIndex = getRowIndexById(rowsToMutate, rowId);
1460
- if (rowIndex === -1) return rowsToMutate;
1461
- const nextData = [...rowsToMutate];
1462
- nextData[rowIndex] = { ...nextData[rowIndex], [fieldName]: value };
1463
- return nextData;
1464
- }, { rowId });
1465
- },
1466
-
1467
- updateFieldByIndex: (index: number, fieldName: keyof T, value: any) => {
1468
- applyDataMutation('updateFieldByIndex', (rowsToMutate) => {
1469
- if (!rowsToMutate[index]) return rowsToMutate;
1470
- const nextData = [...rowsToMutate];
1471
- nextData[index] = { ...nextData[index], [fieldName]: value };
1472
- return nextData;
1473
- }, { index });
1474
- },
1475
-
1476
- findRows: (predicate: (row: T) => boolean) => tableData.filter(predicate),
1477
-
1478
- findRowIndex: (predicate: (row: T) => boolean) => tableData.findIndex(predicate),
1479
-
1480
- getDataCount: () => tableData.length,
1481
- getFilteredDataCount: () => table.getFilteredRowModel().rows.length,
1482
- },
1483
-
1484
- // -------------------------------
1485
- // Layout Management
1486
- // -------------------------------
1487
- layout: {
1488
- resetLayout: () => {
1489
- // go through handlers so controlled state updates + emit works
1490
- applySizing(initialStateConfig.columnSizing || {});
1491
- applyVisibility(initialStateConfig.columnVisibility || {});
1492
- applySorting(initialStateConfig.sorting || []);
1493
- applyGlobalFilter(initialStateConfig.globalFilter ?? "");
1494
- },
1495
- resetAll: () => resetAllAndReload(),
1496
- saveLayout: () => ({
1497
- columnVisibility: table.getState().columnVisibility,
1498
- columnSizing: table.getState().columnSizing,
1499
- columnOrder: table.getState().columnOrder,
1500
- columnPinning: table.getState().columnPinning,
1501
- sorting: table.getState().sorting,
1502
- pagination: table.getState().pagination,
1503
- globalFilter: table.getState().globalFilter,
1504
- columnFilter: table.getState().columnFilter,
1505
- }),
1506
- restoreLayout: (layout: Partial<TableState>) => {
1507
- if (layout.columnVisibility) applyVisibility(layout.columnVisibility as any);
1508
- if (layout.columnSizing) applySizing(layout.columnSizing as any);
1509
- if (layout.columnOrder) applyColumnOrder(layout.columnOrder as any);
1510
- if (layout.columnPinning) applyPinning(layout.columnPinning as any);
1511
- if (layout.sorting) applySorting(layout.sorting as any);
1512
- if (layout.pagination && enablePagination) applyPagination(layout.pagination as any);
1513
- if (layout.globalFilter !== undefined) applyGlobalFilter(layout.globalFilter);
1514
- if (layout.columnFilter) handleColumnFilterChangeHandler(layout.columnFilter as any, layout.columnFilter?.filters?.length > 0);
1515
- },
1516
- },
1517
-
1518
- // -------------------------------
1519
- // Table State
1520
- // -------------------------------
1521
- state: {
1522
- getTableState: () => table.getState(),
1523
- getCurrentFilters: () => table.getState().columnFilter,
1524
- getCurrentSorting: () => table.getState().sorting,
1525
- getCurrentPagination: () => table.getState().pagination,
1526
- getCurrentSelection: () => table.getSelectionState?.(),
1527
- },
1528
-
1529
- // -------------------------------
1530
- // Export (unchanged mostly)
1531
- // -------------------------------
1532
- export: {
1533
- exportCSV: async (options: DataTableExportApiOptions = {}) => {
1534
- const {
1535
- filename = exportFilename,
1536
- chunkSize = exportChunkSize,
1537
- strictTotalCheck = exportStrictTotalCheck,
1538
- sanitizeCSV = exportSanitizeCSV,
1539
- } = options;
1540
- const mode: 'client' | 'server' = dataMode === "server" && !!onServerExport ? 'server' : 'client';
1541
-
1542
- await runExportWithPolicy({
1543
- format: 'csv',
1544
- filename,
1545
- mode,
1546
- execute: async (controller) => {
1547
- const toStateChange = (state: {
1548
- phase: ExportPhase;
1549
- processedRows?: number;
1550
- totalRows?: number;
1551
- percentage?: number;
1552
- message?: string;
1553
- code?: string;
1554
- }) => {
1555
- const isFinalPhase = state.phase === 'completed' || state.phase === 'cancelled' || state.phase === 'error';
1556
- handleExportStateChangeInternal({
1557
- phase: state.phase,
1558
- mode,
1559
- format: 'csv',
1560
- filename,
1561
- processedRows: state.processedRows,
1562
- totalRows: state.totalRows,
1563
- percentage: state.percentage,
1564
- message: state.message,
1565
- code: state.code,
1566
- startedAt: state.phase === 'starting' ? Date.now() : undefined,
1567
- endedAt: isFinalPhase ? Date.now() : undefined,
1568
- queueLength: queuedExportCount,
1569
- });
1570
- if (state.phase === 'cancelled') {
1571
- onExportCancel?.();
1572
- }
1573
- };
1574
-
1575
- if (mode === 'server' && onServerExport) {
1576
- const currentFilters = {
1577
- globalFilter: table.getState().globalFilter,
1578
- columnFilter: table.getState().columnFilter,
1579
- sorting: table.getState().sorting,
1580
- pagination: table.getState().pagination,
1581
- };
1582
-
1583
- if (logger.isLevelEnabled("debug")) logger.debug("Server export CSV", { currentFilters });
1584
-
1585
- await exportServerData(table, {
1586
- format: "csv",
1587
- filename,
1588
- fetchData: (filters: any, selection: any, signal?: AbortSignal) =>
1589
- onServerExport(filters, selection, signal),
1590
- currentFilters,
1591
- selection: table.getSelectionState?.(),
1592
- onProgress: handleExportProgressInternal,
1593
- onComplete: onExportComplete,
1594
- onError: onExportError,
1595
- onStateChange: toStateChange,
1596
- signal: controller.signal,
1597
- chunkSize,
1598
- strictTotalCheck,
1599
- sanitizeCSV,
1600
- });
1601
- return;
1602
- }
1603
-
1604
- await exportClientData(table, {
1605
- format: "csv",
1606
- filename,
1607
- onProgress: handleExportProgressInternal,
1608
- onComplete: onExportComplete,
1609
- onError: onExportError,
1610
- onStateChange: toStateChange,
1611
- signal: controller.signal,
1612
- sanitizeCSV,
1613
- });
1614
-
1615
- if (logger.isLevelEnabled("debug")) logger.debug("Client export CSV", filename);
1616
- }
1617
- });
1618
- },
1619
-
1620
- exportExcel: async (options: DataTableExportApiOptions = {}) => {
1621
- const {
1622
- filename = exportFilename,
1623
- chunkSize = exportChunkSize,
1624
- strictTotalCheck = exportStrictTotalCheck,
1625
- sanitizeCSV = exportSanitizeCSV,
1626
- } = options;
1627
- const mode: 'client' | 'server' = dataMode === "server" && !!onServerExport ? 'server' : 'client';
1628
-
1629
- await runExportWithPolicy({
1630
- format: 'excel',
1631
- filename,
1632
- mode,
1633
- execute: async (controller) => {
1634
- const toStateChange = (state: {
1635
- phase: ExportPhase;
1636
- processedRows?: number;
1637
- totalRows?: number;
1638
- percentage?: number;
1639
- message?: string;
1640
- code?: string;
1641
- }) => {
1642
- const isFinalPhase = state.phase === 'completed' || state.phase === 'cancelled' || state.phase === 'error';
1643
- handleExportStateChangeInternal({
1644
- phase: state.phase,
1645
- mode,
1646
- format: 'excel',
1647
- filename,
1648
- processedRows: state.processedRows,
1649
- totalRows: state.totalRows,
1650
- percentage: state.percentage,
1651
- message: state.message,
1652
- code: state.code,
1653
- startedAt: state.phase === 'starting' ? Date.now() : undefined,
1654
- endedAt: isFinalPhase ? Date.now() : undefined,
1655
- queueLength: queuedExportCount,
1656
- });
1657
- if (state.phase === 'cancelled') {
1658
- onExportCancel?.();
1659
- }
1660
- };
1661
-
1662
- if (mode === 'server' && onServerExport) {
1663
- const currentFilters = {
1664
- globalFilter: table.getState().globalFilter,
1665
- columnFilter: table.getState().columnFilter,
1666
- sorting: table.getState().sorting,
1667
- pagination: table.getState().pagination,
1668
- };
1669
-
1670
- if (logger.isLevelEnabled("debug")) logger.debug("Server export Excel", { currentFilters });
1671
-
1672
- await exportServerData(table, {
1673
- format: "excel",
1674
- filename,
1675
- fetchData: (filters: any, selection: any, signal?: AbortSignal) =>
1676
- onServerExport(filters, selection, signal),
1677
- currentFilters,
1678
- selection: table.getSelectionState?.(),
1679
- onProgress: handleExportProgressInternal,
1680
- onComplete: onExportComplete,
1681
- onError: onExportError,
1682
- onStateChange: toStateChange,
1683
- signal: controller.signal,
1684
- chunkSize,
1685
- strictTotalCheck,
1686
- sanitizeCSV,
1687
- });
1688
- return;
1689
- }
1690
-
1691
- await exportClientData(table, {
1692
- format: "excel",
1693
- filename,
1694
- onProgress: handleExportProgressInternal,
1695
- onComplete: onExportComplete,
1696
- onError: onExportError,
1697
- onStateChange: toStateChange,
1698
- signal: controller.signal,
1699
- sanitizeCSV,
1700
- });
1701
-
1702
- if (logger.isLevelEnabled("debug")) logger.debug("Client export Excel", filename);
1703
- }
1704
- });
1705
- },
1706
-
1707
- exportServerData: async (options: {
1708
- format: 'csv' | 'excel';
1709
- filename?: string;
1710
- fetchData?: (
1711
- filters?: Partial<TableState>,
1712
- selection?: SelectionState,
1713
- signal?: AbortSignal
1714
- ) => Promise<any>;
1715
- chunkSize?: number;
1716
- strictTotalCheck?: boolean;
1717
- sanitizeCSV?: boolean;
1718
- }) => {
1719
- const {
1720
- format,
1721
- filename = exportFilename,
1722
- fetchData: fetchFn = onServerExport,
1723
- chunkSize = exportChunkSize,
1724
- strictTotalCheck = exportStrictTotalCheck,
1725
- sanitizeCSV = exportSanitizeCSV,
1726
- } = options;
1727
-
1728
- if (!fetchFn) {
1729
- onExportError?.({ message: "No server export function provided", code: "NO_SERVER_EXPORT" });
1730
- if (logger.isLevelEnabled("debug")) logger.debug("Server export data failed", "No server export function provided");
1731
- return;
1732
- }
1733
-
1734
- await runExportWithPolicy({
1735
- format,
1736
- filename,
1737
- mode: 'server',
1738
- execute: async (controller) => {
1739
- const currentFilters = {
1740
- globalFilter: table.getState().globalFilter,
1741
- columnFilter: table.getState().columnFilter,
1742
- sorting: table.getState().sorting,
1743
- pagination: table.getState().pagination,
1744
- };
1745
-
1746
- if (logger.isLevelEnabled("debug")) logger.debug("Server export data", { currentFilters });
1747
-
1748
- await exportServerData(table, {
1749
- format,
1750
- filename,
1751
- fetchData: (filters: any, selection: any, signal?: AbortSignal) =>
1752
- fetchFn(filters, selection, signal),
1753
- currentFilters,
1754
- selection: table.getSelectionState?.(),
1755
- onProgress: handleExportProgressInternal,
1756
- onComplete: onExportComplete,
1757
- onError: onExportError,
1758
- onStateChange: (state) => {
1759
- const isFinalPhase = state.phase === 'completed' || state.phase === 'cancelled' || state.phase === 'error';
1760
- handleExportStateChangeInternal({
1761
- phase: state.phase,
1762
- mode: 'server',
1763
- format,
1764
- filename,
1765
- processedRows: state.processedRows,
1766
- totalRows: state.totalRows,
1767
- percentage: state.percentage,
1768
- message: state.message,
1769
- code: state.code,
1770
- startedAt: state.phase === 'starting' ? Date.now() : undefined,
1771
- endedAt: isFinalPhase ? Date.now() : undefined,
1772
- queueLength: queuedExportCount,
1773
- });
1774
- if (state.phase === 'cancelled') {
1775
- onExportCancel?.();
1776
- }
1777
- },
1778
- signal: controller.signal,
1779
- chunkSize,
1780
- strictTotalCheck,
1781
- sanitizeCSV,
1782
- });
1783
- }
1784
- });
1785
- },
1786
-
1787
- isExporting: () => isExporting || false,
1788
- cancelExport: () => {
1789
- const activeController = exportControllerRef.current;
1790
- if (!activeController) {
1791
- return;
1792
- }
1793
- activeController.abort();
1794
- setExportControllerSafely((current) => (current === activeController ? null : current));
1795
- if (logger.isLevelEnabled("debug")) logger.debug("Export cancelled");
1796
- },
1797
- },
1798
- };
1799
- }, [
1800
- table,
1801
- enhancedColumns,
1802
- handleColumnOrderChange,
1803
- handleColumnPinningChange,
1804
- handleColumnVisibilityChange,
1805
- handleColumnSizingChange,
1806
- handlePaginationChange,
1807
- handleSortingChange,
1808
- handleGlobalFilterChange,
1809
- handleColumnFilterChangeHandler,
1810
- initialStateConfig,
1811
- enablePagination,
1812
- idKey,
1813
- triggerRefresh,
1814
- applyDataMutation,
1815
- tableData,
1816
- selectionState,
1817
- // export
1818
- exportFilename,
1819
- exportChunkSize,
1820
- exportStrictTotalCheck,
1821
- exportSanitizeCSV,
1822
- onExportComplete,
1823
- onExportError,
1824
- onExportCancel,
1825
- onServerExport,
1826
- queuedExportCount,
1827
- isExporting,
1828
- dataMode,
1829
- handleExportProgressInternal,
1830
- handleExportStateChangeInternal,
1831
- runExportWithPolicy,
1832
- setExportControllerSafely,
1833
- logger,
1834
- resetAllAndReload,
1835
- ]);
1836
-
1837
- internalApiRef.current = dataTableApi;
1838
-
1839
- useImperativeHandle(ref, () => dataTableApi, [dataTableApi]);
1840
-
1841
-
1842
- // -------------------------------
1843
- // Render table rows with slot support (callback)
1844
- // -------------------------------
1845
- const renderTableRows = useCallback(() => {
1846
- if (tableLoading) {
1847
- const { component: LoadingRowComponent, props: loadingRowProps } = getSlotComponentWithProps(
1848
- slots,
1849
- slotProps || {},
1850
- 'loadingRow',
1851
- LoadingRows,
1852
- {}
1853
- );
1854
- return (
1855
- <LoadingRowComponent
1856
- rowCount={enablePagination ? Math.min(pagination.pageSize, skeletonRows) : skeletonRows}
1857
- colSpan={table.getAllColumns().length}
1858
- slots={slots}
1859
- slotProps={slotProps}
1860
- {...loadingRowProps}
1861
- />
1862
- );
1863
- }
1864
- if (rows.length === 0) {
1865
- const { component: EmptyRowComponent, props: emptyRowProps } = getSlotComponentWithProps(
1866
- slots,
1867
- slotProps || {},
1868
- 'emptyRow',
1869
- EmptyDataRow,
1870
- {}
1871
- );
1872
- return (
1873
- <EmptyRowComponent
1874
- colSpan={table.getAllColumns().length}
1875
- message={emptyMessage}
1876
- slots={slots}
1877
- slotProps={slotProps}
1878
- {...emptyRowProps}
1879
- />
1880
- );
1881
- }
1882
- if (enableVirtualization && !enablePagination && rows.length > 0) {
1883
- const virtualItems = rowVirtualizer.getVirtualItems();
1884
- return (
1885
- <>
1886
- {virtualItems.length > 0 && (
1887
- <tr>
1888
- <td
1889
- colSpan={table.getAllColumns().length}
1890
- style={{
1891
- height: `${virtualItems[0]?.start ?? 0}px`,
1892
- padding: 0,
1893
- border: 0,
1894
- }}
1895
- />
1896
- </tr>
1897
- )}
1898
- {virtualItems.map((virtualRow) => {
1899
- const row = rows[virtualRow.index];
1900
- if (!row) return null;
1901
- return (
1902
- <DataTableRow
1903
- key={row.id}
1904
- row={row}
1905
- enableHover={enableHover}
1906
- enableStripes={enableStripes}
1907
- isOdd={virtualRow.index % 2 === 1}
1908
- renderSubComponent={renderSubComponent}
1909
- disableStickyHeader={enableStickyHeaderOrFooter}
1910
- onRowClick={onRowClick}
1911
- selectOnRowClick={selectOnRowClick}
1912
- slots={slots}
1913
- slotProps={slotProps}
1914
- />
1915
- );
1916
- })}
1917
- {virtualItems.length > 0 && (
1918
- <tr>
1919
- <td
1920
- colSpan={table.getAllColumns().length}
1921
- style={{
1922
- height: `${rowVirtualizer.getTotalSize() -
1923
- (virtualItems[virtualItems.length - 1]?.end ?? 0)}px`,
1924
- padding: 0,
1925
- border: 0,
1926
- }}
1927
- />
1928
- </tr>
1929
- )}
1930
- </>
1931
- );
1932
- }
1933
- return rows.map((row, index) => (
1934
- <DataTableRow
1935
- key={row.id}
1936
- row={row}
1937
- enableHover={enableHover}
1938
- enableStripes={enableStripes}
1939
- isOdd={index % 2 === 1}
1940
- renderSubComponent={renderSubComponent}
1941
- disableStickyHeader={enableStickyHeaderOrFooter}
1942
- onRowClick={onRowClick}
1943
- selectOnRowClick={selectOnRowClick}
1944
- slots={slots}
1945
- slotProps={slotProps}
1946
- />
1947
- ));
1948
- }, [
1949
- tableLoading,
1950
- rows,
1951
- enableVirtualization,
1952
- enablePagination,
1953
- pagination.pageSize,
1954
- skeletonRows,
1955
- table,
1956
- slotProps,
1957
- emptyMessage,
1958
- rowVirtualizer,
1959
- enableHover,
1960
- enableStripes,
1961
- renderSubComponent,
1962
- enableStickyHeaderOrFooter,
1963
- onRowClick,
1964
- selectOnRowClick,
1965
- slots,
1966
- ]);
1967
-
1968
- // -------------------------------
1969
- // Export cancel callback
1970
- // -------------------------------
1971
- const handleCancelExport = useCallback(() => {
1972
- const activeController = exportControllerRef.current;
1973
- if (activeController) {
1974
- activeController.abort();
1975
- setExportControllerSafely((current) => (current === activeController ? null : current));
1976
- }
1977
- }, [setExportControllerSafely]);
1978
-
1979
- // -------------------------------
1980
- // Slot components
1981
- // -------------------------------
1982
- const { component: RootComponent, props: rootSlotProps } = getSlotComponentWithProps(
1983
- slots,
1984
- slotProps || {},
1985
- 'root',
1986
- Box,
1987
- {}
1988
- );
1989
- const { component: ToolbarComponent, props: toolbarSlotProps } = getSlotComponentWithProps(
1990
- slots,
1991
- slotProps || {},
1992
- 'toolbar',
1993
- DataTableToolbar,
1994
- {}
1995
- );
1996
- const { component: BulkActionsComponent, props: bulkActionsSlotProps } = getSlotComponentWithProps(
1997
- slots,
1998
- slotProps || {},
1999
- 'bulkActionsToolbar',
2000
- BulkActionsToolbar,
2001
- {}
2002
- );
2003
- const { component: TableContainerComponent, props: tableContainerSlotProps } = getSlotComponentWithProps(
2004
- slots,
2005
- slotProps || {},
2006
- 'tableContainer',
2007
- TableContainer,
2008
- {}
2009
- );
2010
- const { component: TableComponent, props: tableComponentSlotProps } = getSlotComponentWithProps(
2011
- slots,
2012
- slotProps || {},
2013
- 'table',
2014
- Table,
2015
- {}
2016
- );
2017
- const { component: BodyComponent, props: bodySlotProps } = getSlotComponentWithProps(
2018
- slots,
2019
- slotProps || {},
2020
- 'body',
2021
- TableBody,
2022
- {}
2023
- );
2024
- const { component: FooterComponent, props: footerSlotProps } = getSlotComponentWithProps(
2025
- slots,
2026
- slotProps || {},
2027
- 'footer',
2028
- Box,
2029
- {}
2030
- );
2031
- const { component: PaginationComponent, props: paginationSlotProps } = getSlotComponentWithProps(
2032
- slots,
2033
- slotProps || {},
2034
- 'pagination',
2035
- DataTablePagination,
2036
- {}
2037
- );
2038
-
2039
- // -------------------------------
2040
- // Render
2041
- // -------------------------------
2042
24
  return (
2043
- <DataTableProvider
2044
- table={table}
2045
- apiRef={internalApiRef}
2046
- dataMode={dataMode}
2047
- tableSize={tableSize}
2048
- onTableSizeChange={(size) => {
2049
- setTableSize(size);
2050
- }}
2051
- columnFilter={columnFilter}
2052
- onChangeColumnFilter={handleColumnFilterChangeHandler}
2053
- slots={slots}
2054
- slotProps={slotProps}
2055
- isExporting={isExporting}
2056
- exportController={exportController}
2057
- exportPhase={exportPhase}
2058
- exportProgress={exportProgress}
2059
- onCancelExport={handleCancelExport}
2060
- exportFilename={exportFilename}
2061
- onExportProgress={onExportProgress}
2062
- onExportComplete={onExportComplete}
2063
- onExportError={onExportError}
2064
- onServerExport={onServerExport}
2065
- >
2066
- <RootComponent
2067
- {...rootSlotProps}
2068
- >
2069
- {/* Toolbar */}
2070
- {(enableGlobalFilter || extraFilter) ? (
2071
- <ToolbarComponent
2072
- extraFilter={extraFilter}
2073
- enableGlobalFilter={enableGlobalFilter}
2074
- enableColumnVisibility={enableColumnVisibility}
2075
- enableColumnFilter={enableColumnFilter}
2076
- enableExport={enableExport}
2077
- enableReset={enableReset}
2078
- enableTableSizeControl={enableTableSizeControl}
2079
- enableColumnPinning={enableColumnPinning}
2080
- enableRefresh={enableRefresh}
2081
- {...toolbarSlotProps}
2082
- refreshButtonProps={{
2083
- loading: tableLoading, // disable while fetching
2084
- showSpinnerWhileLoading: false,
2085
- onRefresh: () => internalApiRef.current?.data?.refresh?.(true),
2086
- ...toolbarSlotProps.refreshButtonProps,
2087
- }}
2088
-
2089
- />
2090
- ) : null}
2091
-
2092
- {/* Bulk Actions Toolbar - shown when rows are selected */}
2093
- {enableBulkActions && enableRowSelection && isSomeRowsSelected ? (
2094
- <BulkActionsComponent
2095
- selectionState={selectionState}
2096
- selectedRowCount={selectedRowCount}
2097
- bulkActions={bulkActions}
2098
- sx={{
2099
- position: 'relative',
2100
- zIndex: 2,
2101
- ...bulkActionsSlotProps.sx,
2102
- }}
2103
- {...bulkActionsSlotProps}
2104
- />
2105
- ) : null}
2106
-
2107
- {/* Table Container */}
2108
- <TableContainerComponent
2109
- component={Paper}
2110
- ref={tableContainerRef}
2111
- sx={{
2112
- width: '100%',
2113
- overflowX: 'auto',
2114
- ...(enableStickyHeaderOrFooter && {
2115
- maxHeight: maxHeight,
2116
- overflowY: 'auto',
2117
- }),
2118
- ...(enableVirtualization && {
2119
- maxHeight: maxHeight,
2120
- overflowY: 'auto',
2121
- }),
2122
- ...tableContainerSlotProps?.sx,
2123
- }}
2124
- {...tableContainerSlotProps}
2125
- >
2126
- <TableComponent
2127
- size={tableSize}
2128
- stickyHeader={enableStickyHeaderOrFooter}
2129
- style={{
2130
- ...tableStyle,
2131
- ...tableProps?.style,
2132
- }}
2133
- {...mergeSlotProps(tableProps || {}, tableComponentSlotProps)}
2134
- >
2135
- {useFixedLayout ? (
2136
- <colgroup>
2137
- {visibleLeafColumns.map((column) => (
2138
- <col
2139
- key={column.id}
2140
- style={{
2141
- width: column.getSize(),
2142
- minWidth: column.columnDef.minSize,
2143
- maxWidth: column.columnDef.maxSize,
2144
- }}
2145
- />
2146
- ))}
2147
- </colgroup>
2148
- ) : null}
2149
- {/* Table Headers */}
2150
- <TableHeader
2151
- draggable={enableColumnDragging}
2152
- enableColumnResizing={enableColumnResizing}
2153
- enableStickyHeader={enableStickyHeaderOrFooter}
2154
- onColumnReorder={handleColumnReorder}
2155
- slots={slots}
2156
- slotProps={slotProps}
2157
- />
2158
-
2159
- {/* Table Body */}
2160
- <BodyComponent
2161
- {...bodySlotProps}
2162
- >
2163
- {renderTableRows()}
2164
- </BodyComponent>
2165
- </TableComponent>
2166
- </TableContainerComponent>
2167
-
2168
- {/* Pagination */}
2169
- {enablePagination ? (
2170
- <FooterComponent
2171
- sx={{
2172
- ...(enableStickyHeaderOrFooter && {
2173
- position: 'sticky',
2174
- bottom: 0,
2175
- backgroundColor: 'background.paper',
2176
- borderTop: '1px solid',
2177
- borderColor: 'divider',
2178
- zIndex: 1,
2179
- }),
2180
- ...footerSlotProps.sx,
2181
- }}
2182
- {...footerSlotProps}
2183
- >
2184
- <PaginationComponent
2185
- footerFilter={footerFilter}
2186
- pagination={pagination}
2187
- totalRow={tableTotalRow}
2188
- {...paginationSlotProps}
2189
- />
2190
- </FooterComponent>
2191
- ) : null}
2192
- </RootComponent>
25
+ <DataTableProvider {...engine.providerProps}>
26
+ <DataTableView<T> engine={engine} {...props} />
2193
27
  </DataTableProvider>
2194
28
  );
2195
- });
29
+ });