-
-
Notifications
You must be signed in to change notification settings - Fork 534
Expand file tree
/
Copy pathtableOptions.ts
More file actions
2199 lines (2197 loc) · 68.4 KB
/
tableOptions.ts
File metadata and controls
2199 lines (2197 loc) · 68.4 KB
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { type MRT_TableOptions } from 'material-react-table';
export type TableOption = {
defaultValue?: string;
description?: string;
link?: string;
linkText?: string;
tableOption: keyof MRT_TableOptions<TableOption>;
required?: boolean;
source?: 'MRT' | 'TanStack Table' | 'TanStack Virtual' | 'Material UI' | '';
type?: string;
};
export const tableOptions: TableOption[] = [
{
tableOption: '_features',
defaultValue: '',
description: `An array of extra features that you can add to the table instance.`,
link: 'https://tanstack.com/table/latest/docs/guide/custom-features',
linkText: 'TanStack Table Custom Features Docs',
required: false,
source: 'TanStack Table',
type: 'Array<TableFeature>',
},
{
tableOption: 'aggregationFns',
defaultValue: '',
description: `This option allows you to define custom aggregation functions that can be referenced in a column's aggregationFn option by their key`,
link: 'https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfns',
linkText: 'TanStack Table Grouping Docs',
required: false,
source: 'TanStack Table',
type: 'Record<string, AggregationFn>',
},
{
tableOption: 'autoResetAll',
defaultValue: '',
description:
'Set this option to override any of the autoReset... feature options.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#autoresetall',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'autoResetExpanded',
defaultValue: '',
description:
'Enable this setting to automatically reset the expanded state of the table when grouping state changes.',
link: 'https://tanstack.com/table/v8/docs/api/features/expanding#autoresetexpanded',
linkText: 'TanStack Table Expanding Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'autoResetPageIndex',
defaultValue: '',
description:
'If set to true, pagination will be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc.',
link: 'https://tanstack.com/table/v8/docs/api/features/pagination#autoresetpagination',
linkText: 'TanStack Table Pagination Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'columnFilterModeOptions',
defaultValue: '',
description:
'Specify which filter modes are available for every column. Optionally specify this per column as a column option.',
link: '/docs/guides/column-filtering#customize-filter-modes',
linkText: 'MRT Column Filtering Docs',
required: false,
source: 'MRT',
type: 'Array<MRT_FilterOption | string> | null',
},
{
tableOption: 'columnResizeDirection',
defaultValue: "muiTheme.direction || 'ltr'",
description:
'Determines the direction of column resizing. ltr = left to right, rtl = right to left.',
link: 'https://tanstack.com/table/v8/docs/api/features/column-sizing#columnresizedirection',
linkText: 'MRT Column Resizing Docs',
required: false,
source: 'TanStack Table',
type: "'ltr' | 'rtl'",
},
{
tableOption: 'columnResizeMode',
defaultValue: "'onChange'",
description:
'Determines when the columnSizing state is updated. onChange updates the state when the user is dragging the resize handle. onEnd updates the state when the user releases the resize handle.',
link: '/docs/guides/column-resizing#column-resize-mode',
linkText: 'MRT Column Resizing Docs',
required: false,
source: 'MRT',
type: "'onEnd' | 'onChange'",
},
{
tableOption: 'columns',
defaultValue: '',
description: 'The array of column defs to use for the table.',
link: '/docs/api/column-options',
linkText: 'MRT Column Options API Reference',
required: true,
source: 'MRT',
type: 'Array<MRT_ColumnDef<TData>>',
},
{
tableOption: 'columnVirtualizerOptions',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: 'MRT',
type: 'Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>>',
},
{
tableOption: 'columnVirtualizerInstanceRef',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: 'MRT',
type: 'MutableRefObject<Virtualizer | null>',
},
{
tableOption: 'data',
defaultValue: '',
description: `The data for the table to display. This can be an array of anything, but you will need to set up your column definitions to "access" the data. When the data option changes reference (compared via Object.is), the table will reprocess the data. Any other data processing that relies on the core data model (such as grouping, sorting, filtering, etc) will also be reprocessed.`,
link: '/docs/getting-started/usage#creating-data-rows',
linkText: 'Usage Docs',
required: true,
source: 'MRT',
type: 'Array<TData>',
},
{
tableOption: 'debugAll',
defaultValue: 'false',
description:
'Set this option to true to output all debugging information to the console.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#debugall',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'debugColumns',
defaultValue: 'false',
description:
'Set this option to true to output column debugging information to the console.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#debugcolumns',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'debugHeaders',
defaultValue: 'false',
description:
'Set this option to true to output header debugging information to the console.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#debugheaders',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'debugRows',
defaultValue: 'false',
description:
'Set this option to true to output row debugging information to the console.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#debugrows',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'debugTable',
defaultValue: 'false',
description:
'Set this option to true to output table debugging information to the console.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#debugcolumns',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'defaultColumn',
defaultValue: '',
description:
'Default column options to use for all column defs supplied to the table. This is useful for providing default cell/header/footer renderers, sorting/filtering/grouping options, etc.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#defaultcolumn',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: 'Partial<MRT_ColumnDef<TData>>',
},
{
tableOption: 'defaultDisplayColumn',
defaultValue: '',
description:
'Default column options to use for all display column defs supplied to the table. This is useful for providing default cell/header/footer renderers, or turning on or off certain features for all display columns.',
link: '/docs/guides/display-columns',
linkText: 'MRT Display Columns Docs',
required: false,
source: 'MRT',
type: 'Partial<MRT_DisplayColumnDef<TData>>',
},
{
tableOption: 'displayColumnDefOptions',
defaultValue: '',
description:
'Customize and override the column definition options for the built-in display columns. (Select, Expand, Row Actions, etc.)',
link: '/docs/guides/display-columns#display-column-definition-options-prop',
linkText: 'MRT Display Columns Docs',
required: false,
source: 'MRT',
type: '{ [key: string]: MRT_DisplayColumnDef<TData> }',
},
{
tableOption: 'editDisplayMode',
defaultValue: "'modal'",
description:
'You can choose between 5 different built-in editing modes. Edit a row in a modal, or a row inline, just 1 cell at a time, or always have all cells editable.',
link: '/docs/guides/editing#editing-modes',
linkText: 'MRT Editing Docs',
required: false,
source: 'MRT',
type: "'modal' | 'cell' | 'row' | 'table' | 'custom",
},
{
tableOption: 'enableBottomToolbar',
defaultValue: 'true',
description: '',
link: '/docs/guides/customize-toolbars#hide-disable-toolbars',
linkText: 'MRT Customize Toolbars Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableClickToCopy',
defaultValue: 'false',
description: '',
link: '/docs/guides/click-to-copy',
linkText: 'MRT Click to Copy Docs',
required: false,
source: 'MRT',
type: "boolean | 'context-menu' | ((cell: MRT_Cell<TData>) => 'context-menu' | boolean)",
},
{
tableOption: 'enableColumnActions',
defaultValue: 'true',
description: '',
link: '/docs/guides/column-actions',
linkText: 'MRT Column Actions Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnDragging',
defaultValue: 'false',
description: '',
link: '/docs/guides/column-ordering-dnd',
linkText: 'MRT Column Ordering DnD Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnFilterModes',
defaultValue: 'false',
description: '',
link: '/docs/guides/column-filtering#filter-modes',
linkText: 'MRT Column Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnFilters',
defaultValue: 'true',
description: '',
link: '/docs/guides/column-filtering#disable-filtering-features',
linkText: 'MRT Column Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnOrdering',
defaultValue: '',
description: '',
link: '/docs/guides/column-ordering-dnd',
linkText: 'MRT Column Ordering DnD Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnVirtualization',
defaultValue: '',
description:
'Enables column virtualization and creates an MRT_ColumnVirtualizer instance internally. This option CANNOT be enabled conditionally. Other side effects include layoutMode will be set either to "grid" or "grid-no-grow"',
link: '/docs/guides/virtualization#enable-column-virtualization',
linkText: 'MRT Virtualization Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnResizing',
defaultValue: '',
description: '',
link: '/docs/guides/column-resizing',
linkText: 'MRT Column Resizing Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableDensityToggle',
defaultValue: 'true',
description: '',
link: '/docs/guides/density-toggle',
linkText: 'MRT Density Toggle Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableEditing',
defaultValue: '',
description: '',
link: '/docs/guides/editing',
linkText: 'MRT Editing Docs',
required: false,
source: 'MRT',
type: 'boolean | (row: MRT_Row) => boolean',
},
{
tableOption: 'enableExpandAll',
defaultValue: 'true',
description: '',
link: '/docs/guides/expanding-sub-rows',
linkText: 'MRT Expanding Sub Rows Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableExpanding',
defaultValue: '',
description: '',
link: '/docs/guides/expanding-sub-rows',
linkText: 'MRT Expanding Sub Rows Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableFacetedValues',
defaultValue: 'true',
description:
'Enable or disable the calculation of faceted values. Facet values are a list of all unique values in a column. These are useful for advanced filtering components with selection, autocomplete, etc.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#enablefilters',
linkText: 'TanStack Filters Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'enableFilterMatchHighlighting',
defaultValue: 'true',
description:
'Enable or disable highlighting text that matches the filter in the table cells.',
link: '/docs/guides/column-filtering#filter-match-highlighting',
linkText: 'MRT Column Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableFilters',
defaultValue: 'true',
description: 'Enable or disable both the global and column filters.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#enablefilters',
linkText: 'TanStack Filters Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'enableFullScreenToggle',
defaultValue: 'true',
description:
'Enable or disable the full screen toggle feature. Disabling will also hide the full screen toggle button.',
link: '/docs/guides/full-screen-toggle',
linkText: 'MRT Full Screen Toggle Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableGlobalFilter',
defaultValue: 'true',
description: '',
link: '/docs/guides/global-filtering#disable-global-filter-feature',
linkText: 'MRT Global Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableGlobalFilterModes',
defaultValue: 'true',
description: '',
link: '/docs/guides/global-filtering#global-filter-modes',
linkText: 'MRT Global Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableGlobalFilterRankedResults',
defaultValue: 'true',
description: '',
link: '/docs/guides/global-filtering#ranked-results',
linkText: 'MRT Global Filtering Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableGrouping',
defaultValue: '',
description: '',
link: '/docs/guides/aggregation-and-grouping#enable-grouping',
linkText: 'MRT Aggregation and Grouping Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableHiding',
defaultValue: 'true',
description: '',
link: '/docs/guides/column-hiding',
linkText: 'MRT Column Hiding Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableMultiRemove',
defaultValue: '',
description: '',
link: 'https://tanstack.com/table/v8/docs/api/features/sorting#enablemultiremove',
linkText: 'TanStack Sorting Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'enableMultiRowSelection',
defaultValue: 'true',
description:
'If true, the user can select multiple rows at once with a checkbox. If false, the user can only select one row at a time with a radio button.',
link: '/docs/guides/row-selection#single-row-selection',
linkText: 'MRT Row Selection Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableMultiSort',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableKeyboardShortcuts',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enablePagination',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableColumnPinning',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableColumnResetPins',
defaultValue: '',
description:
"Determines if 'Reset Pins' option is available in the Show/Hide columns menu.",
link: '/docs/guides/column-pinning',
linkText: 'MRT Column Pinning Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableColumnUnpinAll',
defaultValue: 'true',
description:
"Determines if 'Unpin All' option is available in the Show/Hide columns menu.",
link: '/docs/guides/column-pinning',
linkText: 'MRT Column Pinning Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableCellActions',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: '((cell: MRT_Cell<TData>) => boolean) | boolean',
},
{
tableOption: 'enableRowActions',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableRowDragging',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableRowNumbers',
defaultValue: '',
description: '',
link: '/docs/guides/row-numbers',
linkText: 'Row Numbers Feature Guide',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableRowOrdering',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableRowPinning',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean | (row: MRT_Row) => boolean',
},
{
tableOption: 'keepPinnedRows',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'rowPinningDisplayMode',
defaultValue: "'sticky'",
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: "'sticky' | 'top' | 'bottom' | 'top-and-bottom' | 'select-sticky' | 'select-top' | 'select-bottom'",
},
{
tableOption: 'enableBatchRowSelection',
defaultValue: 'true',
description:
'If true, the user can select multiple rows at once by holding down the shift key while clicking.',
link: '/docs/guides/row-selection#batch-row-selection',
linkText: 'MRT Row Selection Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableRowSelection',
defaultValue: '',
description:
'Enables row selection either for every row, or on a per-row basis using a function.',
link: '/docs/guides/row-selection#enable-row-selection',
linkText: 'MRT Row Selection Docs',
required: false,
source: 'MRT',
type: 'boolean | (row: MRT_Row) => boolean',
},
{
tableOption: 'enableRowVirtualization',
defaultValue: '',
description:
'Enables row virtualization and creates an MRT_RowVirtualizer instance internally. This option CANNOT be enabled conditionally. Other side effects include layoutMode will be set either to "grid" or "grid-no-grow"',
link: '/docs/guides/virtualization#enable-row-virtualization',
linkText: 'MRT Virtualization Docs',
required: false,
source: 'MRT',
type: 'boolean',
},
{
tableOption: 'enableSelectAll',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableSorting',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableSortingRemoval',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableStickyFooter',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableStickyHeader',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableSubRowSelection',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableTableFooter',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableTableHead',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableToolbarInternalActions',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'enableTopToolbar',
defaultValue: 'true',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'boolean',
},
{
tableOption: 'globalFilterModeOptions',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: 'Array<MRT_FilterOption | string> | null',
},
{
tableOption: 'expandRowsFn',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: '(dataRow: TData) => TData[]', //?
},
{
tableOption: 'filterFns',
defaultValue: '',
description: `This option allows you to define custom filter functions that can be referenced in a column's filterFn option by their key`,
link: 'https://tanstack.com/table/v8/docs/api/features/filters#filterfns',
linkText: 'TanStack Table Filters Docs',
required: false,
source: 'TanStack Table',
type: 'Record<string, FilterFn>',
},
{
tableOption: 'filterFromLeafRows',
defaultValue: 'false',
description: '',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#filterfromleafrows',
linkText: 'TanStack Filtering Docs',
required: false,
source: 'TanStack Table',
type: 'boolean',
},
{
tableOption: 'getColumnCanGlobalFilter',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: '(column: Column<TData, unknown>) => boolean',
},
{
tableOption: 'getCoreRowModel',
defaultValue: '',
description: `Material React Table uses the default core row model function from TanStack Table, but you can override its implementation here. It is called once per table and should return a new function which will calculate and return the row model for the table.`,
link: 'https://tanstack.com/table/v8/docs/api/core/table#getcorerowmodel',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: '(table: Table<TData>) => () => RowModel<TData>',
},
{
tableOption: 'getExpandedRowModel',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: 'MRT',
type: '() => MRT_RowModel<TData>',
},
{
tableOption: 'getFacetedMinMaxValues',
defaultValue: '',
description:
'A function that computes and returns a min/max tuple derived from column.getFacetedRowModel. Useful for displaying faceted result values.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#getfacetedminmaxvalues',
linkText: 'TanStack Table Filters Docs',
required: false,
source: 'TanStack Table',
type: '() => Map<any, number>',
},
{
tableOption: 'getFacetedRowModel',
defaultValue: '',
description:
'Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#getfacetedrowmodel',
linkText: 'TanStack Table Filters Docs',
required: false,
source: 'TanStack Table',
type: '() => RowModel<TData>',
},
{
tableOption: 'getFacetedUniqueValues',
defaultValue: '',
description:
'A function that computes and returns a Map of unique values and their occurrences derived from column.getFacetedRowModel. Useful for displaying faceted result values.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#getfaceteduniquevalues',
linkText: 'TanStack Table Filters Docs',
required: false,
source: 'TanStack Table',
type: '() => Map<any, number>',
},
{
tableOption: 'getFilteredRowModel',
defaultValue: '',
description:
'Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.',
link: 'https://tanstack.com/table/v8/docs/api/features/filters#getfilteredrowmodel',
linkText: 'TanStack Table Filters Docs',
required: false,
source: 'TanStack Table',
type: '() => RowModel<TData>',
},
{
tableOption: 'getGroupedRowModel',
defaultValue: '',
description:
'Returns the row model after grouping has taken place, but no further.',
link: 'https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel',
linkText: 'TanStack Table Grouping Docs',
required: false,
source: 'TanStack Table',
type: '(table: Table<TData>) => () => RowModel<TData>',
},
{
tableOption: 'getIsRowExpanded',
defaultValue: '',
description:
'If provided, allows you to override the default behavior of determining whether a row is currently expanded.',
link: 'https://tanstack.com/table/v8/docs/api/features/expanding#getisrowexpanded',
linkText: 'TanStack Table Expanding Docs',
required: false,
source: 'TanStack Table',
type: '(row: Row<TData>) => boolean',
},
{
tableOption: 'getPaginationRowModel',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: '',
type: '() => MRT_RowModel<TData>',
},
{
tableOption: 'getRowCanExpand',
defaultValue: '',
description:
'If provided, allows you to override the default behavior of determining whether a row can be expanded.',
link: 'https://tanstack.com/table/v8/docs/api/features/expanding#getrowcanexpand',
linkText: 'TanStack Table Expanding Docs',
required: false,
source: 'TanStack Table',
type: '(row: Row<TData>) => boolean',
},
{
tableOption: 'getRowId',
defaultValue: '',
description: `This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with . using their grandparents' index eg. index.index.index). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.`,
link: 'https://tanstack.com/table/v8/docs/api/core/table#getrowid',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: `(originalRow: TData, index: number, parent?: MRT_Row<TData>) => string`,
},
{
tableOption: 'getSortedRowModel',
defaultValue: '',
description:
'This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported getSortedRowModel() from your adapter to your table or implement your own.',
link: 'https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel',
linkText: 'TanStack Table Sorting Docs',
required: false,
source: 'TanStack Table',
type: '(table: Table<TData>) => () => RowModel<TData>',
},
{
tableOption: 'getSubRows',
defaultValue: '',
description:
'This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row.',
link: 'https://tanstack.com/table/v8/docs/api/core/table#getsubrows',
linkText: 'TanStack Table Core Table Docs',
required: false,
source: 'TanStack Table',
type: `(originalRow: TData, index: number) => undefined | TData[]`,
},
{
tableOption: 'globalFilterFn',
defaultValue: '',
description: 'The filter function to use for global filtering.',
link: '',
linkText: '',
required: false,
source: 'MRT',
type: 'MRT_FilterOption',
},
{
tableOption: 'groupedColumnMode',
defaultValue: 'reorder',
description:
'Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.',
link: 'https://tanstack.com/table/v8/docs/api/features/grouping#groupedcolumnmode',
linkText: 'TanStack Table Grouping Docs',
required: false,
source: 'TanStack Table',
type: `false | 'reorder' | 'remove'`,
},
{
tableOption: 'icons',
defaultValue: '',
description: '',
link: '',
linkText: '',
required: false,
source: 'MRT',
type: 'Partial<MRT_Icons>;',
},
{
tableOption: 'initialState',
defaultValue: '',
description:
'Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. options.autoResetPagination) or via functions like table.resetRowSelection(). Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state. Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable.',
link: '/docs/guides/table-state-management#populate-initial-state',
linkText: 'Table State Management Guide',
required: false,
source: 'MRT',
type: `Partial<MRT_TableState<TData>>`,
},
{
tableOption: 'isMultiSortEvent',
defaultValue: '',
description:
'Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return true if the event should trigger a multi-sort.',
link: 'https://tanstack.com/table/v8/docs/api/features/sorting#ismultisortevent',
linkText: 'TanStack Table Sorting Docs',
required: false,
source: 'TanStack Table',
type: '(e: unknown) => boolean',