forked from mui/mui-x
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
data-grid-tr.json
670 lines (670 loc) · 47.4 KB
/
data-grid-tr.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
{
"componentDescription": "",
"propDescriptions": {
"aria-label": "The label of the grid.",
"aria-labelledby": "The id of the element containing a label for the grid.",
"autoHeight": "If <code>true</code>, the grid height is dynamic and follow the number of rows in the grid.",
"autoPageSize": "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.",
"cellModesModel": "Controls the modes of the cells.",
"checkboxSelection": "If <code>true</code>, the grid get a first column with a checkbox that allows to select rows.",
"classes": "Override or extend the styles applied to the component. See <a href=\"#css\">CSS API</a> below for more details.",
"columnBuffer": "Number of extra columns to be rendered before/after the visible slice.",
"columns": "Set of columns of type GridColumns.",
"columnThreshold": "Number of rows from the <code>columnBuffer</code> that can be visible before a new slice is rendered.",
"columnTypes": "Extend native column types with your new column types.",
"columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the <code>hide</code> property in <a href=\"/x/api/data-grid/grid-col-def/\">GridColDef</a>.",
"components": "Overrideable components.",
"componentsProps": "Overrideable components props dynamically passed to the component at rendering.",
"density": "Set the density of the grid.",
"disableColumnFilter": "If <code>true</code>, column filters are disabled.",
"disableColumnMenu": "If <code>true</code>, the column menu is disabled.",
"disableColumnSelector": "If <code>true</code>, hiding/showing columns is disabled.",
"disableDensitySelector": "If <code>true</code>, the density selector is disabled.",
"disableExtendRowFullWidth": "If <code>true</code>, rows will not be extended to fill the full width of the grid container.",
"disableIgnoreModificationsIfProcessingProps": "If <code>true</code>, modification to a cell will not be discarded if the mode is changed from "edit" to "view" while processing props.",
"disableSelectionOnClick": "If <code>true</code>, the selection on click on a row or cell is disabled.",
"disableVirtualization": "If <code>true</code>, the virtualization is disabled.",
"editMode": "Controls whether to use the cell or row editing.",
"editRowsModel": "Set the edit rows model of the grid.",
"error": "An error that will turn the grid into its error state and display the error component.",
"experimentalFeatures": "Features under development. 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.",
"filterMode": "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": "Set the filter model of the grid.",
"getCellClassName": "Function that applies CSS classes dynamically on cells.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams) => string</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br> <em>returns</em> (string): The CSS class to apply to the cell.",
"getDetailPanelContent": "Function that returns the element to render in row detail.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams) => JSX.Element</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-params/\">GridRowParams</a>.<br> <em>returns</em> (JSX.Element): The row detail element.",
"getEstimatedRowHeight": "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.<br><br><strong>Signature:</strong><br><code>function(params: GridRowHeightParams) => number | null</code><br><em>params:</em> With all properties from GridRowHeightParams.<br> <em>returns</em> (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": "Function that applies CSS classes dynamically on rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowClassNameParams) => string</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-class-name-params/\">GridRowClassNameParams</a>.<br> <em>returns</em> (string): The CSS class to apply to the row.",
"getRowHeight": "Function that sets the row height per row.<br><br><strong>Signature:</strong><br><code>function(params: GridRowHeightParams) => GridRowHeightReturnValue</code><br><em>params:</em> With all properties from GridRowHeightParams.<br> <em>returns</em> (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": "Return the id of a given GridRowModel.",
"getRowSpacing": "Function that allows to specify the spacing between rows.<br><br><strong>Signature:</strong><br><code>function(params: GridRowSpacingParams) => GridRowSpacing</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-spacing-params/\">GridRowSpacingParams</a>.<br> <em>returns</em> (GridRowSpacing): The row spacing values.",
"headerHeight": "Set the height in pixel of the column headers in the grid.",
"hideFooter": "If <code>true</code>, the footer component is hidden.",
"hideFooterPagination": "If <code>true</code>, the pagination component in the footer is hidden.",
"hideFooterSelectedRowCount": "If <code>true</code>, the selected row count in the footer is hidden.",
"initialState": "The initial state of the DataGrid. 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": "Callback fired when a cell is rendered, returns true if the cell is editable.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams) => boolean</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br> <em>returns</em> (boolean): A boolean indicating if the cell is editable.",
"isRowSelectable": "Determines if a row can be selected.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams) => boolean</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-params/\">GridRowParams</a>.<br> <em>returns</em> (boolean): A boolean indicating if the cell is selectable.",
"keepNonExistentRowsSelected": "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": "If <code>true</code>, a loading overlay is displayed.",
"localeText": "Set the locale text of the grid. You can find all the translation keys supported in <a href=\"https://github.com/mui/mui-x/blob/HEAD/packages/grid/x-data-grid/src/constants/localeTextConstants.ts\">the source</a> in the GitHub repository.",
"logger": "Pass a custom logger in the components that implements the Logger interface.",
"logLevel": "Allows to pass the logging level or false to turn off logging.",
"nonce": "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": "Callback fired when any cell is clicked.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onCellDoubleClick": "Callback fired when a double click event comes from a cell element.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onCellEditStart": "Callback fired when the cell turns to edit mode.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event that caused this prop to be called.",
"onCellEditStop": "Callback fired when the cell turns to view mode.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event that caused this prop to be called.",
"onCellFocusOut": "Callback fired when a cell loses focus.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onCellKeyDown": "Callback fired when a keydown event comes from a cell element.<br><br><strong>Signature:</strong><br><code>function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-cell-params/\">GridCellParams</a>.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onCellModesModelChange": "Callback fired when the <code>cellModesModel</code> prop changes.<br><br><strong>Signature:</strong><br><code>function(cellModesModel: GridCellModesModel, details: GridCallbackDetails) => void</code><br><em>cellModesModel:</em> Object containig which cells are in "edit" mode.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderClick": "Callback fired when a click event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderLeave": "Callback fired when a mouse leave event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderOut": "Callback fired when a mouseout event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnHeaderOver": "Callback fired when a mouseover event comes from a column header element.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnHeaderParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnOrderChange": "Callback fired when a column is reordered.<br><br><strong>Signature:</strong><br><code>function(params: GridColumnOrderChangeParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridColumnOrderChangeParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onColumnVisibilityModelChange": "Callback fired when the column visibility model changes.<br><br><strong>Signature:</strong><br><code>function(model: GridColumnVisibilityModel, details: GridCallbackDetails) => void</code><br><em>model:</em> The new model.<br><em>details:</em> Additional details for this callback.",
"onEditRowsModelChange": "Callback fired when the <code>editRowsModel</code> changes.<br><br><strong>Signature:</strong><br><code>function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void</code><br><em>editRowsModel:</em> With all properties from GridEditRowsModel.<br><em>details:</em> Additional details for this callback.",
"onError": "Callback fired when an exception is thrown in the grid.<br><br><strong>Signature:</strong><br><code>function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>args:</em> The arguments passed to the <code>showError</code> call.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.<br><br><strong>Signature:</strong><br><code>function(model: GridFilterModel, details: GridCallbackDetails) => void</code><br><em>model:</em> With all properties from <a href=\"/x/api/data-grid/grid-filter-model/\">GridFilterModel</a>.<br><em>details:</em> Additional details for this callback.",
"onMenuClose": "Callback fired when the menu is closed.<br><br><strong>Signature:</strong><br><code>function(params: GridMenuParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridMenuParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onMenuOpen": "Callback fired when the menu is opened.<br><br><strong>Signature:</strong><br><code>function(params: GridMenuParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridMenuParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onPageChange": "Callback fired when the current page has changed.<br><br><strong>Signature:</strong><br><code>function(page: number, details: GridCallbackDetails) => void</code><br><em>page:</em> Index of the page displayed on the Grid.<br><em>details:</em> Additional details for this callback.",
"onPageSizeChange": "Callback fired when the page size has changed.<br><br><strong>Signature:</strong><br><code>function(pageSize: number, details: GridCallbackDetails) => void</code><br><em>pageSize:</em> Size of the page displayed on the Grid.<br><em>details:</em> Additional details for this callback.",
"onPreferencePanelClose": "Callback fired when the preferences panel is closed.<br><br><strong>Signature:</strong><br><code>function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridPreferencePanelParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onPreferencePanelOpen": "Callback fired when the preferences panel is opened.<br><br><strong>Signature:</strong><br><code>function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from GridPreferencePanelParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onProcessRowUpdateError": "Callback called when <code>processRowUpdate</code> throws an error or rejects.<br><br><strong>Signature:</strong><br><code>function(error: any) => void</code><br><em>error:</em> The error thrown.",
"onResize": "Callback fired when the grid is resized.<br><br><strong>Signature:</strong><br><code>function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void</code><br><em>containerSize:</em> With all properties from ElementSize.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-params/\">GridRowParams</a>.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onRowDoubleClick": "Callback fired when a double click event comes from a row container element.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void</code><br><em>params:</em> With all properties from RowParams.<br><em>event:</em> The event object.<br><em>details:</em> Additional details for this callback.",
"onRowEditCommit": "Callback fired when the row changes are committed.<br><br><strong>Signature:</strong><br><code>function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void</code><br><em>id:</em> The row id.<br><em>event:</em> The event that caused this prop to be called.",
"onRowEditStart": "Callback fired when the row turns to edit mode.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-params/\">GridRowParams</a>.<br><em>event:</em> The event that caused this prop to be called.",
"onRowEditStop": "Callback fired when the row turns to view mode.<br><br><strong>Signature:</strong><br><code>function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void</code><br><em>params:</em> With all properties from <a href=\"/x/api/data-grid/grid-row-params/\">GridRowParams</a>.<br><em>event:</em> The event that caused this prop to be called.",
"onRowModesModelChange": "Callback fired when the <code>rowModesModel</code> prop changes.<br><br><strong>Signature:</strong><br><code>function(rowModesModel: GridRowModesModel, details: GridCallbackDetails) => void</code><br><em>rowModesModel:</em> Object containig which rows are in "edit" mode.<br><em>details:</em> Additional details for this callback.",
"onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.<br><br><strong>Signature:</strong><br><code>function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void</code><br><em>selectionModel:</em> With all the row ids GridSelectionModel.<br><em>details:</em> Additional details for this callback.",
"onSortModelChange": "Callback fired when the sort model changes before a column is sorted.<br><br><strong>Signature:</strong><br><code>function(model: GridSortModel, details: GridCallbackDetails) => void</code><br><em>model:</em> With all properties from GridSortModel.<br><em>details:</em> Additional details for this callback.",
"page": "The zero-based index of the current page.",
"pageSize": "Set the number of rows in one page. If some of the rows have children (for instance in the tree data), this number represents the amount of top level rows wanted on each page.",
"paginationMode": "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.",
"processRowUpdate": "Callback called before updating a row with new values in the row and cell editing.<br><br><strong>Signature:</strong><br><code>function(newRow: R, oldRow: R) => Promise<R> | R</code><br><em>newRow:</em> Row object with the new values.<br><em>oldRow:</em> Row object with the old values.<br> <em>returns</em> (Promise<R> | R): The final values to update the row.",
"rowBuffer": "Number of extra rows to be rendered before/after the visible slice.",
"rowCount": "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.",
"rowHeight": "Set the height in pixel of a row in the grid.",
"rowModesModel": "Controls the modes of the rows.",
"rows": "Set of rows of type GridRowsProp.",
"rowSpacingType": "Sets the type of space between rows added by <code>getRowSpacing</code>.",
"rowsPerPageOptions": "Select the pageSize dynamically using the component UI.",
"rowThreshold": "Number of rows from the <code>rowBuffer</code> that can be visible before a new slice is rendered.",
"scrollbarSize": "Override the height/width of the grid inner scrollbar.",
"selectionModel": "Set the selection model of the grid.",
"showCellRightBorder": "If <code>true</code>, the right border of the cells are displayed.",
"showColumnRightBorder": "If <code>true</code>, the right border of the column headers are displayed.",
"sortingMode": "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": "The order of the sorting sequence.",
"sortModel": "Set the sort model of the grid.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details."
},
"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--alignLeft": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the header",
"conditions": "aggregation if <code>headerAlign=\"left\"</code>"
},
"aggregationColumnHeader--alignCenter": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the root element of the header",
"conditions": "aggregation if <code>headerAlign=\"center\"</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>"
},
"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--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--withRenderer": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the cell element",
"conditions": "the cell has a custom renderer"
},
"cell": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the cell element" },
"cellContent": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the element that wraps the cell content"
},
"cellCheckbox": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the cell checkbox element"
},
"cellSkeleton": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the skeleton cell element"
},
"checkboxInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the selection checkbox 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--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--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--filtered": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column header",
"conditions": "the column has a filter applied to it"
},
"columnHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header element"
},
"columnGroupHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column group header element"
},
"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"
},
"rowReorderCellPlaceholder": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the row's draggable placeholder element inside the special row reorder cell"
},
"columnHeaderDropZone": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column headers wrapper",
"conditions": "a column is being dragged"
},
"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"
},
"columnHeader--filledGroup": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column group header cell",
"conditions": "not empty"
},
"columnHeader--emptyGroup": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the empty column group header cell"
},
"columnHeader--showColumnBorder": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the column group header cell",
"conditions": "show column border"
},
"columnHeaders": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column headers"
},
"columnHeadersInner": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column headers's inner element"
},
"columnHeadersInner--scrollable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the column headers's inner element",
"conditions": "there is a horizontal scrollbar"
},
"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\""
},
"columnSeparator": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column header separator element"
},
"columnsPanel": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the columns panel element"
},
"columnsPanelRow": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the columns panel row element"
},
"detailPanel": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the detail panel element"
},
"detailPanels": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the detail panels wrapper 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"
},
"footerCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root element of the cell inside a footer row"
},
"panel": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the panel element" },
"panelHeader": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel header element"
},
"panelWrapper": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel wrapper element"
},
"panelContent": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel content element"
},
"panelFooter": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the panel footer element"
},
"paper": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the paper element" },
"editBooleanCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "root of the boolean edit component"
},
"filterForm": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root of the filter form component"
},
"filterFormDeleteIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the delete icon of the filter form component"
},
"filterFormLinkOperatorInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the link operator inout of the filter form component"
},
"filterFormColumnInput": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the column 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"
},
"editInputCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root of the input component"
},
"filterIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the filter icon element"
},
"footerContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the footer container element"
},
"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"
},
"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"
},
"menuOpen": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the menu icon element",
"conditions": "the menu is open"
},
"menuList": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the menu list element"
},
"overlayWrapper": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay wrapper element"
},
"overlayWrapperInner": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay wrapper inner element"
},
"overlay": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the overlay element"
},
"virtualScroller": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the virtualization container"
},
"virtualScrollerContent": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the virtualization content"
},
"virtualScrollerContent--overflowed": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the virtualization content",
"conditions": "its height is bigger than the virtualization container"
},
"virtualScrollerRenderZone": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the virtualization render zone"
},
"pinnedColumns": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pinned columns"
},
"pinnedColumns--left": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the left pinned columns"
},
"pinnedColumns--right": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the right pinned columns"
},
"pinnedColumnHeaders": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pinned column headers"
},
"pinnedColumnHeaders--left": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the left pinned column headers"
},
"pinnedColumnHeaders--right": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the right pinned column headers"
},
"root": { "description": "Styles applied to the root element." },
"root--densityStandard": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "density is \"standard\" (default)"
},
"root--densityComfortable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "density is \"comfortable\""
},
"root--densityCompact": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "density is \"compact\""
},
"row--editable": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the row element",
"conditions": "the row is editable"
},
"row--editing": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the row element",
"conditions": "the row is in edit mode"
},
"row--dragging": {
"description": "Styles applied to {{nodeName}} when {{conditions}}.",
"nodeName": "the floating special row reorder cell element",
"conditions": "it is dragged"
},
"row--lastVisible": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the last visible row element on every page of the grid"
},
"row--dynamicHeight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the row",
"conditions": "it has dynamic row height"
},
"row--detailPanelExpanded": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the row",
"conditions": "its detail panel is open"
},
"row": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the row element" },
"rowCount": {
"description": "Styles applied to {{nodeName}}.\nOnly works when pagination is disabled.",
"nodeName": "the footer row count element to show the total number of rows"
},
"rowReorderCellContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the row reorder cell container element"
},
"rowReorderCell": {
"description": "Styles applied to the root element of the row reorder cell"
},
"rowReorderCell--draggable": {
"description": "Styles applied to the root element of the row reorder cell when dragging is allowed"
},
"scrollArea": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "both scroll area elements"
},
"scrollArea--left": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the left scroll area element"
},
"scrollArea--right": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the right scroll area element"
},
"selectedRowCount": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the footer selected row count element"
},
"sortIcon": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the sort icon element"
},
"toolbarContainer": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the toolbar container element"
},
"toolbarFilterList": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the toolbar filter list element"
},
"withBorder": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "both the cell and the column header",
"conditions": "<code>showColumnRightBorder={true}</code>"
},
"treeDataGroupingCell": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the root of the grouping cell of the tree data"
},
"treeDataGroupingCellToggle": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the toggle of the grouping cell of the tree data"
},
"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"
},
"pinnedRows": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pinned rows container"
},
"pinnedRows--top": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the top pinned rows container"
},
"pinnedRows--bottom": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the bottom pinned rows container"
},
"pinnedRowsRenderZone": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "pinned rows render zones"
}
},
"slotDescriptions": {
"BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
"BaseTextField": "The custom TextField component used in the grid.",
"BaseFormControl": "The custom FormControl component used in the grid.",
"BaseSelect": "The custom Select component used in the grid.",
"BaseSwitch": "The custom Switch component used in the grid.",
"BaseButton": "The custom Button component used in the grid.",
"BaseTooltip": "The custom Tooltip component used in the grid.",
"BasePopper": "The custom Popper component used in the grid.",
"Cell": "Component rendered for each cell.",
"SkeletonCell": "Component rendered for each skeleton cell.",
"ColumnHeaderFilterIconButton": "Filter icon component rendered in each column header.",
"ColumnMenu": "Column menu component rendered by clicking on the 3 dots "kebab" icon in column headers.",
"ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
"Footer": "Footer component rendered at the bottom of the grid viewport.",
"Header": "Header component rendered above the grid column header bar.\nPrefer using the <code>Toolbar</code> slot. You should never need to use this slot.",
"Toolbar": "Toolbar component rendered inside the Header component.",
"PreferencesPanel": "PreferencesPanel component rendered inside the Header component.",
"LoadingOverlay": "Loading overlay component rendered when the grid is in a loading state.",
"NoResultsOverlay": "No results overlay component rendered when the grid has no results after filtering.",
"NoRowsOverlay": "No rows overlay component rendered when the grid has no rows.",
"Pagination": "Pagination component rendered in the grid footer by default.",
"FilterPanel": "Filter panel component rendered when clicking the filter button.",
"ColumnsPanel": "GridColumns panel component rendered when clicking the columns button.",
"Panel": "Panel component wrapping the filters and columns panels.",
"Row": "Component rendered for each row.",
"BooleanCellTrueIcon": "Icon displayed on the boolean cell to represent the true value.",
"BooleanCellFalseIcon": "Icon displayed on the boolean cell to represent the false value.",
"ColumnMenuIcon": "Icon displayed on the side of the column header title to display the filter input component.",
"OpenFilterButtonIcon": "Icon displayed on the open filter button present in the toolbar by default.",
"ColumnFilteredIcon": "Icon displayed on the column header menu to show that a filter has been applied to the column.",
"ColumnSelectorIcon": "Icon displayed on the column menu selector tab.",
"ColumnUnsortedIcon": "Icon displayed on the side of the column header title when unsorted.",
"ColumnSortedAscendingIcon": "Icon displayed on the side of the column header title when sorted in ascending order.",
"ColumnSortedDescendingIcon": "Icon displayed on the side of the column header title when sorted in descending order.",
"ColumnResizeIcon": "Icon displayed in between two column headers that allows to resize the column header.",
"DensityCompactIcon": "Icon displayed on the compact density option in the toolbar.",
"DensityStandardIcon": "Icon displayed on the standard density option in the toolbar.",
"DensityComfortableIcon": "Icon displayed on the "comfortable" density option in the toolbar.",
"ExportIcon": "Icon displayed on the open export button present in the toolbar by default.",
"MoreActionsIcon": "Icon displayed on the <code>actions</code> column type to open the menu.",
"TreeDataExpandIcon": "Icon displayed on the tree data toggling column when the children are collapsed",
"TreeDataCollapseIcon": "Icon displayed on the tree data toggling column when the children are expanded",
"GroupingCriteriaExpandIcon": "Icon displayed on the grouping column when the children are collapsed",
"GroupingCriteriaCollapseIcon": "Icon displayed on the grouping column when the children are expanded",
"DetailPanelExpandIcon": "Icon displayed on the detail panel toggle column when collapsed.",
"DetailPanelCollapseIcon": "Icon displayed on the detail panel toggle column when expanded.",
"FilterPanelDeleteIcon": "Icon displayed for deleting the filter from filter Panel.",
"RowReorderIcon": "Icon displayed on the <code>reorder</code> column type to reorder a row.",
"QuickFilterIcon": "Icon displayed on the quick filter input.",
"QuickFilterClearIcon": "Icon displayed on the quick filter reset input."
}
}