forked from mui/mui-x
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdata-grid-pro.json
1219 lines (1219 loc) · 57.2 KB
/
data-grid-pro.json
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
{
"componentDescription": "",
"propDescriptions": {
"apiRef": {
"description": "The ref object that allows grid manipulation. Can be instantiated with <code>useGridApiRef()</code>."
},
"aria-label": { "description": "The label of the Data Grid." },
"aria-labelledby": {
"description": "The id of the element containing a label for the Data Grid."
},
"autoHeight": {
"description": "If <code>true</code>, the Data Grid height is dynamic and follows the number of rows in the Data Grid."
},
"autoPageSize": {
"description": "If <code>true</code>, the pageSize is calculated according to the container size and the max number of rows to avoid rendering a vertical scroll bar."
},
"autosizeOnMount": {
"description": "If <code>true</code>, columns are autosized after the datagrid is mounted."
},
"autosizeOptions": { "description": "The options for autosize when user-initiated." },
"cellModesModel": { "description": "Controls the modes of the cells." },
"checkboxSelection": {
"description": "If <code>true</code>, the Data Grid will display an extra column with checkboxes for selecting rows."
},
"checkboxSelectionVisibleOnly": {
"description": "If <code>true</code>, the "Select All" header checkbox selects only the rows on the current page. To be used in combination with <code>checkboxSelection</code>. It only works if the pagination is enabled."
},
"classes": { "description": "Override or extend the styles applied to the component." },
"clipboardCopyCellDelimiter": {
"description": "The character used to separate cell values when copying to the clipboard."
},
"columnBufferPx": {
"description": "Column region in pixels to render before/after the viewport"
},
"columnHeaderHeight": {
"description": "Sets the height in pixel of the column headers in the Data Grid."
},
"columns": {
"description": "Set of columns of type <a href='/x/api/data-grid/grid-col-def/'>GridColDef</a>[]."
},
"columnVisibilityModel": {
"description": "Set the column visibility model of the Data Grid. If defined, the Data Grid will ignore the <code>hide</code> property in <a href='/x/api/data-grid/grid-col-def/'>GridColDef</a>."
},
"defaultGroupingExpansionDepth": {
"description": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded."
},
"density": { "description": "Set the density of the Data Grid." },
"detailPanelExpandedRowIds": { "description": "The row ids to show the detail panel." },
"disableAutosize": {
"description": "If <code>true</code>, column autosizing on header separator double-click is disabled."
},
"disableChildrenFiltering": {
"description": "If <code>true</code>, the filtering will only be applied to the top level rows when grouping rows with the <code>treeData</code> prop."
},
"disableChildrenSorting": {
"description": "If <code>true</code>, the sorting will only be applied to the top level rows when grouping rows with the <code>treeData</code> prop."
},
"disableColumnFilter": { "description": "If <code>true</code>, column filters are disabled." },
"disableColumnMenu": { "description": "If <code>true</code>, the column menu is disabled." },
"disableColumnPinning": {
"description": "If <code>true</code>, the column pinning is disabled."
},
"disableColumnReorder": {
"description": "If <code>true</code>, reordering columns is disabled."
},
"disableColumnResize": { "description": "If <code>true</code>, resizing columns is disabled." },
"disableColumnSelector": {
"description": "If <code>true</code>, hiding/showing columns is disabled."
},
"disableColumnSorting": {
"description": "If <code>true</code>, the column sorting feature will be disabled."
},
"disableDensitySelector": {
"description": "If <code>true</code>, the density selector is disabled."
},
"disableEval": {
"description": "If <code>true</code>, <code>eval()</code> is not used for performance optimization."
},
"disableMultipleColumnsFiltering": {
"description": "If <code>true</code>, filtering with multiple columns is disabled."
},
"disableMultipleColumnsSorting": {
"description": "If <code>true</code>, the sorting with multiple columns is disabled."
},
"disableMultipleRowSelection": {
"description": "If <code>true</code>, multiple selection using the Ctrl/CMD or Shift key is disabled. The MIT DataGrid will ignore this prop, unless <code>checkboxSelection</code> is enabled."
},
"disableRowSelectionOnClick": {
"description": "If <code>true</code>, the selection on click on a row or cell is disabled."
},
"disableVirtualization": {
"description": "If <code>true</code>, the virtualization is disabled."
},
"editMode": { "description": "Controls whether to use the cell or row editing." },
"estimatedRowCount": {
"description": "Use if the actual rowCount is not known upfront, but an estimation is available. If some rows have children (for instance in the tree data), this number represents the amount of top level rows. Applicable only with <code>paginationMode="server"</code> and when <code>rowCount="-1"</code>"
},
"experimentalFeatures": {
"description": "Unstable features, breaking changes might be introduced. For each feature, if the flag is not explicitly set to <code>true</code>, the feature will be fully disabled and any property / method call will not have any effect."
},
"filterDebounceMs": {
"description": "The milliseconds delay to wait after a keystroke before triggering filtering."
},
"filterMode": {
"description": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side."
},
"filterModel": { "description": "Set the filter model of the Data Grid." },
"getCellClassName": {
"description": "Function that applies CSS classes dynamically on cells.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"string": "The CSS class to apply to the cell."
}
},
"getDetailPanelContent": {
"description": "Function that returns the element to render in row detail.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"React.JSX.Element": "The row detail element."
}
},
"getDetailPanelHeight": {
"description": "Function that returns the height of the row detail panel.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"number | string": "The height in pixels or "auto" to use the content height."
}
},
"getEstimatedRowHeight": {
"description": "Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.",
"typeDescriptions": {
"params": "With all properties from GridRowHeightParams.",
"number | null": "The estimated row height value. If <code>null</code> or <code>undefined</code> then the default row height, based on the density, is applied."
}
},
"getRowClassName": {
"description": "Function that applies CSS classes dynamically on rows.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-class-name-params/'>GridRowClassNameParams</a>.",
"string": "The CSS class to apply to the row."
}
},
"getRowHeight": {
"description": "Function that sets the row height per row.",
"typeDescriptions": {
"params": "With all properties from GridRowHeightParams.",
"GridRowHeightReturnValue": "The row height value. If <code>null</code> or <code>undefined</code> then the default row height is applied. If "auto" then the row height is calculated based on the content."
}
},
"getRowId": { "description": "Return the id of a given GridRowModel." },
"getRowSpacing": {
"description": "Function that allows to specify the spacing between rows.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-spacing-params/'>GridRowSpacingParams</a>.",
"GridRowSpacing": "The row spacing values."
}
},
"getTreeDataPath": {
"description": "Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.",
"typeDescriptions": {
"row": "The row from which we want the path.",
"Array<string>": "The path to the row."
}
},
"groupingColDef": { "description": "The grouping column used by the tree data." },
"headerFilterHeight": { "description": "Override the height of the header filters." },
"headerFilters": {
"description": "If <code>true</code>, enables the data grid filtering on header feature."
},
"hideFooter": { "description": "If <code>true</code>, the footer component is hidden." },
"hideFooterPagination": {
"description": "If <code>true</code>, the pagination component in the footer is hidden."
},
"hideFooterRowCount": {
"description": "If <code>true</code>, the row count in the footer is hidden. It has no effect if the pagination is enabled."
},
"hideFooterSelectedRowCount": {
"description": "If <code>true</code>, the selected row count in the footer is hidden."
},
"ignoreDiacritics": {
"description": "If <code>true</code>, the diacritics (accents) are ignored when filtering or quick filtering. E.g. when filter value is <code>cafe</code>, the rows with <code>café</code> will be visible."
},
"ignoreValueFormatterDuringExport": {
"description": "If <code>true</code>, the Data Grid will not use <code>valueFormatter</code> when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the <code>valueFormatter</code> for CSV export or clipboard export."
},
"indeterminateCheckboxAction": {
"description": "If <code>select</code>, a group header checkbox in indeterminate state (like "Select All" checkbox) will select all the rows under it. If <code>deselect</code>, it will deselect all the rows under it. Works only if <code>checkboxSelection</code> is enabled."
},
"initialState": {
"description": "The initial state of the DataGridPro. The data in it will be set in the state on initialization but will not be controlled. If one of the data in <code>initialState</code> is also being controlled, then the control state wins."
},
"isCellEditable": {
"description": "Callback fired when a cell is rendered, returns true if the cell is editable.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"boolean": "A boolean indicating if the cell is editable."
}
},
"isGroupExpandedByDefault": {
"description": "Determines if a group should be expanded after its creation. This prop takes priority over the <code>defaultGroupingExpansionDepth</code> prop.",
"typeDescriptions": {
"node": "The node of the group to test.",
"boolean": "A boolean indicating if the group is expanded."
}
},
"isRowSelectable": {
"description": "Determines if a row can be selected.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"boolean": "A boolean indicating if the row is selectable."
}
},
"keepColumnPositionIfDraggedOutside": {
"description": "If <code>true</code>, moving the mouse pointer outside the grid before releasing the mouse button in a column re-order action will not cause the column to jump back to its original position."
},
"keepNonExistentRowsSelected": {
"description": "If <code>true</code>, the selection model will retain selected rows that do not exist. Useful when using server side pagination and row selections need to be retained when changing pages."
},
"loading": { "description": "If <code>true</code>, a loading overlay is displayed." },
"localeText": {
"description": "Set the locale text of the Data Grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository."
},
"logger": {
"description": "Pass a custom logger in the components that implements the Logger interface."
},
"logLevel": { "description": "Allows to pass the logging level or false to turn off logging." },
"nonce": {
"description": "Nonce of the inline styles for <a href=\"https://www.w3.org/TR/2016/REC-CSP2-20161215/#script-src-the-nonce-attribute\">Content Security Policy</a>."
},
"onCellClick": {
"description": "Callback fired when any cell is clicked.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onCellDoubleClick": {
"description": "Callback fired when a double click event comes from a cell element.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onCellEditStart": {
"description": "Callback fired when the cell turns to edit mode.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"event": "The event that caused this prop to be called."
}
},
"onCellEditStop": {
"description": "Callback fired when the cell turns to view mode.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"event": "The event that caused this prop to be called."
}
},
"onCellKeyDown": {
"description": "Callback fired when a keydown event comes from a cell element.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-cell-params/'>GridCellParams</a>.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onCellModesModelChange": {
"description": "Callback fired when the <code>cellModesModel</code> prop changes.",
"typeDescriptions": {
"cellModesModel": "Object containing which cells are in "edit" mode.",
"details": "Additional details for this callback."
}
},
"onClipboardCopy": {
"description": "Callback called when the data is copied to the clipboard.",
"typeDescriptions": { "data": "The data copied to the clipboard." }
},
"onColumnHeaderClick": {
"description": "Callback fired when a click event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnHeaderDoubleClick": {
"description": "Callback fired when a double click event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnHeaderEnter": {
"description": "Callback fired when a mouse enter event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnHeaderLeave": {
"description": "Callback fired when a mouse leave event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnHeaderOut": {
"description": "Callback fired when a mouseout event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnHeaderOver": {
"description": "Callback fired when a mouseover event comes from a column header element.",
"typeDescriptions": {
"params": "With all properties from GridColumnHeaderParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnOrderChange": {
"description": "Callback fired when a column is reordered.",
"typeDescriptions": {
"params": "With all properties from GridColumnOrderChangeParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnResize": {
"description": "Callback fired while a column is being resized.",
"typeDescriptions": {
"params": "With all properties from GridColumnResizeParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onColumnVisibilityModelChange": {
"description": "Callback fired when the column visibility model changes.",
"typeDescriptions": {
"model": "The new model.",
"details": "Additional details for this callback."
}
},
"onColumnWidthChange": {
"description": "Callback fired when the width of a column is changed.",
"typeDescriptions": {
"params": "With all properties from GridColumnResizeParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onDensityChange": {
"description": "Callback fired when the density changes.",
"typeDescriptions": { "density": "New density value." }
},
"onDetailPanelExpandedRowIdsChange": {
"description": "Callback fired when the detail panel of a row is opened or closed.",
"typeDescriptions": {
"ids": "The ids of the rows which have the detail panel open.",
"details": "Additional details for this callback."
}
},
"onFetchRows": {
"description": "Callback fired when rowCount is set and the next batch of virtualized rows is rendered.",
"typeDescriptions": {
"params": "With all properties from GridFetchRowsParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onFilterModelChange": {
"description": "Callback fired when the Filter model changes before the filters are applied.",
"typeDescriptions": {
"model": "With all properties from <a href='/x/api/data-grid/grid-filter-model/'>GridFilterModel</a>.",
"details": "Additional details for this callback."
}
},
"onMenuClose": {
"description": "Callback fired when the menu is closed.",
"typeDescriptions": {
"params": "With all properties from GridMenuParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onMenuOpen": {
"description": "Callback fired when the menu is opened.",
"typeDescriptions": {
"params": "With all properties from GridMenuParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onPaginationMetaChange": {
"description": "Callback fired when the pagination meta has changed.",
"typeDescriptions": { "paginationMeta": "Updated pagination meta." }
},
"onPaginationModelChange": {
"description": "Callback fired when the pagination model has changed.",
"typeDescriptions": {
"model": "Updated pagination model.",
"details": "Additional details for this callback."
}
},
"onPinnedColumnsChange": {
"description": "Callback fired when the pinned columns have changed.",
"typeDescriptions": {
"pinnedColumns": "The changed pinned columns.",
"details": "Additional details for this callback."
}
},
"onPreferencePanelClose": {
"description": "Callback fired when the preferences panel is closed.",
"typeDescriptions": {
"params": "With all properties from GridPreferencePanelParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onPreferencePanelOpen": {
"description": "Callback fired when the preferences panel is opened.",
"typeDescriptions": {
"params": "With all properties from GridPreferencePanelParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onProcessRowUpdateError": {
"description": "Callback called when <code>processRowUpdate</code> throws an error or rejects.",
"typeDescriptions": { "error": "The error thrown." }
},
"onResize": {
"description": "Callback fired when the Data Grid is resized.",
"typeDescriptions": {
"containerSize": "With all properties from ElementSize.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onRowClick": {
"description": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onRowCountChange": {
"description": "Callback fired when the row count has changed.",
"typeDescriptions": { "count": "Updated row count." }
},
"onRowDoubleClick": {
"description": "Callback fired when a double click event comes from a row container element.",
"typeDescriptions": {
"params": "With all properties from RowParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onRowEditStart": {
"description": "Callback fired when the row turns to edit mode.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"event": "The event that caused this prop to be called."
}
},
"onRowEditStop": {
"description": "Callback fired when the row turns to view mode.",
"typeDescriptions": {
"params": "With all properties from <a href='/x/api/data-grid/grid-row-params/'>GridRowParams</a>.",
"event": "The event that caused this prop to be called."
}
},
"onRowModesModelChange": {
"description": "Callback fired when the <code>rowModesModel</code> prop changes.",
"typeDescriptions": {
"rowModesModel": "Object containing which rows are in "edit" mode.",
"details": "Additional details for this callback."
}
},
"onRowOrderChange": {
"description": "Callback fired when a row is being reordered.",
"typeDescriptions": {
"params": "With all properties from GridRowOrderChangeParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onRowSelectionModelChange": {
"description": "Callback fired when the selection state of one or multiple rows changes.",
"typeDescriptions": {
"rowSelectionModel": "With all the row ids GridSelectionModel.",
"details": "Additional details for this callback."
}
},
"onRowsScrollEnd": {
"description": "Callback fired when scrolling to the bottom of the grid viewport.",
"typeDescriptions": {
"params": "With all properties from GridRowScrollEndParams.",
"event": "The event object.",
"details": "Additional details for this callback."
}
},
"onSortModelChange": {
"description": "Callback fired when the sort model changes before a column is sorted.",
"typeDescriptions": {
"model": "With all properties from GridSortModel.",
"details": "Additional details for this callback."
}
},
"pageSizeOptions": { "description": "Select the pageSize dynamically using the component UI." },
"pagination": { "description": "If <code>true</code>, pagination is enabled." },
"paginationMeta": {
"description": "The extra information about the pagination state of the Data Grid. Only applicable with <code>paginationMode="server"</code>."
},
"paginationMode": {
"description": "Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side."
},
"paginationModel": {
"description": "The pagination model of type GridPaginationModel which refers to current <code>page</code> and <code>pageSize</code>."
},
"pinnedColumns": { "description": "The column fields to display pinned to left or right." },
"pinnedRows": { "description": "Rows data to pin on top or bottom." },
"processRowUpdate": {
"description": "Callback called before updating a row with new values in the row and cell editing.",
"typeDescriptions": {
"newRow": "Row object with the new values.",
"oldRow": "Row object with the old values.",
"Promise<R> | R": "The final values to update the row."
}
},
"resizeThrottleMs": { "description": "The milliseconds throttle delay for resizing the grid." },
"rowBufferPx": { "description": "Row region in pixels to render before/after the viewport" },
"rowCount": {
"description": "Set the total number of rows, if it is different from the length of the value <code>rows</code> prop. If some rows have children (for instance in the tree data), this number represents the amount of top level rows. Only works with <code>paginationMode="server"</code>, ignored when <code>paginationMode="client"</code>."
},
"rowHeight": { "description": "Sets the height in pixel of a row in the Data Grid." },
"rowModesModel": { "description": "Controls the modes of the rows." },
"rowPositionsDebounceMs": {
"description": "The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows."
},
"rowReordering": { "description": "If <code>true</code>, the reordering of rows is enabled." },
"rows": { "description": "Set of rows of type GridRowsProp." },
"rowSelection": { "description": "If <code>false</code>, the row selection mode is disabled." },
"rowSelectionModel": { "description": "Sets the row selection model of the Data Grid." },
"rowsLoadingMode": {
"description": "Loading rows can be processed on the server or client-side. Set it to 'client' if you would like enable infnite loading. Set it to 'server' if you would like to enable lazy loading. * @default "client""
},
"rowSpacingType": {
"description": "Sets the type of space between rows added by <code>getRowSpacing</code>."
},
"scrollbarSize": {
"description": "Override the height/width of the Data Grid inner scrollbar."
},
"scrollEndThreshold": {
"description": "Set the area in <code>px</code> at the bottom of the grid viewport where onRowsScrollEnd is called."
},
"showCellVerticalBorder": {
"description": "If <code>true</code>, the vertical borders of the cells are displayed."
},
"showColumnVerticalBorder": {
"description": "If <code>true</code>, the right border of the column headers are displayed."
},
"slotProps": {
"description": "Overridable components props dynamically passed to the component at rendering."
},
"slots": { "description": "Overridable components." },
"sortingMode": {
"description": "Sorting can be processed on the server or client-side. Set it to 'client' if you would like to handle sorting on the client-side. Set it to 'server' if you would like to handle sorting on the server-side."
},
"sortingOrder": { "description": "The order of the sorting sequence." },
"sortModel": { "description": "Set the sort model of the Data Grid." },
"sx": {
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
},
"throttleRowsMs": {
"description": "If positive, the Data Grid will throttle updates coming from <code>apiRef.current.updateRows</code> and <code>apiRef.current.setRows</code>. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update."
},
"treeData": {
"description": "If <code>true</code>, the rows will be gathered in a tree structure according to the <code>getTreeDataPath</code> prop."
}
},
"classDescriptions": {
"actionsCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root element of the cell with type="actions""
},
"aggregationColumnHeader": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the column header",
"conditions": "aggregated"
},
"aggregationColumnHeader--alignCenter": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the header",
"conditions": "aggregation if <code>headerAlign=\"center\"</code>"
},
"aggregationColumnHeader--alignLeft": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the header",
"conditions": "aggregation if <code>headerAlign=\"left\"</code>"
},
"aggregationColumnHeader--alignRight": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the header",
"conditions": "aggregation if <code>headerAlign=\"right\"</code>"
},
"aggregationColumnHeaderLabel": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the aggregation label in the column header",
"conditions": "aggregated"
},
"autoHeight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "<code>autoHeight={true}</code>"
},
"autosizing": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root element while it is being autosized"
},
"booleanCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the icon of the boolean cell"
},
"cell--editable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "the cell is editable"
},
"cell--editing": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "the cell is in edit mode"
},
"cell--flex": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the cell element in flex display mode"
},
"cell--pinnedLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is pinned to the left"
},
"cell--pinnedRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is pinned to the right"
},
"cell--rangeBottom": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is at the bottom edge of a cell selection range"
},
"cell--rangeLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is at the left edge of a cell selection range"
},
"cell--rangeRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is at the right edge of a cell selection range"
},
"cell--rangeTop": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is at the top edge of a cell selection range"
},
"cell--selectionMode": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "it is in a cell selection range"
},
"cell--textCenter": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "<code>align=\"center\"</code>"
},
"cell--textLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "<code>align=\"left\"</code>"
},
"cell--textRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "<code>align=\"right\"</code>"
},
"cell--withLeftBorder": {
"description": "Styles applied the cell if <code>showColumnVerticalBorder={true}</code>."
},
"cell--withRightBorder": {
"description": "Styles applied the cell if <code>showColumnVerticalBorder={true}</code>."
},
"cellCheckbox": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the cell checkbox element"
},
"cellEmpty": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the empty cell element"
},
"cellSkeleton": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the skeleton cell element"
},
"checkboxInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the selection checkbox element"
},
"columnHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header element"
},
"columnHeader--alignCenter": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "<code>headerAlign=\"center\"</code>"
},
"columnHeader--alignLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "<code>headerAlign=\"left\"</code>"
},
"columnHeader--alignRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "<code>headerAlign=\"right\"</code>"
},
"columnHeader--dragging": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the floating column header element",
"conditions": "it is dragged"
},
"columnHeader--emptyGroup": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the empty column group header cell"
},
"columnHeader--filledGroup": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column group header cell",
"conditions": "not empty"
},
"columnHeader--filtered": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "the column has a filter applied to it"
},
"columnHeader--last": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the last column header element"
},
"columnHeader--moving": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "it is being dragged"
},
"columnHeader--numeric": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "the type of the column is <code>number</code>"
},
"columnHeader--pinnedLeft": { "description": "" },
"columnHeader--pinnedRight": { "description": "" },
"columnHeader--sortable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "the column is sortable"
},
"columnHeader--sorted": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "the column is sorted"
},
"columnHeader--withLeftBorder": { "description": "" },
"columnHeader--withRightBorder": {
"description": "Styles applied the column header if <code>showColumnVerticalBorder={true}</code>."
},
"columnHeaderCheckbox": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the header checkbox cell element"
},
"columnHeaderDraggableContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header's draggable container element"
},
"columnHeaderTitle": {
"description": "Styles applied to the column header's title element;"
},
"columnHeaderTitleContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header's title container element"
},
"columnHeaderTitleContainerContent": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header's title excepted buttons"
},
"columnSeparator": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header separator element"
},
"columnSeparator--resizable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header separator",
"conditions": "the column is resizable"
},
"columnSeparator--resizing": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header separator",
"conditions": "the column is being resized"
},
"columnSeparator--sideLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header separator",
"conditions": "the side is "left""
},
"columnSeparator--sideRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header separator",
"conditions": "the side is "right""
},
"columnsManagementFooter": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the columns management footer element"
},
"columnsManagementHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the columns management header element"
},
"columnsManagementRow": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the columns management row element"
},
"container--bottom": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the bottom container"
},
"container--top": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the top container"
},
"detailPanel": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the detail panel element"
},
"detailPanelToggleCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the detail panel toggle cell element"
},
"detailPanelToggleCell--expanded": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the detail panel toggle cell element",
"conditions": "expanded"
},
"editBooleanCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "root of the boolean edit component"
},
"editInputCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root of the input component"
},
"filterForm": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root of the filter form component"
},
"filterFormColumnInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column input of the filter form component"
},
"filterFormDeleteIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the delete icon of the filter form component"
},
"filterFormLogicOperatorInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the link operator input of the filter form component"
},
"filterFormOperatorInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the operator input of the filter form component"
},
"filterFormValueInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the value input of the filter form component"
},
"filterIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the filter icon element"
},
"footerCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root element of the cell inside a footer row"
},
"footerContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the footer container element"
},
"groupingCriteriaCell": {
"description": "Styles applied to the root element of the grouping criteria cell"
},
"groupingCriteriaCellToggle": {
"description": "Styles applied to the toggle of the grouping criteria cell"
},
"headerFilterRow": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header filter row"
},
"iconButtonContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header icon's container"
},
"iconSeparator": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header separator icon element"
},
"main": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the main container element"
},
"main--hasPinnedRight": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the main container element",
"conditions": "it has right pinned columns"
},
"menu": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the menu element" },
"menuIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the menu icon element"
},
"menuIconButton": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the menu icon button element"
},
"menuList": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the menu list element"
},
"menuOpen": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the menu icon element",
"conditions": "the menu is open"
},
"overlay": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay element"
},
"overlayWrapper": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay wrapper element"
},
"overlayWrapperInner": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay wrapper inner element"
},
"panelContent": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel content element"
},
"panelFooter": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel footer element"
},
"panelHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel header element"
},
"panelWrapper": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel wrapper element"
},
"paper": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the paper element" },
"pinnedColumns": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pinned columns"
},
"pinnedRows": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pinned rows container"
},
"pinnedRows--bottom": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the bottom pinned rows container"
},
"pinnedRows--top": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the top pinned rows container"
},
"pinnedRowsRenderZone": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "pinned rows render zones"
},
"root": { "description": "Styles applied to the root element." },