@mui/x-data-grid 5.2.1 → 5.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +50 -0
- package/index-cjs.js +2 -2
- package/index-esm.js +2 -2
- package/package.json +4 -4
- package/themeAugmentation/props.d.ts +1 -1
- package/x-data-grid.d.ts +504 -426
package/x-data-grid.d.ts
CHANGED
|
@@ -243,6 +243,7 @@ interface GridRowParams<R extends GridRowModel = GridRowModel> {
|
|
|
243
243
|
* @param {GridRowId} id The row id.
|
|
244
244
|
* @param {string} field The field.
|
|
245
245
|
* @returns {GridCellValue} The cell value.
|
|
246
|
+
* @deprecated Use `params.row` to directly access the fields you want instead.
|
|
246
247
|
*/
|
|
247
248
|
getValue: (id: GridRowId, field: string) => GridCellValue;
|
|
248
249
|
}
|
|
@@ -1984,12 +1985,18 @@ interface GridDimensionsApi {
|
|
|
1984
1985
|
unstable_getViewportPageSize: () => number;
|
|
1985
1986
|
}
|
|
1986
1987
|
|
|
1988
|
+
declare const GRID_TREE_DATA_GROUPING_FIELD = "__tree_data_group__";
|
|
1989
|
+
|
|
1987
1990
|
interface GridPaginationState {
|
|
1988
1991
|
pageSize: number;
|
|
1989
1992
|
page: number;
|
|
1990
1993
|
pageCount: number;
|
|
1991
1994
|
rowCount: number;
|
|
1992
1995
|
}
|
|
1996
|
+
interface GridPaginationInitialState {
|
|
1997
|
+
pageSize?: number;
|
|
1998
|
+
page?: number;
|
|
1999
|
+
}
|
|
1993
2000
|
/**
|
|
1994
2001
|
* The apiRef methods handled by `useGridPageSize`
|
|
1995
2002
|
*/
|
|
@@ -2061,6 +2068,28 @@ declare const gridPageSizeSelector: ((state: {
|
|
|
2061
2068
|
}> & {
|
|
2062
2069
|
clearCache: () => void;
|
|
2063
2070
|
};
|
|
2071
|
+
declare const gridPageCountSelector: ((state: {
|
|
2072
|
+
rows: GridRowsState;
|
|
2073
|
+
editRows: GridEditRowsModel;
|
|
2074
|
+
pagination: GridPaginationState;
|
|
2075
|
+
columns: GridColumnsState;
|
|
2076
|
+
columnReorder: GridColumnReorderState;
|
|
2077
|
+
columnResize: GridColumnResizeState;
|
|
2078
|
+
columnMenu: GridColumnMenuState;
|
|
2079
|
+
sorting: GridSortingState;
|
|
2080
|
+
focus: GridFocusState;
|
|
2081
|
+
tabIndex: GridTabIndexState;
|
|
2082
|
+
selection: GridSelectionModel;
|
|
2083
|
+
filter: GridFilterState;
|
|
2084
|
+
preferencePanel: GridPreferencePanelState;
|
|
2085
|
+
density: GridDensityState;
|
|
2086
|
+
error?: any;
|
|
2087
|
+
pinnedColumns: GridPinnedColumns;
|
|
2088
|
+
}) => number) & reselect.OutputSelectorFields<(args_0: GridPaginationState) => number & {
|
|
2089
|
+
clearCache: () => void;
|
|
2090
|
+
}> & {
|
|
2091
|
+
clearCache: () => void;
|
|
2092
|
+
};
|
|
2064
2093
|
declare const gridPaginationRowRangeSelector: ((state: {
|
|
2065
2094
|
rows: GridRowsState;
|
|
2066
2095
|
editRows: GridEditRowsModel;
|
|
@@ -2227,6 +2256,7 @@ interface GridState {
|
|
|
2227
2256
|
pinnedColumns: GridColumnPinningState;
|
|
2228
2257
|
}
|
|
2229
2258
|
interface GridInitialState {
|
|
2259
|
+
pagination?: GridPaginationInitialState;
|
|
2230
2260
|
sorting?: GridSortingInitialState;
|
|
2231
2261
|
filter?: GridFilterInitialState;
|
|
2232
2262
|
preferencePanel?: GridPreferencePanelInitialState;
|
|
@@ -3375,11 +3405,20 @@ interface GridColDef {
|
|
|
3375
3405
|
* @default false
|
|
3376
3406
|
*/
|
|
3377
3407
|
hide?: boolean;
|
|
3408
|
+
/**
|
|
3409
|
+
* If `false`, removes the buttons for hiding this column.
|
|
3410
|
+
* @default true
|
|
3411
|
+
*/
|
|
3412
|
+
hideable?: boolean;
|
|
3378
3413
|
/**
|
|
3379
3414
|
* If `true`, the column is sortable.
|
|
3380
3415
|
* @default true
|
|
3381
3416
|
*/
|
|
3382
3417
|
sortable?: boolean;
|
|
3418
|
+
/**
|
|
3419
|
+
* The order of the sorting sequence.
|
|
3420
|
+
*/
|
|
3421
|
+
sortingOrder?: GridSortDirection[];
|
|
3383
3422
|
/**
|
|
3384
3423
|
* If `true`, the column is resizable.
|
|
3385
3424
|
* @default true
|
|
@@ -3700,6 +3739,7 @@ interface GridCellParams<V = any, R = any, F = V> {
|
|
|
3700
3739
|
* @param {GridRowId} id The row id.
|
|
3701
3740
|
* @param {string} field The field.
|
|
3702
3741
|
* @returns {GridCellValue} The cell value.
|
|
3742
|
+
* @deprecated Use `params.row` to directly access the fields you want instead.
|
|
3703
3743
|
*/
|
|
3704
3744
|
getValue: (id: GridRowId, field: string) => GridCellValue;
|
|
3705
3745
|
}
|
|
@@ -3724,15 +3764,7 @@ interface GridRenderEditCellParams extends GridEditCellProps {
|
|
|
3724
3764
|
/**
|
|
3725
3765
|
* Parameters passed when calling `colDef.valueGetter` in the rendering sequence.
|
|
3726
3766
|
*/
|
|
3727
|
-
interface GridValueGetterFullParams<V = any, R = any> extends Omit<GridCellParams<V, R>, 'formattedValue' | 'isEditable'
|
|
3728
|
-
/**
|
|
3729
|
-
* Get the cell value of a row and field.
|
|
3730
|
-
* @param {GridRowId} id The row id.
|
|
3731
|
-
* @param {string} field The field.
|
|
3732
|
-
* @returns {GridCellValue} The cell value.
|
|
3733
|
-
* @deprecated Use `params.row` to directly access the fields you want instead.
|
|
3734
|
-
*/
|
|
3735
|
-
getValue: (id: GridRowId, field: string) => GridCellValue;
|
|
3767
|
+
interface GridValueGetterFullParams<V = any, R = any> extends Omit<GridCellParams<V, R>, 'formattedValue' | 'isEditable'> {
|
|
3736
3768
|
/**
|
|
3737
3769
|
* GridApi that let you manipulate the grid.
|
|
3738
3770
|
*/
|
|
@@ -3936,6 +3968,7 @@ declare type GridRenderContextProps = GridRenderColumnsProps & GridRenderRowProp
|
|
|
3936
3968
|
|
|
3937
3969
|
/**
|
|
3938
3970
|
* Set of icons used in the grid component UI.
|
|
3971
|
+
* TODO: Differentiate community and pro interface
|
|
3939
3972
|
*/
|
|
3940
3973
|
interface GridIconSlotsComponent {
|
|
3941
3974
|
/**
|
|
@@ -4025,7 +4058,7 @@ interface GridIconSlotsComponent {
|
|
|
4025
4058
|
|
|
4026
4059
|
/**
|
|
4027
4060
|
* Grid components React prop interface containing all the overridable components.
|
|
4028
|
-
*
|
|
4061
|
+
* TODO: Differentiate community and pro interface
|
|
4029
4062
|
*/
|
|
4030
4063
|
interface GridSlotsComponent extends GridIconSlotsComponent {
|
|
4031
4064
|
/**
|
|
@@ -4221,6 +4254,22 @@ declare const GridOverlay: React$1.ForwardRefExoticComponent<GridOverlayProps &
|
|
|
4221
4254
|
declare type GridToolbarContainerProps = React$1.HTMLAttributes<HTMLDivElement>;
|
|
4222
4255
|
declare const GridToolbarContainer: React$1.ForwardRefExoticComponent<GridToolbarContainerProps & React$1.RefAttributes<HTMLDivElement>>;
|
|
4223
4256
|
|
|
4257
|
+
declare enum GridColumnHeaderSeparatorSides {
|
|
4258
|
+
Left = "left",
|
|
4259
|
+
Right = "right"
|
|
4260
|
+
}
|
|
4261
|
+
interface GridColumnHeaderSeparatorProps extends React$1.HTMLAttributes<HTMLDivElement> {
|
|
4262
|
+
resizable: boolean;
|
|
4263
|
+
resizing: boolean;
|
|
4264
|
+
height: number;
|
|
4265
|
+
side?: GridColumnHeaderSeparatorSides;
|
|
4266
|
+
}
|
|
4267
|
+
declare function GridColumnHeaderSeparatorRaw(props: GridColumnHeaderSeparatorProps): JSX.Element;
|
|
4268
|
+
declare namespace GridColumnHeaderSeparatorRaw {
|
|
4269
|
+
var propTypes: any;
|
|
4270
|
+
}
|
|
4271
|
+
declare const GridColumnHeaderSeparator: React$1.MemoExoticComponent<typeof GridColumnHeaderSeparatorRaw>;
|
|
4272
|
+
|
|
4224
4273
|
interface GridColumnHeaderItemProps {
|
|
4225
4274
|
colIndex: number;
|
|
4226
4275
|
column: GridStateColDef;
|
|
@@ -4236,26 +4285,17 @@ interface GridColumnHeaderItemProps {
|
|
|
4236
4285
|
hasFocus?: boolean;
|
|
4237
4286
|
tabIndex: 0 | -1;
|
|
4238
4287
|
disableReorder?: boolean;
|
|
4288
|
+
separatorSide?: GridColumnHeaderSeparatorProps['side'];
|
|
4239
4289
|
}
|
|
4240
4290
|
declare function GridColumnHeaderItem(props: GridColumnHeaderItemProps): JSX.Element;
|
|
4241
4291
|
declare namespace GridColumnHeaderItem {
|
|
4242
4292
|
var propTypes: any;
|
|
4243
4293
|
}
|
|
4244
4294
|
|
|
4245
|
-
interface GridColumnHeaderSeparatorProps extends React$1.HTMLAttributes<HTMLDivElement> {
|
|
4246
|
-
resizable: boolean;
|
|
4247
|
-
resizing: boolean;
|
|
4248
|
-
height: number;
|
|
4249
|
-
}
|
|
4250
|
-
declare function GridColumnHeaderSeparatorRaw(props: GridColumnHeaderSeparatorProps): JSX.Element;
|
|
4251
|
-
declare namespace GridColumnHeaderSeparatorRaw {
|
|
4252
|
-
var propTypes: any;
|
|
4253
|
-
}
|
|
4254
|
-
declare const GridColumnHeaderSeparator: React$1.MemoExoticComponent<typeof GridColumnHeaderSeparatorRaw>;
|
|
4255
|
-
|
|
4256
4295
|
interface GridColumnHeaderSortIconProps {
|
|
4257
4296
|
direction: GridSortDirection;
|
|
4258
4297
|
index: number | undefined;
|
|
4298
|
+
sortingOrder: GridSortDirection[];
|
|
4259
4299
|
}
|
|
4260
4300
|
declare function GridColumnHeaderSortIconRaw(props: GridColumnHeaderSortIconProps): JSX.Element | null;
|
|
4261
4301
|
declare namespace GridColumnHeaderSortIconRaw {
|
|
@@ -4648,593 +4688,569 @@ declare function useGridApiRef(apiRefProp: GridApiRef | undefined): GridApiRef;
|
|
|
4648
4688
|
|
|
4649
4689
|
declare function useGridLogger(apiRef: GridApiRef, name: string): Logger;
|
|
4650
4690
|
|
|
4651
|
-
|
|
4652
|
-
|
|
4653
|
-
declare function useGridScrollFn(apiRef: GridApiRef, renderingZoneElementRef: React$1.RefObject<HTMLDivElement>, columnHeadersElementRef: React$1.RefObject<HTMLDivElement>): [GridScrollFn];
|
|
4654
|
-
|
|
4655
|
-
declare const useGridSelector: <T>(apiRef: GridApiRef, selector: (state: GridState) => T) => T;
|
|
4656
|
-
|
|
4657
|
-
/**
|
|
4658
|
-
* @deprecated Use `apiRef.current.state`, `apiRef.current.setState` and `apiRef.current.forceUpdate` instead.
|
|
4659
|
-
*/
|
|
4660
|
-
declare const useGridState: (apiRef: GridApiRef) => readonly [GridState, (state: GridState | ((previousState: GridState) => GridState)) => boolean, () => void];
|
|
4661
|
-
|
|
4662
|
-
declare const useGridNativeEventListener: <E extends Event>(apiRef: GridApiRef, ref: React$1.MutableRefObject<HTMLDivElement | null> | (() => Element | undefined | null), eventName: string, handler?: ((event: E) => any) | undefined, options?: AddEventListenerOptions | undefined) => void;
|
|
4663
|
-
|
|
4664
|
-
declare type GridMergedOptions = {
|
|
4665
|
-
[key in keyof GridProcessedMergedOptions]: Partial<GridProcessedMergedOptions[key]>;
|
|
4666
|
-
};
|
|
4667
|
-
/**
|
|
4668
|
-
* The grid options with a default in value which is merged with the value given through props.
|
|
4669
|
-
*/
|
|
4670
|
-
interface GridProcessedMergedOptions {
|
|
4691
|
+
interface GridClasses {
|
|
4671
4692
|
/**
|
|
4672
|
-
*
|
|
4693
|
+
* Styles applied to the root element if `autoHeight={true}`.
|
|
4673
4694
|
*/
|
|
4674
|
-
|
|
4695
|
+
autoHeight: string;
|
|
4675
4696
|
/**
|
|
4676
|
-
*
|
|
4677
|
-
* You can find all the translation keys supported in [the source](https://github.com/mui-org/material-ui-x/blob/HEAD/packages/grid/_modules_/grid/constants/localeTextConstants.ts) in the GitHub repository.
|
|
4697
|
+
* Styles applied to the icon of the boolean cell.
|
|
4678
4698
|
*/
|
|
4679
|
-
|
|
4680
|
-
}
|
|
4681
|
-
/**
|
|
4682
|
-
* The grid options with a default in value overridable through props
|
|
4683
|
-
* None of the entry of this interface should be optional, they all have default values and `GridInputComponentProps` already applies a `Partial<GridSimpleOptions>` for the public interface
|
|
4684
|
-
* The controlled model do not have a default value at the prop processing level so they must be defined in `GridComponentOtherProps`
|
|
4685
|
-
* TODO: add multiSortKey
|
|
4686
|
-
*/
|
|
4687
|
-
interface GridSimpleOptions {
|
|
4699
|
+
booleanCell: string;
|
|
4688
4700
|
/**
|
|
4689
|
-
*
|
|
4690
|
-
* @default false
|
|
4701
|
+
* Styles applied to the cell element if the cell is editable.
|
|
4691
4702
|
*/
|
|
4692
|
-
|
|
4703
|
+
'cell--editable': string;
|
|
4693
4704
|
/**
|
|
4694
|
-
*
|
|
4695
|
-
* @default false
|
|
4705
|
+
* Styles applied to the cell element if the cell is in edit mode.
|
|
4696
4706
|
*/
|
|
4697
|
-
|
|
4707
|
+
'cell--editing': string;
|
|
4698
4708
|
/**
|
|
4699
|
-
*
|
|
4700
|
-
* @default false
|
|
4709
|
+
* Styles applied to the cell element if `align="center"`.
|
|
4701
4710
|
*/
|
|
4702
|
-
|
|
4711
|
+
'cell--textCenter': string;
|
|
4703
4712
|
/**
|
|
4704
|
-
*
|
|
4705
|
-
* It only works if the pagination is enabled.
|
|
4706
|
-
* @default false
|
|
4713
|
+
* Styles applied to the cell element if `align="left"`.
|
|
4707
4714
|
*/
|
|
4708
|
-
|
|
4715
|
+
'cell--textLeft': string;
|
|
4709
4716
|
/**
|
|
4710
|
-
*
|
|
4711
|
-
* @default 3
|
|
4717
|
+
* Styles applied to the cell element if `align="right"`.
|
|
4712
4718
|
*/
|
|
4713
|
-
|
|
4719
|
+
'cell--textRight': string;
|
|
4714
4720
|
/**
|
|
4715
|
-
*
|
|
4716
|
-
* @default 3
|
|
4721
|
+
* Styles applied to the cell element if the cell has a custom renderer.
|
|
4717
4722
|
*/
|
|
4718
|
-
|
|
4723
|
+
'cell--withRenderer': string;
|
|
4719
4724
|
/**
|
|
4720
|
-
*
|
|
4721
|
-
* @default 3
|
|
4725
|
+
* Styles applied to the cell element.
|
|
4722
4726
|
*/
|
|
4723
|
-
|
|
4727
|
+
cell: string;
|
|
4724
4728
|
/**
|
|
4725
|
-
*
|
|
4726
|
-
* @default 3
|
|
4729
|
+
* Styles applied to the cell checkbox element.
|
|
4727
4730
|
*/
|
|
4728
|
-
|
|
4731
|
+
cellCheckbox: string;
|
|
4729
4732
|
/**
|
|
4730
|
-
*
|
|
4731
|
-
* @default "standard"
|
|
4733
|
+
* Styles applied to the selection checkbox element.
|
|
4732
4734
|
*/
|
|
4733
|
-
|
|
4735
|
+
checkboxInput: string;
|
|
4734
4736
|
/**
|
|
4735
|
-
*
|
|
4736
|
-
* @default false
|
|
4737
|
+
* Styles applied to the column header if `headerAlign="center"`.
|
|
4737
4738
|
*/
|
|
4738
|
-
|
|
4739
|
+
'columnHeader--alignCenter': string;
|
|
4739
4740
|
/**
|
|
4740
|
-
*
|
|
4741
|
-
* @default false
|
|
4741
|
+
* Styles applied to the column header if `headerAlign="left"`.
|
|
4742
4742
|
*/
|
|
4743
|
-
|
|
4743
|
+
'columnHeader--alignLeft': string;
|
|
4744
4744
|
/**
|
|
4745
|
-
*
|
|
4746
|
-
* @default false
|
|
4745
|
+
* Styles applied to the column header if `headerAlign="right"`.
|
|
4747
4746
|
*/
|
|
4748
|
-
|
|
4747
|
+
'columnHeader--alignRight': string;
|
|
4749
4748
|
/**
|
|
4750
|
-
*
|
|
4751
|
-
* @default false
|
|
4749
|
+
* Styles applied to the floating column header element when it is dragged.
|
|
4752
4750
|
*/
|
|
4753
|
-
|
|
4751
|
+
'columnHeader--dragging': string;
|
|
4754
4752
|
/**
|
|
4755
|
-
*
|
|
4756
|
-
* @default false
|
|
4753
|
+
* Styles applied to the column header if it is being dragged.
|
|
4757
4754
|
*/
|
|
4758
|
-
|
|
4755
|
+
'columnHeader--moving': string;
|
|
4759
4756
|
/**
|
|
4760
|
-
*
|
|
4761
|
-
* @default false
|
|
4757
|
+
* Styles applied to the column header if the type of the column is `number`.
|
|
4762
4758
|
*/
|
|
4763
|
-
|
|
4759
|
+
'columnHeader--numeric': string;
|
|
4764
4760
|
/**
|
|
4765
|
-
*
|
|
4766
|
-
* @default false
|
|
4761
|
+
* Styles applied to the column header if the column is sortable.
|
|
4767
4762
|
*/
|
|
4768
|
-
|
|
4763
|
+
'columnHeader--sortable': string;
|
|
4769
4764
|
/**
|
|
4770
|
-
*
|
|
4771
|
-
* @default false
|
|
4765
|
+
* Styles applied to the column header if the column is sorted.
|
|
4772
4766
|
*/
|
|
4773
|
-
|
|
4767
|
+
'columnHeader--sorted': string;
|
|
4774
4768
|
/**
|
|
4775
|
-
*
|
|
4776
|
-
* @default false
|
|
4769
|
+
* Styles applied to the column header element.
|
|
4777
4770
|
*/
|
|
4778
|
-
|
|
4771
|
+
columnHeader: string;
|
|
4779
4772
|
/**
|
|
4780
|
-
*
|
|
4781
|
-
* @default false
|
|
4773
|
+
* Styles applied to the header checkbox cell element.
|
|
4782
4774
|
*/
|
|
4783
|
-
|
|
4775
|
+
columnHeaderCheckbox: string;
|
|
4784
4776
|
/**
|
|
4785
|
-
*
|
|
4786
|
-
* @default false
|
|
4777
|
+
* Styles applied to the column header's draggable container element.
|
|
4787
4778
|
*/
|
|
4788
|
-
|
|
4779
|
+
columnHeaderDraggableContainer: string;
|
|
4789
4780
|
/**
|
|
4790
|
-
*
|
|
4791
|
-
* @default false
|
|
4781
|
+
* Styles applied to the column headers wrapper if a column is being dragged.
|
|
4792
4782
|
*/
|
|
4793
|
-
|
|
4783
|
+
columnHeaderDropZone: string;
|
|
4794
4784
|
/**
|
|
4795
|
-
*
|
|
4796
|
-
* @default false
|
|
4785
|
+
* Styles applied to the column header's title element;
|
|
4797
4786
|
*/
|
|
4798
|
-
|
|
4787
|
+
columnHeaderTitle: string;
|
|
4799
4788
|
/**
|
|
4800
|
-
*
|
|
4801
|
-
* @default false
|
|
4789
|
+
* Styles applied to the column header's title container element.
|
|
4802
4790
|
*/
|
|
4803
|
-
|
|
4791
|
+
columnHeaderTitleContainer: string;
|
|
4804
4792
|
/**
|
|
4805
|
-
*
|
|
4806
|
-
* @default false
|
|
4793
|
+
* Styles applied to the column headers.
|
|
4807
4794
|
*/
|
|
4808
|
-
|
|
4795
|
+
columnHeaders: string;
|
|
4809
4796
|
/**
|
|
4810
|
-
*
|
|
4811
|
-
* @default "cell"
|
|
4797
|
+
* Styles applied to the column headers's inner element.
|
|
4812
4798
|
*/
|
|
4813
|
-
|
|
4799
|
+
columnHeadersInner: string;
|
|
4814
4800
|
/**
|
|
4815
|
-
*
|
|
4816
|
-
* Set it to 'server' if you would like to handle filtering on the server-side.
|
|
4817
|
-
* @default "client"
|
|
4801
|
+
* Styles applied to the column headers's inner element if there is a horizontal scrollbar.
|
|
4818
4802
|
*/
|
|
4819
|
-
|
|
4803
|
+
'columnHeadersInner--scrollable': string;
|
|
4820
4804
|
/**
|
|
4821
|
-
*
|
|
4822
|
-
* @default 56
|
|
4805
|
+
* Styles applied to the column header separator if the column is resizable.
|
|
4823
4806
|
*/
|
|
4824
|
-
|
|
4807
|
+
'columnSeparator--resizable': string;
|
|
4825
4808
|
/**
|
|
4826
|
-
*
|
|
4827
|
-
* @default false
|
|
4809
|
+
* Styles applied to the column header separator if the column is being resized.
|
|
4828
4810
|
*/
|
|
4829
|
-
|
|
4811
|
+
'columnSeparator--resizing': string;
|
|
4830
4812
|
/**
|
|
4831
|
-
*
|
|
4832
|
-
* @default false
|
|
4813
|
+
* Styles applied to the column header separator if the side is "left".
|
|
4833
4814
|
*/
|
|
4834
|
-
|
|
4815
|
+
'columnSeparator--sideLeft': string;
|
|
4835
4816
|
/**
|
|
4836
|
-
*
|
|
4837
|
-
* It has no effect if the pagination is enabled.
|
|
4838
|
-
* @default false
|
|
4817
|
+
* Styles applied to the column header separator if the side is "right".
|
|
4839
4818
|
*/
|
|
4840
|
-
|
|
4819
|
+
'columnSeparator--sideRight': string;
|
|
4841
4820
|
/**
|
|
4842
|
-
*
|
|
4843
|
-
* @default false
|
|
4821
|
+
* Styles applied to the column header separator element.
|
|
4844
4822
|
*/
|
|
4845
|
-
|
|
4823
|
+
columnSeparator: string;
|
|
4846
4824
|
/**
|
|
4847
|
-
*
|
|
4848
|
-
* @default console
|
|
4825
|
+
* Styles applied to the columns panel element.
|
|
4849
4826
|
*/
|
|
4850
|
-
|
|
4827
|
+
columnsPanel: string;
|
|
4851
4828
|
/**
|
|
4852
|
-
*
|
|
4853
|
-
* @default "debug"
|
|
4829
|
+
* Styles applied to the columns panel row element.
|
|
4854
4830
|
*/
|
|
4855
|
-
|
|
4856
|
-
/**
|
|
4857
|
-
* If `true`, pagination is enabled.
|
|
4858
|
-
* @default false
|
|
4859
|
-
*/
|
|
4860
|
-
pagination: boolean;
|
|
4861
|
-
/**
|
|
4862
|
-
* Pagination can be processed on the server or client-side.
|
|
4863
|
-
* Set it to 'client' if you would like to handle the pagination on the client-side.
|
|
4864
|
-
* Set it to 'server' if you would like to handle the pagination on the server-side.
|
|
4865
|
-
* @default "client"
|
|
4866
|
-
*/
|
|
4867
|
-
paginationMode: GridFeatureMode;
|
|
4868
|
-
/**
|
|
4869
|
-
* Set the height in pixel of a row in the grid.
|
|
4870
|
-
* @default 52
|
|
4871
|
-
*/
|
|
4872
|
-
rowHeight: number;
|
|
4873
|
-
/**
|
|
4874
|
-
* Select the pageSize dynamically using the component UI.
|
|
4875
|
-
* @default [25, 50, 100]
|
|
4876
|
-
*/
|
|
4877
|
-
rowsPerPageOptions: number[];
|
|
4831
|
+
columnsPanelRow: string;
|
|
4878
4832
|
/**
|
|
4879
|
-
*
|
|
4880
|
-
* @default false
|
|
4833
|
+
* Styles applied to the panel element.
|
|
4881
4834
|
*/
|
|
4882
|
-
|
|
4835
|
+
panel: string;
|
|
4883
4836
|
/**
|
|
4884
|
-
*
|
|
4885
|
-
* If equal to -1, all the row children will be expanded.
|
|
4886
|
-
* @default 0
|
|
4837
|
+
* Styles applied to the panel header element.
|
|
4887
4838
|
*/
|
|
4888
|
-
|
|
4839
|
+
panelHeader: string;
|
|
4889
4840
|
/**
|
|
4890
|
-
*
|
|
4891
|
-
* @default 80
|
|
4841
|
+
* Styles applied to the panel wrapper element.
|
|
4892
4842
|
*/
|
|
4893
|
-
|
|
4843
|
+
panelWrapper: string;
|
|
4894
4844
|
/**
|
|
4895
|
-
*
|
|
4896
|
-
* @default false
|
|
4845
|
+
* Styles applied to the panel content element.
|
|
4897
4846
|
*/
|
|
4898
|
-
|
|
4847
|
+
panelContent: string;
|
|
4899
4848
|
/**
|
|
4900
|
-
*
|
|
4901
|
-
* @default false
|
|
4849
|
+
* Styles applied to the panel footer element.
|
|
4902
4850
|
*/
|
|
4903
|
-
|
|
4851
|
+
panelFooter: string;
|
|
4904
4852
|
/**
|
|
4905
|
-
*
|
|
4906
|
-
* @default ['asc', 'desc', null]
|
|
4853
|
+
* Styles applied to the paper element.
|
|
4907
4854
|
*/
|
|
4908
|
-
|
|
4855
|
+
paper: string;
|
|
4909
4856
|
/**
|
|
4910
|
-
*
|
|
4911
|
-
* Set it to 'client' if you would like to handle sorting on the client-side.
|
|
4912
|
-
* Set it to 'server' if you would like to handle sorting on the server-side.
|
|
4913
|
-
* @default "client"
|
|
4857
|
+
* Styles applied to root of the boolean edit component.
|
|
4914
4858
|
*/
|
|
4915
|
-
|
|
4859
|
+
editBooleanCell: string;
|
|
4916
4860
|
/**
|
|
4917
|
-
*
|
|
4918
|
-
* 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.
|
|
4919
|
-
* @default 0
|
|
4861
|
+
* Styles applied to the root of the filter form component.
|
|
4920
4862
|
*/
|
|
4921
|
-
|
|
4922
|
-
}
|
|
4923
|
-
|
|
4924
|
-
interface GridClasses {
|
|
4863
|
+
filterForm: string;
|
|
4925
4864
|
/**
|
|
4926
|
-
* Styles applied to the root
|
|
4865
|
+
* Styles applied to the root of the input component.
|
|
4927
4866
|
*/
|
|
4928
|
-
|
|
4867
|
+
editInputCell: string;
|
|
4929
4868
|
/**
|
|
4930
|
-
* Styles applied to the icon
|
|
4869
|
+
* Styles applied to the filter icon element.
|
|
4931
4870
|
*/
|
|
4932
|
-
|
|
4871
|
+
filterIcon: string;
|
|
4933
4872
|
/**
|
|
4934
|
-
* Styles applied to the
|
|
4873
|
+
* Styles applied to the footer container element.
|
|
4935
4874
|
*/
|
|
4936
|
-
|
|
4875
|
+
footerContainer: string;
|
|
4937
4876
|
/**
|
|
4938
|
-
* Styles applied to the
|
|
4877
|
+
* Styles applied to the column header icon's container.
|
|
4939
4878
|
*/
|
|
4940
|
-
|
|
4879
|
+
iconButtonContainer: string;
|
|
4941
4880
|
/**
|
|
4942
|
-
* Styles applied to the
|
|
4881
|
+
* Styles applied to the column header separator icon element.
|
|
4943
4882
|
*/
|
|
4944
|
-
|
|
4883
|
+
iconSeparator: string;
|
|
4945
4884
|
/**
|
|
4946
|
-
* Styles applied to the
|
|
4885
|
+
* Styles applied to the main container element.
|
|
4947
4886
|
*/
|
|
4948
|
-
|
|
4887
|
+
main: string;
|
|
4949
4888
|
/**
|
|
4950
|
-
* Styles applied to the
|
|
4889
|
+
* Styles applied to the menu element.
|
|
4951
4890
|
*/
|
|
4952
|
-
|
|
4891
|
+
menu: string;
|
|
4953
4892
|
/**
|
|
4954
|
-
* Styles applied to the
|
|
4893
|
+
* Styles applied to the menu icon element.
|
|
4955
4894
|
*/
|
|
4956
|
-
|
|
4895
|
+
menuIcon: string;
|
|
4957
4896
|
/**
|
|
4958
|
-
* Styles applied to the
|
|
4897
|
+
* Styles applied to the menu icon button element.
|
|
4959
4898
|
*/
|
|
4960
|
-
|
|
4899
|
+
menuIconButton: string;
|
|
4961
4900
|
/**
|
|
4962
|
-
* Styles applied to the
|
|
4901
|
+
* Styles applied to the menu icon element if the menu is open.
|
|
4963
4902
|
*/
|
|
4964
|
-
|
|
4903
|
+
menuOpen: string;
|
|
4965
4904
|
/**
|
|
4966
|
-
* Styles applied to the
|
|
4905
|
+
* Styles applied to the menu list element.
|
|
4967
4906
|
*/
|
|
4968
|
-
|
|
4907
|
+
menuList: string;
|
|
4969
4908
|
/**
|
|
4970
|
-
* Styles applied to the
|
|
4909
|
+
* Styles applied to the overlay element.
|
|
4971
4910
|
*/
|
|
4972
|
-
|
|
4911
|
+
overlay: string;
|
|
4973
4912
|
/**
|
|
4974
|
-
* Styles applied to the
|
|
4913
|
+
* Styles applied to the virtualization container.
|
|
4975
4914
|
*/
|
|
4976
|
-
|
|
4915
|
+
virtualScroller: string;
|
|
4977
4916
|
/**
|
|
4978
|
-
* Styles applied to the
|
|
4917
|
+
* Styles applied to the virtualization content.
|
|
4979
4918
|
*/
|
|
4980
|
-
|
|
4919
|
+
virtualScrollerContent: string;
|
|
4981
4920
|
/**
|
|
4982
|
-
* Styles applied to the
|
|
4921
|
+
* Styles applied to the virtualization render zone.
|
|
4983
4922
|
*/
|
|
4984
|
-
|
|
4923
|
+
virtualScrollerRenderZone: string;
|
|
4985
4924
|
/**
|
|
4986
|
-
* Styles applied to the
|
|
4925
|
+
* Styles applied to the pinned columns.
|
|
4987
4926
|
*/
|
|
4988
|
-
|
|
4927
|
+
pinnedColumns: string;
|
|
4989
4928
|
/**
|
|
4990
|
-
* Styles applied to the
|
|
4929
|
+
* Styles applied to the left pinned columns.
|
|
4991
4930
|
*/
|
|
4992
|
-
'
|
|
4931
|
+
'pinnedColumns--left': string;
|
|
4993
4932
|
/**
|
|
4994
|
-
* Styles applied to the
|
|
4933
|
+
* Styles applied to the right pinned columns.
|
|
4995
4934
|
*/
|
|
4996
|
-
'
|
|
4935
|
+
'pinnedColumns--right': string;
|
|
4997
4936
|
/**
|
|
4998
|
-
* Styles applied to the
|
|
4937
|
+
* Styles applied to the root element.
|
|
4999
4938
|
*/
|
|
5000
|
-
|
|
4939
|
+
root: string;
|
|
5001
4940
|
/**
|
|
5002
|
-
* Styles applied to the
|
|
4941
|
+
* Styles applied to the row element if the row is editable.
|
|
5003
4942
|
*/
|
|
5004
|
-
|
|
4943
|
+
'row--editable': string;
|
|
5005
4944
|
/**
|
|
5006
|
-
* Styles applied to the
|
|
4945
|
+
* Styles applied to the row element if the row is in edit mode.
|
|
5007
4946
|
*/
|
|
5008
|
-
|
|
4947
|
+
'row--editing': string;
|
|
5009
4948
|
/**
|
|
5010
|
-
* Styles applied to the
|
|
4949
|
+
* Styles applied to the row element.
|
|
5011
4950
|
*/
|
|
5012
|
-
|
|
4951
|
+
row: string;
|
|
5013
4952
|
/**
|
|
5014
|
-
* Styles applied to the
|
|
4953
|
+
* Styles applied to the footer row count element to show the total number of rows.
|
|
4954
|
+
* Only works when pagination is disabled.
|
|
5015
4955
|
*/
|
|
5016
|
-
|
|
4956
|
+
rowCount: string;
|
|
5017
4957
|
/**
|
|
5018
|
-
* Styles applied to
|
|
4958
|
+
* Styles applied to both scroll area elements.
|
|
5019
4959
|
*/
|
|
5020
|
-
|
|
4960
|
+
scrollArea: string;
|
|
5021
4961
|
/**
|
|
5022
|
-
* Styles applied to the
|
|
4962
|
+
* Styles applied to the left scroll area element.
|
|
5023
4963
|
*/
|
|
5024
|
-
|
|
4964
|
+
'scrollArea--left': string;
|
|
5025
4965
|
/**
|
|
5026
|
-
* Styles applied to the
|
|
4966
|
+
* Styles applied to the right scroll area element.
|
|
5027
4967
|
*/
|
|
5028
|
-
|
|
4968
|
+
'scrollArea--right': string;
|
|
5029
4969
|
/**
|
|
5030
|
-
* Styles applied to the
|
|
4970
|
+
* Styles applied to the footer selected row count element.
|
|
5031
4971
|
*/
|
|
5032
|
-
|
|
4972
|
+
selectedRowCount: string;
|
|
5033
4973
|
/**
|
|
5034
|
-
* Styles applied to the
|
|
4974
|
+
* Styles applied to the sort icon element.
|
|
5035
4975
|
*/
|
|
5036
|
-
|
|
4976
|
+
sortIcon: string;
|
|
5037
4977
|
/**
|
|
5038
|
-
* Styles applied to the
|
|
4978
|
+
* Styles applied to the toolbar container element.
|
|
5039
4979
|
*/
|
|
5040
|
-
|
|
4980
|
+
toolbarContainer: string;
|
|
5041
4981
|
/**
|
|
5042
|
-
* Styles applied to the
|
|
4982
|
+
* Styles applied to the toolbar filter list element.
|
|
5043
4983
|
*/
|
|
5044
|
-
|
|
4984
|
+
toolbarFilterList: string;
|
|
5045
4985
|
/**
|
|
5046
|
-
* Styles applied to the column header
|
|
4986
|
+
* Styles applied to both the cell and the column header if `showColumnRightBorder={true}`.
|
|
5047
4987
|
*/
|
|
5048
|
-
|
|
4988
|
+
withBorder: string;
|
|
5049
4989
|
/**
|
|
5050
|
-
* Styles applied to the
|
|
4990
|
+
* Styles applied to the root of the grouping column of the tree data.
|
|
5051
4991
|
*/
|
|
5052
|
-
|
|
4992
|
+
treeDataGroupingCell: string;
|
|
5053
4993
|
/**
|
|
5054
|
-
* Styles applied to the
|
|
4994
|
+
* Styles applied to the toggle of the grouping column of the tree data.
|
|
5055
4995
|
*/
|
|
5056
|
-
|
|
4996
|
+
treeDataGroupingCellToggle: string;
|
|
4997
|
+
}
|
|
4998
|
+
declare type GridClassKey = keyof GridClasses;
|
|
4999
|
+
declare function getDataGridUtilityClass(slot: string): string;
|
|
5000
|
+
declare const gridClasses: Record<"actionsCell" | "autoHeight" | "booleanCell" | "cell--editable" | "cell--editing" | "cell--textCenter" | "cell--textLeft" | "cell--textRight" | "cell--withRenderer" | "cell" | "cellCheckbox" | "checkboxInput" | "columnHeader--alignCenter" | "columnHeader--alignLeft" | "columnHeader--alignRight" | "columnHeader--dragging" | "columnHeader--moving" | "columnHeader--numeric" | "columnHeader--sortable" | "columnHeader--sorted" | "columnHeader" | "columnHeaderCheckbox" | "columnHeaderDraggableContainer" | "columnHeaderDropZone" | "columnHeaderTitle" | "columnHeaderTitleContainer" | "columnHeaders" | "columnHeadersInner" | "columnHeadersInner--scrollable" | "columnSeparator--resizable" | "columnSeparator--resizing" | "columnSeparator--sideLeft" | "columnSeparator--sideRight" | "columnSeparator" | "columnsPanel" | "columnsPanelRow" | "panel" | "panelHeader" | "panelWrapper" | "panelContent" | "panelFooter" | "paper" | "editBooleanCell" | "editInputCell" | "filterForm" | "filterIcon" | "footerContainer" | "iconButtonContainer" | "iconSeparator" | "main" | "menu" | "menuIcon" | "menuIconButton" | "menuOpen" | "menuList" | "overlay" | "root" | "row--editable" | "row--editing" | "row" | "rowCount" | "scrollArea--left" | "scrollArea--right" | "scrollArea" | "selectedRowCount" | "sortIcon" | "toolbarContainer" | "toolbarFilterList" | "virtualScroller" | "virtualScrollerContent" | "virtualScrollerRenderZone" | "pinnedColumns" | "pinnedColumns--left" | "pinnedColumns--right" | "withBorder" | "treeDataGroupingCell" | "treeDataGroupingCellToggle", string>;
|
|
5001
|
+
|
|
5002
|
+
/**
|
|
5003
|
+
* The props users can give to the `DataGrid` component.
|
|
5004
|
+
*/
|
|
5005
|
+
declare type DataGridProps = Omit<Partial<DataGridPropsWithDefaultValues> & DataGridPropsWithComplexDefaultValueBeforeProcessing & DataGridPropsWithoutDefaultValue, DataGridForcedPropsKey> & {
|
|
5006
|
+
pagination?: true;
|
|
5007
|
+
};
|
|
5008
|
+
/**
|
|
5009
|
+
* The props of the `DataGrid` component after the pre-processing phase.
|
|
5010
|
+
*/
|
|
5011
|
+
interface DataGridProcessedProps extends DataGridPropsWithDefaultValues, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridPropsWithoutDefaultValue {
|
|
5012
|
+
}
|
|
5013
|
+
/**
|
|
5014
|
+
* The props of the `DataGrid` component after the pre-processing phase that the user should not be able to override.
|
|
5015
|
+
* Those are usually used in feature-hook for which the pro-plan has more advanced features (eg: multi-sorting, multi-filtering, ...).
|
|
5016
|
+
*/
|
|
5017
|
+
declare type DataGridForcedPropsKey = 'apiRef' | 'checkboxSelectionVisibleOnly' | 'disableMultipleColumnsFiltering' | 'disableMultipleColumnsSorting' | 'disableMultipleSelection' | 'disableColumnReorder' | 'disableColumnResize' | 'throttleRowsMs' | 'hideFooterRowCount' | 'pagination' | 'signature';
|
|
5018
|
+
/**
|
|
5019
|
+
* The `DataGrid` options with a default value that must be merged with the value given through props.
|
|
5020
|
+
*/
|
|
5021
|
+
interface DataGridPropsWithComplexDefaultValueAfterProcessing {
|
|
5022
|
+
components: GridSlotsComponent;
|
|
5023
|
+
localeText: GridLocaleText;
|
|
5024
|
+
}
|
|
5025
|
+
/**
|
|
5026
|
+
* The `DataGrid` options with a default value that must be merged with the value given through props.
|
|
5027
|
+
*/
|
|
5028
|
+
interface DataGridPropsWithComplexDefaultValueBeforeProcessing {
|
|
5057
5029
|
/**
|
|
5058
|
-
*
|
|
5030
|
+
* Overrideable components.
|
|
5059
5031
|
*/
|
|
5060
|
-
|
|
5032
|
+
components?: Partial<GridSlotsComponent>;
|
|
5061
5033
|
/**
|
|
5062
|
-
*
|
|
5034
|
+
* Set the locale text of the grid.
|
|
5035
|
+
* You can find all the translation keys supported in [the source](https://github.com/mui-org/material-ui-x/blob/HEAD/packages/grid/_modules_/grid/constants/localeTextConstants.ts) in the GitHub repository.
|
|
5063
5036
|
*/
|
|
5064
|
-
|
|
5037
|
+
localeText?: Partial<GridLocaleText>;
|
|
5038
|
+
}
|
|
5039
|
+
/**
|
|
5040
|
+
* The `DataGrid` options with a default value overridable through props
|
|
5041
|
+
* None of the entry of this interface should be optional, they all have default values and `DataGridProps` already applies a `Partial<DataGridSimpleOptions>` for the public interface
|
|
5042
|
+
* The controlled model do not have a default value at the prop processing level, so they must be defined in `DataGridOtherProps`
|
|
5043
|
+
* TODO: add multiSortKey
|
|
5044
|
+
*/
|
|
5045
|
+
interface DataGridPropsWithDefaultValues {
|
|
5065
5046
|
/**
|
|
5066
|
-
*
|
|
5047
|
+
* If `true`, the grid height is dynamic and follow the number of rows in the grid.
|
|
5048
|
+
* @default false
|
|
5067
5049
|
*/
|
|
5068
|
-
|
|
5050
|
+
autoHeight: boolean;
|
|
5069
5051
|
/**
|
|
5070
|
-
*
|
|
5052
|
+
* If `true`, the pageSize is calculated according to the container size and the max number of rows to avoid rendering a vertical scroll bar.
|
|
5053
|
+
* @default false
|
|
5071
5054
|
*/
|
|
5072
|
-
|
|
5055
|
+
autoPageSize: boolean;
|
|
5073
5056
|
/**
|
|
5074
|
-
*
|
|
5057
|
+
* If `true`, the grid get a first column with a checkbox that allows to select rows.
|
|
5058
|
+
* @default false
|
|
5075
5059
|
*/
|
|
5076
|
-
|
|
5060
|
+
checkboxSelection: boolean;
|
|
5077
5061
|
/**
|
|
5078
|
-
*
|
|
5062
|
+
* If `true`, the "Select All" header checkbox selects only the rows on the current page. To be used in combination with `checkboxSelection`.
|
|
5063
|
+
* It only works if the pagination is enabled.
|
|
5064
|
+
* @default false
|
|
5079
5065
|
*/
|
|
5080
|
-
|
|
5066
|
+
checkboxSelectionVisibleOnly: boolean;
|
|
5081
5067
|
/**
|
|
5082
|
-
*
|
|
5068
|
+
* Number of extra columns to be rendered before/after the visible slice.
|
|
5069
|
+
* @default 3
|
|
5083
5070
|
*/
|
|
5084
|
-
|
|
5071
|
+
columnBuffer: number;
|
|
5085
5072
|
/**
|
|
5086
|
-
*
|
|
5073
|
+
* Number of extra rows to be rendered before/after the visible slice.
|
|
5074
|
+
* @default 3
|
|
5087
5075
|
*/
|
|
5088
|
-
|
|
5076
|
+
rowBuffer: number;
|
|
5089
5077
|
/**
|
|
5090
|
-
*
|
|
5078
|
+
* Number of rows from the `rowBuffer` that can be visible before a new slice is rendered.
|
|
5079
|
+
* @default 3
|
|
5091
5080
|
*/
|
|
5092
|
-
|
|
5081
|
+
rowThreshold: number;
|
|
5093
5082
|
/**
|
|
5094
|
-
*
|
|
5083
|
+
* Number of rows from the `columnBuffer` that can be visible before a new slice is rendered.
|
|
5084
|
+
* @default 3
|
|
5095
5085
|
*/
|
|
5096
|
-
|
|
5086
|
+
columnThreshold: number;
|
|
5097
5087
|
/**
|
|
5098
|
-
*
|
|
5088
|
+
* Set the density of the grid.
|
|
5089
|
+
* @default "standard"
|
|
5099
5090
|
*/
|
|
5100
|
-
|
|
5091
|
+
density: GridDensity;
|
|
5101
5092
|
/**
|
|
5102
|
-
*
|
|
5093
|
+
* If `true`, rows will not be extended to fill the full width of the grid container.
|
|
5094
|
+
* @default false
|
|
5103
5095
|
*/
|
|
5104
|
-
|
|
5096
|
+
disableExtendRowFullWidth: boolean;
|
|
5105
5097
|
/**
|
|
5106
|
-
*
|
|
5098
|
+
* If `true`, column filters are disabled.
|
|
5099
|
+
* @default false
|
|
5107
5100
|
*/
|
|
5108
|
-
|
|
5101
|
+
disableColumnFilter: boolean;
|
|
5109
5102
|
/**
|
|
5110
|
-
*
|
|
5103
|
+
* If `true`, the column menu is disabled.
|
|
5104
|
+
* @default false
|
|
5111
5105
|
*/
|
|
5112
|
-
|
|
5106
|
+
disableColumnMenu: boolean;
|
|
5113
5107
|
/**
|
|
5114
|
-
*
|
|
5108
|
+
* If `true`, hiding/showing columns is disabled.
|
|
5109
|
+
* @default false
|
|
5115
5110
|
*/
|
|
5116
|
-
|
|
5111
|
+
disableColumnSelector: boolean;
|
|
5117
5112
|
/**
|
|
5118
|
-
*
|
|
5113
|
+
* If `true`, the density selector is disabled.
|
|
5114
|
+
* @default false
|
|
5119
5115
|
*/
|
|
5120
|
-
|
|
5116
|
+
disableDensitySelector: boolean;
|
|
5121
5117
|
/**
|
|
5122
|
-
*
|
|
5118
|
+
* If `true`, filtering with multiple columns is disabled.
|
|
5119
|
+
* @default false
|
|
5123
5120
|
*/
|
|
5124
|
-
|
|
5121
|
+
disableMultipleColumnsFiltering: boolean;
|
|
5125
5122
|
/**
|
|
5126
|
-
*
|
|
5123
|
+
* If `true`, multiple selection using the CTRL or CMD key is disabled.
|
|
5124
|
+
* @default false
|
|
5127
5125
|
*/
|
|
5128
|
-
|
|
5126
|
+
disableMultipleSelection: boolean;
|
|
5129
5127
|
/**
|
|
5130
|
-
*
|
|
5128
|
+
* If `true`, sorting with multiple columns is disabled.
|
|
5129
|
+
* @default false
|
|
5131
5130
|
*/
|
|
5132
|
-
|
|
5131
|
+
disableMultipleColumnsSorting: boolean;
|
|
5133
5132
|
/**
|
|
5134
|
-
*
|
|
5133
|
+
* If `true`, the selection on click on a row or cell is disabled.
|
|
5134
|
+
* @default false
|
|
5135
5135
|
*/
|
|
5136
|
-
|
|
5136
|
+
disableSelectionOnClick: boolean;
|
|
5137
5137
|
/**
|
|
5138
|
-
*
|
|
5138
|
+
* If `true`, the virtualization is disabled.
|
|
5139
|
+
* @default false
|
|
5139
5140
|
*/
|
|
5140
|
-
|
|
5141
|
+
disableVirtualization: boolean;
|
|
5141
5142
|
/**
|
|
5142
|
-
*
|
|
5143
|
+
* Controls whether to use the cell or row editing.
|
|
5144
|
+
* @default "cell"
|
|
5143
5145
|
*/
|
|
5144
|
-
|
|
5146
|
+
editMode: GridEditMode;
|
|
5145
5147
|
/**
|
|
5146
|
-
*
|
|
5148
|
+
* Filtering can be processed on the server or client-side.
|
|
5149
|
+
* Set it to 'server' if you would like to handle filtering on the server-side.
|
|
5150
|
+
* @default "client"
|
|
5147
5151
|
*/
|
|
5148
|
-
|
|
5152
|
+
filterMode: GridFeatureMode;
|
|
5149
5153
|
/**
|
|
5150
|
-
*
|
|
5154
|
+
* Set the height in pixel of the column headers in the grid.
|
|
5155
|
+
* @default 56
|
|
5151
5156
|
*/
|
|
5152
|
-
|
|
5157
|
+
headerHeight: number;
|
|
5153
5158
|
/**
|
|
5154
|
-
*
|
|
5159
|
+
* If `true`, the footer component is hidden.
|
|
5160
|
+
* @default false
|
|
5155
5161
|
*/
|
|
5156
|
-
|
|
5162
|
+
hideFooter: boolean;
|
|
5157
5163
|
/**
|
|
5158
|
-
*
|
|
5164
|
+
* If `true`, the pagination component in the footer is hidden.
|
|
5165
|
+
* @default false
|
|
5159
5166
|
*/
|
|
5160
|
-
|
|
5167
|
+
hideFooterPagination: boolean;
|
|
5161
5168
|
/**
|
|
5162
|
-
*
|
|
5169
|
+
* If `true`, the row count in the footer is hidden.
|
|
5170
|
+
* It has no effect if the pagination is enabled.
|
|
5171
|
+
* @default false
|
|
5163
5172
|
*/
|
|
5164
|
-
|
|
5173
|
+
hideFooterRowCount: boolean;
|
|
5165
5174
|
/**
|
|
5166
|
-
*
|
|
5175
|
+
* If `true`, the selected row count in the footer is hidden.
|
|
5176
|
+
* @default false
|
|
5167
5177
|
*/
|
|
5168
|
-
|
|
5178
|
+
hideFooterSelectedRowCount: boolean;
|
|
5169
5179
|
/**
|
|
5170
|
-
*
|
|
5180
|
+
* Pass a custom logger in the components that implements the [[Logger]] interface.
|
|
5181
|
+
* @default console
|
|
5171
5182
|
*/
|
|
5172
|
-
|
|
5183
|
+
logger: Logger;
|
|
5173
5184
|
/**
|
|
5174
|
-
*
|
|
5185
|
+
* Allows to pass the logging level or false to turn off logging.
|
|
5186
|
+
* @default "debug"
|
|
5175
5187
|
*/
|
|
5176
|
-
|
|
5188
|
+
logLevel: keyof Logger | false;
|
|
5177
5189
|
/**
|
|
5178
|
-
*
|
|
5179
|
-
*
|
|
5190
|
+
* If `true`, pagination is enabled.
|
|
5191
|
+
* @default false
|
|
5180
5192
|
*/
|
|
5181
|
-
|
|
5193
|
+
pagination: boolean;
|
|
5182
5194
|
/**
|
|
5183
|
-
*
|
|
5195
|
+
* Pagination can be processed on the server or client-side.
|
|
5196
|
+
* Set it to 'client' if you would like to handle the pagination on the client-side.
|
|
5197
|
+
* Set it to 'server' if you would like to handle the pagination on the server-side.
|
|
5198
|
+
* @default "client"
|
|
5184
5199
|
*/
|
|
5185
|
-
|
|
5200
|
+
paginationMode: GridFeatureMode;
|
|
5186
5201
|
/**
|
|
5187
|
-
*
|
|
5202
|
+
* Set the height in pixel of a row in the grid.
|
|
5203
|
+
* @default 52
|
|
5188
5204
|
*/
|
|
5189
|
-
|
|
5205
|
+
rowHeight: number;
|
|
5190
5206
|
/**
|
|
5191
|
-
*
|
|
5207
|
+
* Select the pageSize dynamically using the component UI.
|
|
5208
|
+
* @default [25, 50, 100]
|
|
5192
5209
|
*/
|
|
5193
|
-
|
|
5210
|
+
rowsPerPageOptions: number[];
|
|
5194
5211
|
/**
|
|
5195
|
-
*
|
|
5212
|
+
* If `true`, the right border of the cells are displayed.
|
|
5213
|
+
* @default false
|
|
5196
5214
|
*/
|
|
5197
|
-
|
|
5215
|
+
showCellRightBorder: boolean;
|
|
5198
5216
|
/**
|
|
5199
|
-
*
|
|
5217
|
+
* If `true`, the right border of the column headers are displayed.
|
|
5218
|
+
* @default false
|
|
5200
5219
|
*/
|
|
5201
|
-
|
|
5220
|
+
showColumnRightBorder: boolean;
|
|
5202
5221
|
/**
|
|
5203
|
-
*
|
|
5222
|
+
* The order of the sorting sequence.
|
|
5223
|
+
* @default ['asc', 'desc', null]
|
|
5204
5224
|
*/
|
|
5205
|
-
|
|
5225
|
+
sortingOrder: GridSortDirection[];
|
|
5206
5226
|
/**
|
|
5207
|
-
*
|
|
5227
|
+
* Sorting can be processed on the server or client-side.
|
|
5228
|
+
* Set it to 'client' if you would like to handle sorting on the client-side.
|
|
5229
|
+
* Set it to 'server' if you would like to handle sorting on the server-side.
|
|
5230
|
+
* @default "client"
|
|
5208
5231
|
*/
|
|
5209
|
-
|
|
5232
|
+
sortingMode: GridFeatureMode;
|
|
5210
5233
|
/**
|
|
5211
|
-
*
|
|
5234
|
+
* If positive, the Grid will throttle updates coming from `apiRef.current.updateRows` and `apiRef.current.setRows`.
|
|
5235
|
+
* 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.
|
|
5236
|
+
* @default 0
|
|
5212
5237
|
*/
|
|
5213
|
-
|
|
5238
|
+
throttleRowsMs: number;
|
|
5214
5239
|
/**
|
|
5215
|
-
*
|
|
5240
|
+
* If `true`, reordering columns is disabled.
|
|
5241
|
+
* @default false
|
|
5216
5242
|
*/
|
|
5217
|
-
|
|
5243
|
+
disableColumnReorder: boolean;
|
|
5218
5244
|
/**
|
|
5219
|
-
*
|
|
5245
|
+
* If `true`, resizing columns is disabled.
|
|
5246
|
+
* @default false
|
|
5220
5247
|
*/
|
|
5221
|
-
|
|
5222
|
-
}
|
|
5223
|
-
declare type GridClassKey = keyof GridClasses;
|
|
5224
|
-
declare function getDataGridUtilityClass(slot: string): string;
|
|
5225
|
-
declare const gridClasses: Record<"actionsCell" | "autoHeight" | "booleanCell" | "cell--editable" | "cell--editing" | "cell--textCenter" | "cell--textLeft" | "cell--textRight" | "cell--withRenderer" | "cell" | "cellCheckbox" | "checkboxInput" | "columnHeader--alignCenter" | "columnHeader--alignLeft" | "columnHeader--alignRight" | "columnHeader--dragging" | "columnHeader--moving" | "columnHeader--numeric" | "columnHeader--sortable" | "columnHeader--sorted" | "columnHeader" | "columnHeaderCheckbox" | "columnHeaderDraggableContainer" | "columnHeaderDropZone" | "columnHeaderTitle" | "columnHeaderTitleContainer" | "columnHeaders" | "columnHeadersInner" | "columnHeadersInner--scrollable" | "columnSeparator--resizable" | "columnSeparator--resizing" | "columnSeparator" | "columnsPanel" | "columnsPanelRow" | "panel" | "panelHeader" | "panelWrapper" | "panelContent" | "panelFooter" | "paper" | "editBooleanCell" | "editInputCell" | "filterForm" | "filterIcon" | "footerContainer" | "iconButtonContainer" | "iconSeparator" | "main" | "menu" | "menuIcon" | "menuIconButton" | "menuOpen" | "menuList" | "overlay" | "root" | "row--editable" | "row--editing" | "row" | "rowCount" | "scrollArea--left" | "scrollArea--right" | "scrollArea" | "selectedRowCount" | "sortIcon" | "toolbarContainer" | "toolbarFilterList" | "virtualScroller" | "virtualScrollerContent" | "virtualScrollerRenderZone" | "pinnedColumns" | "pinnedColumns--left" | "pinnedColumns--right" | "withBorder" | "treeDataGroupingCell" | "treeDataGroupingCellToggle", string>;
|
|
5226
|
-
|
|
5227
|
-
/**
|
|
5228
|
-
* The grid component react props before applying the default values.
|
|
5229
|
-
*/
|
|
5230
|
-
interface GridInputComponentProps extends Partial<GridSimpleOptions>, Partial<GridMergedOptions>, GridComponentOtherProps {
|
|
5248
|
+
disableColumnResize: boolean;
|
|
5231
5249
|
}
|
|
5232
5250
|
/**
|
|
5233
|
-
* The
|
|
5251
|
+
* The `DataGrid` props with no default value.
|
|
5234
5252
|
*/
|
|
5235
|
-
interface
|
|
5236
|
-
}
|
|
5237
|
-
interface GridComponentOtherProps extends CommonProps {
|
|
5253
|
+
interface DataGridPropsWithoutDefaultValue extends CommonProps {
|
|
5238
5254
|
/**
|
|
5239
5255
|
* The ref object that allows grid manipulation. Can be instantiated with [[useGridApiRef()]].
|
|
5240
5256
|
*/
|
|
@@ -5286,14 +5302,6 @@ interface GridComponentOtherProps extends CommonProps {
|
|
|
5286
5302
|
* @returns {boolean} A boolean indicating if the cell is selectable.
|
|
5287
5303
|
*/
|
|
5288
5304
|
isRowSelectable?: (params: GridRowParams) => boolean;
|
|
5289
|
-
/**
|
|
5290
|
-
* Determines the path of a row in the tree data.
|
|
5291
|
-
* For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"].
|
|
5292
|
-
* Note that all paths must contain at least one element.
|
|
5293
|
-
* @param {GridRowModel} row The row from which we want the path.
|
|
5294
|
-
* @returns {string[]} The path to the row.
|
|
5295
|
-
*/
|
|
5296
|
-
getTreeDataPath?: (row: GridRowModel) => string[];
|
|
5297
5305
|
/**
|
|
5298
5306
|
* Callback fired when the edit cell value changes.
|
|
5299
5307
|
* @param {GridEditCellPropsParams} params With all properties from [[GridEditCellPropsParams]].
|
|
@@ -5423,20 +5431,6 @@ interface GridComponentOtherProps extends CommonProps {
|
|
|
5423
5431
|
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5424
5432
|
*/
|
|
5425
5433
|
onColumnOrderChange?: GridEventListener<GridEvents.columnOrderChange>;
|
|
5426
|
-
/**
|
|
5427
|
-
* Callback fired while a column is being resized.
|
|
5428
|
-
* @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
|
|
5429
|
-
* @param {MuiEvent<React.MouseEvent>} event The event object.
|
|
5430
|
-
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5431
|
-
*/
|
|
5432
|
-
onColumnResize?: GridEventListener<GridEvents.columnResize>;
|
|
5433
|
-
/**
|
|
5434
|
-
* Callback fired when the width of a column is changed.
|
|
5435
|
-
* @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
|
|
5436
|
-
* @param {MuiEvent<React.MouseEvent>} event The event object.
|
|
5437
|
-
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5438
|
-
*/
|
|
5439
|
-
onColumnWidthChange?: GridEventListener<GridEvents.columnWidthChange>;
|
|
5440
5434
|
/**
|
|
5441
5435
|
* Callback fired when a column visibility changes.
|
|
5442
5436
|
* @param {GridColumnVisibilityChangeParams} params With all properties from [[GridColumnVisibilityChangeParams]].
|
|
@@ -5451,13 +5445,6 @@ interface GridComponentOtherProps extends CommonProps {
|
|
|
5451
5445
|
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5452
5446
|
*/
|
|
5453
5447
|
onRowClick?: GridEventListener<GridEvents.rowClick>;
|
|
5454
|
-
/**
|
|
5455
|
-
* Callback fired when scrolling to the bottom of the grid viewport.
|
|
5456
|
-
* @param {GridRowScrollEndParams} params With all properties from [[GridRowScrollEndParams]].
|
|
5457
|
-
* @param {MuiEvent<{}>} event The event object.
|
|
5458
|
-
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5459
|
-
*/
|
|
5460
|
-
onRowsScrollEnd?: GridEventListener<GridEvents.rowsScrollEnd>;
|
|
5461
5448
|
/**
|
|
5462
5449
|
* Callback fired when a double click event comes from a row container element.
|
|
5463
5450
|
* @param {GridRowParams} params With all properties from [[RowParams]].
|
|
@@ -5543,16 +5530,6 @@ interface GridComponentOtherProps extends CommonProps {
|
|
|
5543
5530
|
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5544
5531
|
*/
|
|
5545
5532
|
onSortModelChange?: (model: GridSortModel, details: GridCallbackDetails) => void;
|
|
5546
|
-
/**
|
|
5547
|
-
* The column fields to display pinned to left or right.
|
|
5548
|
-
*/
|
|
5549
|
-
pinnedColumns?: GridPinnedColumns;
|
|
5550
|
-
/**
|
|
5551
|
-
* Callback fired when the pinned columns have changed.
|
|
5552
|
-
* @param {GridPinnedColumns} pinnedColumns The changed pinned columns.
|
|
5553
|
-
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5554
|
-
*/
|
|
5555
|
-
onPinnedColumnsChange?: (pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void;
|
|
5556
5533
|
/**
|
|
5557
5534
|
* The label of the grid.
|
|
5558
5535
|
*/
|
|
@@ -5595,22 +5572,127 @@ interface GridComponentOtherProps extends CommonProps {
|
|
|
5595
5572
|
* Overrideable components props dynamically passed to the component at rendering.
|
|
5596
5573
|
*/
|
|
5597
5574
|
componentsProps?: GridSlotsComponentsProps;
|
|
5598
|
-
/**
|
|
5599
|
-
* The grouping column used by the tree data.
|
|
5600
|
-
*/
|
|
5601
|
-
groupingColDef?: GridGroupingColDefOverride | ((params: GridGroupingColDefOverrideParams) => GridGroupingColDefOverride | undefined | null);
|
|
5602
5575
|
/**
|
|
5603
5576
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
5604
5577
|
*/
|
|
5605
5578
|
sx?: SxProps<Theme>;
|
|
5606
5579
|
}
|
|
5607
5580
|
|
|
5608
|
-
|
|
5581
|
+
/**
|
|
5582
|
+
* The props of the `DataGridPro` component after the pre-processing phase.
|
|
5583
|
+
*/
|
|
5584
|
+
interface DataGridProProcessedProps extends DataGridProPropsWithDefaultValue, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridProPropsWithoutDefaultValue {
|
|
5585
|
+
}
|
|
5586
|
+
/**
|
|
5587
|
+
* The `DataGridPro` options with a default value overridable through props
|
|
5588
|
+
* None of the entry of this interface should be optional, they all have default values and `DataGridProps` already applies a `Partial<DataGridSimpleOptions>` for the public interface
|
|
5589
|
+
* The controlled model do not have a default value at the prop processing level, so they must be defined in `DataGridOtherProps`
|
|
5590
|
+
*/
|
|
5591
|
+
interface DataGridProPropsWithDefaultValue extends DataGridPropsWithDefaultValues {
|
|
5592
|
+
/**
|
|
5593
|
+
* Set the area in `px` at the bottom of the grid viewport where onRowsScrollEnd is called.
|
|
5594
|
+
* @default 80
|
|
5595
|
+
*/
|
|
5596
|
+
scrollEndThreshold: number;
|
|
5597
|
+
/**
|
|
5598
|
+
* If `true`, the rows will be gathered in a tree structure according to the `getTreeDataPath` prop.
|
|
5599
|
+
* @default false
|
|
5600
|
+
*/
|
|
5601
|
+
treeData: boolean;
|
|
5602
|
+
/**
|
|
5603
|
+
* If above 0, the row children will be expanded up to this depth.
|
|
5604
|
+
* If equal to -1, all the row children will be expanded.
|
|
5605
|
+
* @default 0
|
|
5606
|
+
*/
|
|
5607
|
+
defaultGroupingExpansionDepth: number;
|
|
5608
|
+
/**
|
|
5609
|
+
* Determines if a group should be expanded after its creation.
|
|
5610
|
+
* This prop takes priority over the `defaultGroupingExpansionDepth` prop.
|
|
5611
|
+
* @param {GridRowTreeNodeConfig} node The node of the group to test.
|
|
5612
|
+
* @returns {boolean} A boolean indicating if the group is expanded.
|
|
5613
|
+
*/
|
|
5614
|
+
isGroupExpandedByDefault?: (node: GridRowTreeNodeConfig) => boolean;
|
|
5615
|
+
/**
|
|
5616
|
+
* If `true`, the column pinning is disabled.
|
|
5617
|
+
* @default false
|
|
5618
|
+
*/
|
|
5619
|
+
disableColumnPinning: boolean;
|
|
5620
|
+
/**
|
|
5621
|
+
* If `true`, the filtering will only be applied to the top level rows.
|
|
5622
|
+
* @default false
|
|
5623
|
+
*/
|
|
5624
|
+
disableChildrenFiltering: boolean;
|
|
5625
|
+
/**
|
|
5626
|
+
* If `true`, the sorting will only be applied to the top level rows.
|
|
5627
|
+
* @default false
|
|
5628
|
+
*/
|
|
5629
|
+
disableChildrenSorting: boolean;
|
|
5630
|
+
}
|
|
5631
|
+
interface DataGridProPropsWithoutDefaultValue extends DataGridPropsWithoutDefaultValue {
|
|
5632
|
+
/**
|
|
5633
|
+
* Determines the path of a row in the tree data.
|
|
5634
|
+
* For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"].
|
|
5635
|
+
* Note that all paths must contain at least one element.
|
|
5636
|
+
* @param {GridRowModel} row The row from which we want the path.
|
|
5637
|
+
* @returns {string[]} The path to the row.
|
|
5638
|
+
*/
|
|
5639
|
+
getTreeDataPath?: (row: GridRowModel) => string[];
|
|
5640
|
+
/**
|
|
5641
|
+
* Callback fired while a column is being resized.
|
|
5642
|
+
* @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
|
|
5643
|
+
* @param {MuiEvent<React.MouseEvent>} event The event object.
|
|
5644
|
+
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5645
|
+
*/
|
|
5646
|
+
onColumnResize?: GridEventListener<GridEvents.columnResize>;
|
|
5647
|
+
/**
|
|
5648
|
+
* Callback fired when the width of a column is changed.
|
|
5649
|
+
* @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
|
|
5650
|
+
* @param {MuiEvent<React.MouseEvent>} event The event object.
|
|
5651
|
+
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5652
|
+
*/
|
|
5653
|
+
onColumnWidthChange?: GridEventListener<GridEvents.columnWidthChange>;
|
|
5654
|
+
/**
|
|
5655
|
+
* Callback fired when scrolling to the bottom of the grid viewport.
|
|
5656
|
+
* @param {GridRowScrollEndParams} params With all properties from [[GridRowScrollEndParams]].
|
|
5657
|
+
* @param {MuiEvent<{}>} event The event object.
|
|
5658
|
+
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5659
|
+
*/
|
|
5660
|
+
onRowsScrollEnd?: GridEventListener<GridEvents.rowsScrollEnd>;
|
|
5661
|
+
/**
|
|
5662
|
+
* The column fields to display pinned to left or right.
|
|
5663
|
+
*/
|
|
5664
|
+
pinnedColumns?: GridPinnedColumns;
|
|
5665
|
+
/**
|
|
5666
|
+
* Callback fired when the pinned columns have changed.
|
|
5667
|
+
* @param {GridPinnedColumns} pinnedColumns The changed pinned columns.
|
|
5668
|
+
* @param {GridCallbackDetails} details Additional details for this callback.
|
|
5669
|
+
*/
|
|
5670
|
+
onPinnedColumnsChange?: (pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void;
|
|
5671
|
+
/**
|
|
5672
|
+
* The grouping column used by the tree data.
|
|
5673
|
+
*/
|
|
5674
|
+
groupingColDef?: GridGroupingColDefOverride | ((params: GridGroupingColDefOverrideParams) => GridGroupingColDefOverride | undefined | null);
|
|
5675
|
+
}
|
|
5676
|
+
|
|
5677
|
+
declare const useGridRootProps: () => DataGridProcessedProps | DataGridProProcessedProps;
|
|
5678
|
+
|
|
5679
|
+
declare function useGridScrollFn(apiRef: GridApiRef, renderingZoneElementRef: React$1.RefObject<HTMLDivElement>, columnHeadersElementRef: React$1.RefObject<HTMLDivElement>): [GridScrollFn];
|
|
5680
|
+
|
|
5681
|
+
declare const useGridSelector: <T>(apiRef: GridApiRef, selector: (state: GridState) => T) => T;
|
|
5682
|
+
|
|
5683
|
+
/**
|
|
5684
|
+
* @deprecated Use `apiRef.current.state`, `apiRef.current.setState` and `apiRef.current.forceUpdate` instead.
|
|
5685
|
+
*/
|
|
5686
|
+
declare const useGridState: (apiRef: GridApiRef) => readonly [GridState, (state: GridState | ((previousState: GridState) => GridState)) => boolean, () => void];
|
|
5687
|
+
|
|
5688
|
+
declare const useGridNativeEventListener: <E extends Event>(apiRef: GridApiRef, ref: React$1.MutableRefObject<HTMLDivElement | null> | (() => Element | undefined | null), eventName: string, handler?: ((event: E) => any) | undefined, options?: AddEventListenerOptions | undefined) => void;
|
|
5609
5689
|
|
|
5610
5690
|
interface Localization {
|
|
5611
5691
|
components: {
|
|
5612
5692
|
MuiDataGrid: {
|
|
5613
|
-
defaultProps:
|
|
5693
|
+
defaultProps: {
|
|
5694
|
+
localeText: Partial<GridLocaleText>;
|
|
5695
|
+
};
|
|
5614
5696
|
};
|
|
5615
5697
|
};
|
|
5616
5698
|
}
|
|
@@ -5631,6 +5713,8 @@ declare const esES: Localization;
|
|
|
5631
5713
|
|
|
5632
5714
|
declare const faIR: Localization;
|
|
5633
5715
|
|
|
5716
|
+
declare const fiFI: Localization;
|
|
5717
|
+
|
|
5634
5718
|
declare const frFR: Localization;
|
|
5635
5719
|
|
|
5636
5720
|
declare const heIL: Localization;
|
|
@@ -5659,18 +5743,12 @@ declare const viVN: Localization;
|
|
|
5659
5743
|
|
|
5660
5744
|
declare const zhCN: Localization;
|
|
5661
5745
|
|
|
5662
|
-
declare const DataGrid: React$1.MemoExoticComponent<React$1.ForwardRefExoticComponent<Omit<
|
|
5746
|
+
declare const DataGrid: React$1.MemoExoticComponent<React$1.ForwardRefExoticComponent<Omit<Partial<DataGridPropsWithDefaultValues> & DataGridPropsWithComplexDefaultValueBeforeProcessing & DataGridPropsWithoutDefaultValue, DataGridForcedPropsKey> & {
|
|
5663
5747
|
pagination?: true | undefined;
|
|
5664
5748
|
} & React$1.RefAttributes<HTMLDivElement>>>;
|
|
5665
5749
|
|
|
5666
|
-
declare const
|
|
5667
|
-
/**
|
|
5668
|
-
* The grid component react props interface.
|
|
5669
|
-
*/
|
|
5670
|
-
declare type DataGridProps = Omit<GridInputComponentProps, 'apiRef' | 'checkboxSelectionVisibleOnly' | 'disableColumnResize' | 'disableColumnReorder' | 'disableMultipleColumnsFiltering' | 'disableMultipleColumnsSorting' | 'disableMultipleSelection' | 'disableChildrenFiltering' | 'disableChildrenSorting' | 'disableColumnPinning' | 'throttleRowsMs' | 'hideFooterRowCount' | 'options' | 'onRowsScrollEnd' | 'scrollEndThreshold' | 'pinnedColumns' | 'onPinnedColumnsChange' | 'treeData' | 'getTreeDataPath' | 'groupingColDef' | 'defaultGroupingExpansionDepth' | 'signature'> & {
|
|
5671
|
-
pagination?: true;
|
|
5672
|
-
};
|
|
5750
|
+
declare const useDataGridComponent: (apiRef: GridApiRef, props: DataGridProcessedProps) => void;
|
|
5673
5751
|
|
|
5674
|
-
declare const
|
|
5752
|
+
declare const MAX_PAGE_SIZE = 100;
|
|
5675
5753
|
|
|
5676
|
-
export { AutoSizerProps, AutoSizerSize, CursorCoordinates, DEFAULT_GRID_COL_TYPE_KEY, DataGrid, DataGridProps, ElementSize, GRID_ACTIONS_COL_DEF, GRID_BOOLEAN_COL_DEF, GRID_CHECKBOX_SELECTION_COL_DEF, GRID_DATETIME_COL_DEF, GRID_DATE_COL_DEF, GRID_DEFAULT_LOCALE_TEXT, GRID_EXPERIMENTAL_ENABLED, GRID_NUMERIC_COL_DEF, GRID_SINGLE_SELECT_COL_DEF, GRID_STRING_COL_DEF, GridActionsCell, GridActionsCellItem, GridActionsCellItemProps, GridActionsColDef, GridAddIcon, GridAlignment, GridApi, GridApiContext, GridApiRef, GridArrowDownwardIcon, GridArrowUpwardIcon, GridAutoSizer, GridBody, GridCallbackDetails, GridCell, GridCellCheckboxForwardRef, GridCellCheckboxRenderer, GridCellClassFn, GridCellClassNamePropType, GridCellEditCommitParams, GridCellEventLookup, GridCellIdentifier, GridCellIndexCoordinates, GridCellMode, GridCellModes, GridCellParams, GridCellProps, GridCellValue, GridCheckCircleIcon, GridCheckIcon, GridClassKey, GridClasses, GridClipboardApi, GridCloseIcon, GridColDef, GridColType, GridColTypeDef, GridColumnApi, GridColumnHeaderClassFn, GridColumnHeaderClassNamePropType, GridColumnHeaderEventLookup, GridColumnHeaderIndexCoordinates, GridColumnHeaderItem, GridColumnHeaderMenu, GridColumnHeaderMenuProps, GridColumnHeaderParams, GridColumnHeaderSeparator, GridColumnHeaderSeparatorProps, GridColumnHeaderSortIcon, GridColumnHeaderSortIconProps, GridColumnHeaderTitle, GridColumnHeaderTitleProps, GridColumnIcon, GridColumnIdentifier, GridColumnLookup, GridColumnMenu, GridColumnMenuApi, GridColumnMenuContainer, GridColumnMenuProps, GridColumnMenuState, GridColumnOrderChangeParams, GridColumnPinningApi, GridColumnPinningMenuItems, GridColumnReorderState, GridColumnResizeParams, GridColumnResizeState, GridColumnTypesRecord, GridColumnVisibilityChangeParams, GridColumns, GridColumnsMenuItem, GridColumnsMeta, GridColumnsPanel, GridColumnsState, GridCommitCellChangeParams, GridComparatorFn,
|
|
5754
|
+
export { AutoSizerProps, AutoSizerSize, CursorCoordinates, DEFAULT_GRID_COL_TYPE_KEY, DataGrid, DataGridProps, ElementSize, GRID_ACTIONS_COL_DEF, GRID_BOOLEAN_COL_DEF, GRID_CHECKBOX_SELECTION_COL_DEF, GRID_DATETIME_COL_DEF, GRID_DATE_COL_DEF, GRID_DEFAULT_LOCALE_TEXT, GRID_EXPERIMENTAL_ENABLED, GRID_NUMERIC_COL_DEF, GRID_SINGLE_SELECT_COL_DEF, GRID_STRING_COL_DEF, GRID_TREE_DATA_GROUPING_FIELD, GridActionsCell, GridActionsCellItem, GridActionsCellItemProps, GridActionsColDef, GridAddIcon, GridAlignment, GridApi, GridApiContext, GridApiRef, GridArrowDownwardIcon, GridArrowUpwardIcon, GridAutoSizer, GridBody, GridCallbackDetails, GridCell, GridCellCheckboxForwardRef, GridCellCheckboxRenderer, GridCellClassFn, GridCellClassNamePropType, GridCellEditCommitParams, GridCellEventLookup, GridCellIdentifier, GridCellIndexCoordinates, GridCellMode, GridCellModes, GridCellParams, GridCellProps, GridCellValue, GridCheckCircleIcon, GridCheckIcon, GridClassKey, GridClasses, GridClipboardApi, GridCloseIcon, GridColDef, GridColType, GridColTypeDef, GridColumnApi, GridColumnHeaderClassFn, GridColumnHeaderClassNamePropType, GridColumnHeaderEventLookup, GridColumnHeaderIndexCoordinates, GridColumnHeaderItem, GridColumnHeaderMenu, GridColumnHeaderMenuProps, GridColumnHeaderParams, GridColumnHeaderSeparator, GridColumnHeaderSeparatorProps, GridColumnHeaderSeparatorSides, GridColumnHeaderSortIcon, GridColumnHeaderSortIconProps, GridColumnHeaderTitle, GridColumnHeaderTitleProps, GridColumnIcon, GridColumnIdentifier, GridColumnLookup, GridColumnMenu, GridColumnMenuApi, GridColumnMenuContainer, GridColumnMenuProps, GridColumnMenuState, GridColumnOrderChangeParams, GridColumnPinningApi, GridColumnPinningMenuItems, GridColumnReorderState, GridColumnResizeParams, GridColumnResizeState, GridColumnTypesRecord, GridColumnVisibilityChangeParams, GridColumns, GridColumnsMenuItem, GridColumnsMeta, GridColumnsPanel, GridColumnsState, GridCommitCellChangeParams, GridComparatorFn, GridControlledStateEventLookup, GridCoreApi, GridCsvExportApi, GridCsvExportOptions, GridDensity, GridDensityApi, GridDensityOption, GridDensityState, GridDensityTypes, GridDimensions, GridDimensionsApi, GridDisableVirtualizationApi, GridDragIcon, GridEditCellProps, GridEditCellPropsParams, GridEditCellValueParams, GridEditInputCell, GridEditMode, GridEditModes, GridEditRowApi, GridEditRowProps, GridEditRowsModel, GridEditSingleSelectCell, GridEnrichedColDef, GridErrorHandler, GridEventListener, GridEventLookup, GridEventPublisher, GridEvents, GridEventsStr, GridExpandLessIcon, GridExpandMoreIcon, GridExportFormat, GridExportOptions, GridFeatureMode, GridFeatureModeConstant, GridFilterActiveItemsLookup, GridFilterAltIcon, GridFilterApi, GridFilterForm, GridFilterFormProps, GridFilterInitialState, GridFilterInputDate, GridFilterInputDateProps, GridFilterInputSingleSelect, GridFilterInputSingleSelectProps, GridFilterInputValue, GridFilterInputValueProps, GridFilterItem, GridFilterItemProps, GridFilterListIcon, GridFilterMenuItem, GridFilterModel, GridFilterOperator, GridFilterPanel, GridFilterState, GridFocusApi, GridFocusState, GridFooter, GridFooterContainer, GridFooterContainerProps, GridFooterPlaceholder, GridGroupingColDefOverride, GridGroupingColDefOverrideParams, GridHeader, GridHeaderCheckbox, GridHeaderPlaceholder, GridHeaderSelectionCheckboxParams, GridIconSlotsComponent, GridInitialState, GridInputSelectionModel, GridKeyValue, GridLinkOperator, GridLoadIcon, GridLoadingOverlay, GridLocaleText, GridLocaleTextApi, GridMenu, GridMenuIcon, GridMenuProps, GridMoreVertIcon, GridNativeColTypes, GridNoRowsOverlay, GridOverlay, GridOverlayProps, GridOverlays, GridPagination, GridPaginationApi, GridPaginationInitialState, GridPaginationState, GridPanel, GridPanelClasses, GridPanelContent, GridPanelFooter, GridPanelHeader, GridPanelProps, GridPanelWrapper, GridParamsApi, GridPinnedColumns, GridPinnedPosition, GridPreProcessEditCellProps, GridPreferencePanelInitialState, GridPreferencePanelState, GridPreferencePanelsValue, GridPreferencesPanel, GridPreferencesPanelApi, GridPrintExportApi, GridPrintExportOptions, GridRenderCellParams, GridRenderColumnsProps, GridRenderContext, GridRenderContextProps, GridRenderEditCellParams, GridRenderPaginationProps, GridRenderRowProps, GridRoot, GridRootContainerRef, GridRootProps, GridRow, GridRowApi, GridRowCount, GridRowData, GridRowEntry, GridRowEventLookup, GridRowId, GridRowIdGetter, GridRowMode, GridRowModel, GridRowModelUpdate, GridRowModes, GridRowParams, GridRowProps, GridRowScrollEndParams, GridRowSelectionCheckboxParams, GridRowTreeConfig, GridRowTreeNodeConfig, GridRowsLookup, GridRowsProp, GridRowsState, GridSaveAltIcon, GridScrollApi, GridScrollArea, GridScrollFn, GridScrollParams, GridSearchIcon, GridSelectedRowCount, GridSelectionApi, GridSelectionModel, GridSeparatorIcon, GridSignature, GridSlotsComponent, GridSlotsComponentsProps, GridSortApi, GridSortCellParams, GridSortColumnLookup, GridSortDirection, GridSortItem, GridSortModel, GridSortModelParams, GridSortingInitialState, GridSortingState, GridState, GridStateApi, GridStateChangeParams, GridStateColDef, GridTabIndexState, GridTableRowsIcon, GridToolbar, GridToolbarColumnsButton, GridToolbarContainer, GridToolbarContainerProps, GridToolbarDensitySelector, GridToolbarExport, GridToolbarExportProps, GridToolbarFilterButton, GridToolbarFilterButtonProps, GridTranslationKeys, GridTreeDataGroupingCell, GridTripleDotsVerticalIcon, GridTypeFilterInputValueProps, GridUpdateAction, GridValueFormatterParams, GridValueGetterFullParams, GridValueGetterParams, GridValueGetterSimpleParams, GridValueOptionsParams, GridValueSetterParams, GridViewHeadlineIcon, GridViewStreamIcon, HideGridColMenuItem, Logger, MAX_PAGE_SIZE, MuiBaseEvent, MuiEvent, SUBMIT_FILTER_DATE_STROKE_TIME, SUBMIT_FILTER_STROKE_TIME, SortGridMenuItems, allGridColumnsFieldsSelector, allGridColumnsSelector, arSD, bgBG, checkGridRowIdIsValid, createUseGridApiEventHandler, csCZ, deDE, elGR, enUS, esES, faIR, fiFI, filterableGridColumnsIdsSelector, filterableGridColumnsSelector, frFR, getDataGridUtilityClass, getDefaultGridFilterModel, getGridBooleanOperators, getGridColDef, getGridDateOperators, getGridDefaultColumnTypes, getGridNumericColumnOperators, getGridSingleSelectOperators, getGridStringOperators, gridClasses, gridColumnLookupSelector, gridColumnMenuSelector, gridColumnReorderDragColSelector, gridColumnReorderSelector, gridColumnResizeSelector, gridColumnsMetaSelector, gridColumnsSelector, gridColumnsTotalWidthSelector, gridDateFormatter, gridDateTimeFormatter, gridDensityHeaderHeightSelector, gridDensityRowHeightSelector, gridDensitySelector, gridDensityValueSelector, gridEditRowsStateSelector, gridFilterActiveItemsLookupSelector, gridFilterActiveItemsSelector, gridFilterModelSelector, gridFilterStateSelector, gridFilteredDescendantCountLookupSelector, gridFocusCellSelector, gridFocusColumnHeaderSelector, gridFocusStateSelector, gridPageCountSelector, gridPageSelector, gridPageSizeSelector, gridPaginatedVisibleSortedGridRowEntriesSelector, gridPaginatedVisibleSortedGridRowIdsSelector, gridPaginationRowRangeSelector, gridPaginationSelector, gridPanelClasses, gridPreferencePanelStateSelector, gridResizingColumnFieldSelector, gridRowCountSelector, gridRowGroupingNameSelector, gridRowIdsSelector, gridRowTreeDepthSelector, gridRowTreeSelector, gridRowsLookupSelector, gridRowsStateSelector, gridSelectionStateSelector, gridSortColumnLookupSelector, gridSortModelSelector, gridSortedRowEntriesSelector, gridSortedRowIdsSelector, gridTabIndexCellSelector, gridTabIndexColumnHeaderSelector, gridTabIndexStateSelector, gridTopLevelRowCountSelector, gridVisibleColumnFieldsSelector, gridVisibleRowCountSelector, gridVisibleRowsLookupSelector, gridVisibleRowsSelector, gridVisibleSortedRowEntriesSelector, gridVisibleSortedRowIdsSelector, gridVisibleSortedTopLevelRowEntriesSelector, gridVisibleTopLevelRowCountSelector, heIL, itIT, jaJP, koKR, nlNL, plPL, ptBR, renderActionsCell, renderEditInputCell, renderEditSingleSelectCell, ruRU, selectedGridRowsCountSelector, selectedGridRowsSelector, selectedIdsLookupSelector, skSK, trTR, ukUA, useDataGridComponent, useGridApi, useGridApiContext, useGridApiEventHandler, useGridApiMethod, useGridApiOptionHandler, useGridApiRef, useGridLogger, useGridNativeEventListener, useGridRootProps, useGridScrollFn, useGridSelector, useGridState, viVN, visibleGridColumnsLengthSelector, visibleGridColumnsSelector, zhCN };
|