@mui/x-data-grid-premium 8.0.0-alpha.9 → 8.0.0-beta.0
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 +1446 -0
- package/DataGridPremium/DataGrid.d.ts +1 -1
- package/DataGridPremium/DataGridPremium.d.ts +6 -6
- package/DataGridPremium/DataGridPremium.js +61 -35
- package/DataGridPremium/index.d.ts +3 -3
- package/DataGridPremium/useDataGridPremiumComponent.d.ts +3 -3
- package/DataGridPremium/useDataGridPremiumComponent.js +5 -4
- package/DataGridPremium/useDataGridPremiumProps.d.ts +2 -2
- package/DataGridPremium/useDataGridPremiumProps.js +2 -2
- package/README.md +1 -1
- package/components/GridAggregationHeader.d.ts +3 -3
- package/components/GridAggregationHeader.js +13 -12
- package/components/GridAggregationRowOverlay.d.ts +3 -0
- package/components/GridAggregationRowOverlay.js +44 -0
- package/components/GridBottomContainer.d.ts +3 -0
- package/components/GridBottomContainer.js +51 -0
- package/components/GridColumnMenuAggregationItem.d.ts +2 -2
- package/components/GridColumnMenuAggregationItem.js +36 -46
- package/components/GridColumnMenuRowGroupItem.d.ts +1 -1
- package/components/GridColumnMenuRowUngroupItem.d.ts +1 -1
- package/components/GridDataSourceGroupingCriteriaCell.d.ts +2 -2
- package/components/GridDataSourceGroupingCriteriaCell.js +8 -12
- package/components/GridExcelExportMenuItem.d.ts +3 -3
- package/components/GridFooterCell.d.ts +2 -2
- package/components/GridFooterCell.js +5 -6
- package/components/GridGroupingColumnFooterCell.d.ts +1 -1
- package/components/GridGroupingColumnFooterCell.js +2 -1
- package/components/GridGroupingColumnLeafCell.d.ts +1 -1
- package/components/GridGroupingColumnLeafCell.js +3 -9
- package/components/GridGroupingCriteriaCell.d.ts +2 -2
- package/components/GridGroupingCriteriaCell.js +3 -8
- package/components/GridPremiumColumnMenu.d.ts +26 -26
- package/components/GridPremiumToolbar.d.ts +3 -0
- package/components/GridPremiumToolbar.js +31 -0
- package/components/export/ExportExcel.d.ts +29 -0
- package/components/export/ExportExcel.js +216 -0
- package/components/export/index.d.ts +1 -0
- package/components/export/index.js +16 -0
- package/components/index.d.ts +6 -5
- package/components/index.js +13 -1
- package/components/promptControl/GridToolbarPromptControl.d.ts +22 -22
- package/components/promptControl/GridToolbarPromptControl.js +33 -20
- package/components/promptControl/RecordButton.d.ts +9 -9
- package/components/promptControl/index.d.ts +1 -1
- package/components/reexports.d.ts +1 -1
- package/constants/dataGridPremiumDefaultSlotsComponents.d.ts +1 -1
- package/constants/dataGridPremiumDefaultSlotsComponents.js +5 -1
- package/esm/DataGridPremium/DataGrid.d.ts +8 -0
- package/esm/DataGridPremium/DataGridPremium.d.ts +16 -0
- package/esm/DataGridPremium/DataGridPremium.js +61 -35
- package/esm/DataGridPremium/index.d.ts +3 -0
- package/esm/DataGridPremium/useDataGridPremiumComponent.d.ts +4 -0
- package/esm/DataGridPremium/useDataGridPremiumComponent.js +6 -5
- package/esm/DataGridPremium/useDataGridPremiumProps.d.ts +6 -0
- package/esm/DataGridPremium/useDataGridPremiumProps.js +2 -2
- package/esm/components/GridAggregationHeader.d.ts +7 -0
- package/esm/components/GridAggregationHeader.js +13 -12
- package/esm/components/GridAggregationRowOverlay.d.ts +3 -0
- package/esm/components/GridAggregationRowOverlay.js +37 -0
- package/esm/components/GridBottomContainer.d.ts +3 -0
- package/esm/components/GridBottomContainer.js +43 -0
- package/esm/components/GridColumnMenuAggregationItem.d.ts +7 -0
- package/esm/components/GridColumnMenuAggregationItem.js +36 -46
- package/esm/components/GridColumnMenuRowGroupItem.d.ts +3 -0
- package/esm/components/GridColumnMenuRowUngroupItem.d.ts +3 -0
- package/esm/components/GridDataSourceGroupingCriteriaCell.d.ts +7 -0
- package/esm/components/GridDataSourceGroupingCriteriaCell.js +9 -13
- package/esm/components/GridExcelExportMenuItem.d.ts +9 -0
- package/esm/components/GridFooterCell.d.ts +9 -0
- package/esm/components/GridFooterCell.js +5 -6
- package/esm/components/GridGroupingColumnFooterCell.d.ts +4 -0
- package/esm/components/GridGroupingColumnFooterCell.js +2 -1
- package/esm/components/GridGroupingColumnLeafCell.d.ts +4 -0
- package/esm/components/GridGroupingColumnLeafCell.js +3 -8
- package/esm/components/GridGroupingCriteriaCell.d.ts +7 -0
- package/esm/components/GridGroupingCriteriaCell.js +3 -8
- package/esm/components/GridPremiumColumnMenu.d.ts +33 -0
- package/esm/components/GridPremiumToolbar.d.ts +3 -0
- package/esm/components/GridPremiumToolbar.js +23 -0
- package/esm/components/export/ExportExcel.d.ts +29 -0
- package/esm/components/export/ExportExcel.js +209 -0
- package/esm/components/export/index.d.ts +1 -0
- package/esm/components/export/index.js +1 -0
- package/esm/components/index.d.ts +6 -0
- package/esm/components/index.js +2 -1
- package/esm/components/promptControl/GridToolbarPromptControl.d.ts +26 -0
- package/esm/components/promptControl/GridToolbarPromptControl.js +33 -20
- package/esm/components/promptControl/RecordButton.d.ts +16 -0
- package/esm/components/promptControl/index.d.ts +1 -0
- package/esm/components/reexports.d.ts +1 -0
- package/esm/constants/dataGridPremiumDefaultSlotsComponents.d.ts +2 -0
- package/esm/constants/dataGridPremiumDefaultSlotsComponents.js +5 -1
- package/esm/hooks/features/aggregation/createAggregationLookup.d.ts +17 -0
- package/esm/hooks/features/aggregation/createAggregationLookup.js +3 -3
- package/esm/hooks/features/aggregation/gridAggregationFunctions.d.ts +8 -0
- package/esm/hooks/features/aggregation/gridAggregationInterfaces.d.ts +129 -0
- package/esm/hooks/features/aggregation/gridAggregationSelectors.d.ts +13 -0
- package/esm/hooks/features/aggregation/gridAggregationSelectors.js +2 -2
- package/esm/hooks/features/aggregation/gridAggregationUtils.d.ts +62 -0
- package/esm/hooks/features/aggregation/gridAggregationUtils.js +1 -1
- package/esm/hooks/features/aggregation/index.d.ts +4 -0
- package/esm/hooks/features/aggregation/useGridAggregation.d.ts +6 -0
- package/esm/hooks/features/aggregation/useGridAggregation.js +6 -8
- package/esm/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +4 -0
- package/esm/hooks/features/aggregation/useGridAggregationPreProcessors.js +7 -6
- package/esm/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +81 -0
- package/esm/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
- package/esm/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +40 -0
- package/esm/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -0
- package/esm/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -1
- package/esm/hooks/features/cellSelection/index.d.ts +1 -0
- package/esm/hooks/features/cellSelection/useGridCellSelection.d.ts +6 -0
- package/esm/hooks/features/cellSelection/useGridCellSelection.js +15 -13
- package/esm/hooks/features/clipboard/useGridClipboardImport.d.ts +4 -0
- package/esm/hooks/features/clipboard/useGridClipboardImport.js +5 -5
- package/esm/hooks/features/dataSource/models.d.ts +54 -0
- package/esm/hooks/features/dataSource/useGridDataSourcePremium.d.ts +4 -0
- package/esm/hooks/features/dataSource/useGridDataSourcePremium.js +13 -7
- package/esm/hooks/features/export/gridExcelExportInterface.d.ts +71 -0
- package/esm/hooks/features/export/index.d.ts +2 -0
- package/esm/hooks/features/export/index.js +1 -1
- package/esm/hooks/features/export/serializer/excelSerializer.d.ts +40 -0
- package/esm/hooks/features/export/serializer/excelSerializer.js +69 -180
- package/esm/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
- package/esm/hooks/features/export/serializer/setupExcelExportWebWorker.js +53 -0
- package/esm/hooks/features/export/serializer/utils.d.ts +36 -0
- package/esm/hooks/features/export/serializer/utils.js +93 -0
- package/esm/hooks/features/export/useGridExcelExport.d.ts +11 -0
- package/esm/hooks/features/export/useGridExcelExport.js +11 -5
- package/esm/hooks/features/index.d.ts +5 -0
- package/esm/hooks/features/promptControl/api.d.ts +2 -0
- package/esm/hooks/features/promptControl/index.d.ts +2 -0
- package/esm/hooks/features/promptControl/types.d.ts +25 -0
- package/esm/hooks/features/rowGrouping/createGroupingColDef.d.ts +57 -0
- package/esm/hooks/features/rowGrouping/createGroupingColDef.js +5 -5
- package/esm/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +44 -0
- package/esm/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +3 -0
- package/esm/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
- package/esm/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +54 -0
- package/esm/hooks/features/rowGrouping/gridRowGroupingUtils.js +5 -3
- package/esm/hooks/features/rowGrouping/index.d.ts +3 -0
- package/esm/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +4 -0
- package/esm/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.js +3 -3
- package/esm/hooks/features/rowGrouping/useGridRowGrouping.d.ts +11 -0
- package/esm/hooks/features/rowGrouping/useGridRowGrouping.js +4 -5
- package/esm/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +4 -0
- package/esm/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.js +5 -5
- package/esm/hooks/features/rows/index.d.ts +1 -0
- package/esm/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -0
- package/esm/hooks/index.d.ts +2 -0
- package/esm/hooks/utils/index.d.ts +1 -0
- package/esm/hooks/utils/useGridApiContext.d.ts +4 -0
- package/esm/hooks/utils/useGridApiRef.d.ts +4 -0
- package/esm/hooks/utils/useGridAriaAttributes.d.ts +2 -0
- package/esm/hooks/utils/useGridPrivateApiContext.d.ts +2 -0
- package/esm/hooks/utils/useGridRootProps.d.ts +2 -0
- package/esm/hooks/utils/useKeepGroupedColumnsHidden.d.ts +12 -0
- package/esm/hooks/utils/useKeepGroupedColumnsHidden.js +2 -2
- package/esm/index.d.ts +23 -0
- package/esm/index.js +6 -5
- package/esm/locales.d.ts +1 -0
- package/esm/material/icons.d.ts +15 -0
- package/esm/material/index.d.ts +8 -0
- package/esm/models/dataGridPremiumProps.d.ts +162 -0
- package/esm/models/gridApiPremium.d.ts +14 -0
- package/esm/models/gridGroupingValueGetter.d.ts +4 -0
- package/esm/models/gridPastedValueParser.d.ts +4 -0
- package/esm/models/gridPremiumIconSlotsComponent.d.ts +28 -0
- package/esm/models/gridPremiumSlotsComponent.d.ts +7 -0
- package/esm/models/gridStatePremium.d.ts +18 -0
- package/esm/models/index.d.ts +4 -0
- package/esm/package.json +1 -0
- package/esm/setupExcelExportWebWorker.d.ts +1 -0
- package/esm/setupExcelExportWebWorker.js +1 -0
- package/esm/themeAugmentation/index.d.ts +2 -0
- package/esm/themeAugmentation/overrides.d.ts +7 -0
- package/esm/themeAugmentation/props.d.ts +15 -0
- package/esm/typeOverloads/index.d.ts +2 -0
- package/esm/typeOverloads/modules.d.ts +97 -0
- package/esm/typeOverloads/reexports.d.ts +17 -0
- package/esm/utils/releaseInfo.d.ts +1 -0
- package/esm/utils/releaseInfo.js +1 -1
- package/hooks/features/aggregation/createAggregationLookup.d.ts +16 -10
- package/hooks/features/aggregation/createAggregationLookup.js +2 -2
- package/hooks/features/aggregation/gridAggregationFunctions.d.ts +7 -7
- package/hooks/features/aggregation/gridAggregationInterfaces.d.ts +81 -82
- package/hooks/features/aggregation/gridAggregationSelectors.d.ts +3 -3
- package/hooks/features/aggregation/gridAggregationSelectors.js +1 -2
- package/hooks/features/aggregation/gridAggregationUtils.d.ts +42 -25
- package/hooks/features/aggregation/gridAggregationUtils.js +1 -1
- package/hooks/features/aggregation/index.d.ts +4 -4
- package/hooks/features/aggregation/useGridAggregation.d.ts +3 -3
- package/hooks/features/aggregation/useGridAggregation.js +6 -8
- package/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +3 -3
- package/hooks/features/aggregation/useGridAggregationPreProcessors.js +7 -6
- package/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +67 -62
- package/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
- package/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +34 -34
- package/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -2
- package/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -2
- package/hooks/features/cellSelection/index.d.ts +1 -1
- package/hooks/features/cellSelection/useGridCellSelection.d.ts +3 -3
- package/hooks/features/cellSelection/useGridCellSelection.js +13 -11
- package/hooks/features/clipboard/useGridClipboardImport.d.ts +2 -2
- package/hooks/features/clipboard/useGridClipboardImport.js +4 -4
- package/hooks/features/dataSource/models.d.ts +41 -34
- package/hooks/features/dataSource/useGridDataSourcePremium.d.ts +3 -3
- package/hooks/features/dataSource/useGridDataSourcePremium.js +13 -7
- package/hooks/features/export/gridExcelExportInterface.d.ts +52 -52
- package/hooks/features/export/index.d.ts +2 -2
- package/hooks/features/export/index.js +2 -2
- package/hooks/features/export/serializer/excelSerializer.d.ts +23 -51
- package/hooks/features/export/serializer/excelSerializer.js +74 -187
- package/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
- package/hooks/features/export/serializer/setupExcelExportWebWorker.js +59 -0
- package/hooks/features/export/serializer/utils.d.ts +36 -0
- package/hooks/features/export/serializer/utils.js +106 -0
- package/hooks/features/export/useGridExcelExport.d.ts +3 -3
- package/hooks/features/export/useGridExcelExport.js +10 -3
- package/hooks/features/index.d.ts +5 -5
- package/hooks/features/promptControl/api.d.ts +2 -2
- package/hooks/features/promptControl/index.d.ts +2 -2
- package/hooks/features/promptControl/types.d.ts +15 -15
- package/hooks/features/rowGrouping/createGroupingColDef.d.ts +44 -32
- package/hooks/features/rowGrouping/createGroupingColDef.js +4 -4
- package/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +32 -32
- package/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +2 -2
- package/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
- package/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +30 -22
- package/hooks/features/rowGrouping/gridRowGroupingUtils.js +4 -2
- package/hooks/features/rowGrouping/index.d.ts +3 -3
- package/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +3 -3
- package/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.js +3 -3
- package/hooks/features/rowGrouping/useGridRowGrouping.d.ts +3 -3
- package/hooks/features/rowGrouping/useGridRowGrouping.js +4 -5
- package/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +3 -3
- package/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.js +5 -5
- package/hooks/features/rows/index.d.ts +1 -1
- package/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -1
- package/hooks/index.d.ts +2 -2
- package/hooks/utils/index.d.ts +1 -1
- package/hooks/utils/useGridApiContext.d.ts +4 -2
- package/hooks/utils/useGridApiRef.d.ts +4 -2
- package/hooks/utils/useGridAriaAttributes.d.ts +1 -1
- package/hooks/utils/useGridPrivateApiContext.d.ts +2 -2
- package/hooks/utils/useGridRootProps.d.ts +2 -2
- package/hooks/utils/useKeepGroupedColumnsHidden.d.ts +4 -4
- package/hooks/utils/useKeepGroupedColumnsHidden.js +2 -2
- package/index.d.ts +9 -17
- package/index.js +2 -11
- package/locales.d.ts +1 -1
- package/material/icons.d.ts +6 -6
- package/material/index.d.ts +6 -6
- package/models/dataGridPremiumProps.d.ts +140 -135
- package/models/gridApiPremium.d.ts +4 -6
- package/models/gridGroupingValueGetter.d.ts +2 -2
- package/models/gridPastedValueParser.d.ts +2 -2
- package/models/gridPremiumIconSlotsComponent.d.ts +26 -26
- package/models/gridPremiumSlotsComponent.d.ts +2 -3
- package/models/gridStatePremium.d.ts +7 -7
- package/models/index.d.ts +4 -4
- package/modern/DataGridPremium/DataGrid.d.ts +8 -0
- package/modern/DataGridPremium/DataGridPremium.d.ts +16 -0
- package/modern/DataGridPremium/DataGridPremium.js +61 -35
- package/modern/DataGridPremium/index.d.ts +3 -0
- package/modern/DataGridPremium/useDataGridPremiumComponent.d.ts +4 -0
- package/modern/DataGridPremium/useDataGridPremiumComponent.js +6 -5
- package/modern/DataGridPremium/useDataGridPremiumProps.d.ts +6 -0
- package/modern/DataGridPremium/useDataGridPremiumProps.js +2 -2
- package/modern/components/GridAggregationHeader.d.ts +7 -0
- package/modern/components/GridAggregationHeader.js +13 -12
- package/modern/components/GridAggregationRowOverlay.d.ts +3 -0
- package/modern/components/GridAggregationRowOverlay.js +37 -0
- package/modern/components/GridBottomContainer.d.ts +3 -0
- package/modern/components/GridBottomContainer.js +43 -0
- package/modern/components/GridColumnMenuAggregationItem.d.ts +7 -0
- package/modern/components/GridColumnMenuAggregationItem.js +36 -46
- package/modern/components/GridColumnMenuRowGroupItem.d.ts +3 -0
- package/modern/components/GridColumnMenuRowUngroupItem.d.ts +3 -0
- package/modern/components/GridDataSourceGroupingCriteriaCell.d.ts +7 -0
- package/modern/components/GridDataSourceGroupingCriteriaCell.js +9 -13
- package/modern/components/GridExcelExportMenuItem.d.ts +9 -0
- package/modern/components/GridFooterCell.d.ts +9 -0
- package/modern/components/GridFooterCell.js +5 -6
- package/modern/components/GridGroupingColumnFooterCell.d.ts +4 -0
- package/modern/components/GridGroupingColumnFooterCell.js +2 -1
- package/modern/components/GridGroupingColumnLeafCell.d.ts +4 -0
- package/modern/components/GridGroupingColumnLeafCell.js +3 -8
- package/modern/components/GridGroupingCriteriaCell.d.ts +7 -0
- package/modern/components/GridGroupingCriteriaCell.js +3 -8
- package/modern/components/GridPremiumColumnMenu.d.ts +33 -0
- package/modern/components/GridPremiumToolbar.d.ts +3 -0
- package/modern/components/GridPremiumToolbar.js +23 -0
- package/modern/components/export/ExportExcel.d.ts +29 -0
- package/modern/components/export/ExportExcel.js +209 -0
- package/modern/components/export/index.d.ts +1 -0
- package/modern/components/export/index.js +1 -0
- package/modern/components/index.d.ts +6 -0
- package/modern/components/index.js +2 -1
- package/modern/components/promptControl/GridToolbarPromptControl.d.ts +26 -0
- package/modern/components/promptControl/GridToolbarPromptControl.js +33 -20
- package/modern/components/promptControl/RecordButton.d.ts +16 -0
- package/modern/components/promptControl/index.d.ts +1 -0
- package/modern/components/reexports.d.ts +1 -0
- package/modern/constants/dataGridPremiumDefaultSlotsComponents.d.ts +2 -0
- package/modern/constants/dataGridPremiumDefaultSlotsComponents.js +5 -1
- package/modern/hooks/features/aggregation/createAggregationLookup.d.ts +17 -0
- package/modern/hooks/features/aggregation/createAggregationLookup.js +3 -3
- package/modern/hooks/features/aggregation/gridAggregationFunctions.d.ts +8 -0
- package/modern/hooks/features/aggregation/gridAggregationInterfaces.d.ts +129 -0
- package/modern/hooks/features/aggregation/gridAggregationSelectors.d.ts +13 -0
- package/modern/hooks/features/aggregation/gridAggregationSelectors.js +2 -2
- package/modern/hooks/features/aggregation/gridAggregationUtils.d.ts +62 -0
- package/modern/hooks/features/aggregation/gridAggregationUtils.js +1 -1
- package/modern/hooks/features/aggregation/index.d.ts +4 -0
- package/modern/hooks/features/aggregation/useGridAggregation.d.ts +6 -0
- package/modern/hooks/features/aggregation/useGridAggregation.js +6 -8
- package/modern/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +4 -0
- package/modern/hooks/features/aggregation/useGridAggregationPreProcessors.js +7 -6
- package/modern/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +81 -0
- package/modern/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
- package/modern/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +40 -0
- package/modern/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -0
- package/modern/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -1
- package/modern/hooks/features/cellSelection/index.d.ts +1 -0
- package/modern/hooks/features/cellSelection/useGridCellSelection.d.ts +6 -0
- package/modern/hooks/features/cellSelection/useGridCellSelection.js +15 -13
- package/modern/hooks/features/clipboard/useGridClipboardImport.d.ts +4 -0
- package/modern/hooks/features/clipboard/useGridClipboardImport.js +5 -5
- package/modern/hooks/features/dataSource/models.d.ts +54 -0
- package/modern/hooks/features/dataSource/useGridDataSourcePremium.d.ts +4 -0
- package/modern/hooks/features/dataSource/useGridDataSourcePremium.js +13 -7
- package/modern/hooks/features/export/gridExcelExportInterface.d.ts +71 -0
- package/modern/hooks/features/export/index.d.ts +2 -0
- package/modern/hooks/features/export/index.js +1 -1
- package/modern/hooks/features/export/serializer/excelSerializer.d.ts +40 -0
- package/modern/hooks/features/export/serializer/excelSerializer.js +69 -180
- package/modern/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
- package/modern/hooks/features/export/serializer/setupExcelExportWebWorker.js +53 -0
- package/modern/hooks/features/export/serializer/utils.d.ts +36 -0
- package/modern/hooks/features/export/serializer/utils.js +93 -0
- package/modern/hooks/features/export/useGridExcelExport.d.ts +11 -0
- package/modern/hooks/features/export/useGridExcelExport.js +11 -5
- package/modern/hooks/features/index.d.ts +5 -0
- package/modern/hooks/features/promptControl/api.d.ts +2 -0
- package/modern/hooks/features/promptControl/index.d.ts +2 -0
- package/modern/hooks/features/promptControl/types.d.ts +25 -0
- package/modern/hooks/features/rowGrouping/createGroupingColDef.d.ts +57 -0
- package/modern/hooks/features/rowGrouping/createGroupingColDef.js +5 -5
- package/modern/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +44 -0
- package/modern/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +3 -0
- package/modern/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
- package/modern/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +54 -0
- package/modern/hooks/features/rowGrouping/gridRowGroupingUtils.js +5 -3
- package/modern/hooks/features/rowGrouping/index.d.ts +3 -0
- package/modern/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +4 -0
- package/modern/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.js +3 -3
- package/modern/hooks/features/rowGrouping/useGridRowGrouping.d.ts +11 -0
- package/modern/hooks/features/rowGrouping/useGridRowGrouping.js +4 -5
- package/modern/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +4 -0
- package/modern/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.js +5 -5
- package/modern/hooks/features/rows/index.d.ts +1 -0
- package/modern/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -0
- package/modern/hooks/index.d.ts +2 -0
- package/modern/hooks/utils/index.d.ts +1 -0
- package/modern/hooks/utils/useGridApiContext.d.ts +4 -0
- package/modern/hooks/utils/useGridApiRef.d.ts +4 -0
- package/modern/hooks/utils/useGridAriaAttributes.d.ts +2 -0
- package/modern/hooks/utils/useGridPrivateApiContext.d.ts +2 -0
- package/modern/hooks/utils/useGridRootProps.d.ts +2 -0
- package/modern/hooks/utils/useKeepGroupedColumnsHidden.d.ts +12 -0
- package/modern/hooks/utils/useKeepGroupedColumnsHidden.js +2 -2
- package/modern/index.d.ts +23 -0
- package/modern/index.js +1 -7
- package/modern/locales.d.ts +1 -0
- package/modern/material/icons.d.ts +15 -0
- package/modern/material/index.d.ts +8 -0
- package/modern/models/dataGridPremiumProps.d.ts +162 -0
- package/modern/models/gridApiPremium.d.ts +14 -0
- package/modern/models/gridGroupingValueGetter.d.ts +4 -0
- package/modern/models/gridPastedValueParser.d.ts +4 -0
- package/modern/models/gridPremiumIconSlotsComponent.d.ts +28 -0
- package/modern/models/gridPremiumSlotsComponent.d.ts +7 -0
- package/modern/models/gridStatePremium.d.ts +18 -0
- package/modern/models/index.d.ts +4 -0
- package/modern/package.json +1 -0
- package/modern/setupExcelExportWebWorker.d.ts +1 -0
- package/modern/setupExcelExportWebWorker.js +1 -0
- package/modern/themeAugmentation/index.d.ts +2 -0
- package/modern/themeAugmentation/overrides.d.ts +7 -0
- package/modern/themeAugmentation/props.d.ts +15 -0
- package/modern/typeOverloads/index.d.ts +2 -0
- package/modern/typeOverloads/modules.d.ts +97 -0
- package/modern/typeOverloads/reexports.d.ts +17 -0
- package/modern/utils/releaseInfo.d.ts +1 -0
- package/modern/utils/releaseInfo.js +1 -1
- package/package.json +42 -9
- package/setupExcelExportWebWorker.d.ts +1 -0
- package/setupExcelExportWebWorker.js +12 -0
- package/themeAugmentation/index.d.ts +2 -2
- package/themeAugmentation/overrides.d.ts +3 -4
- package/themeAugmentation/props.d.ts +9 -11
- package/tsconfig.build.tsbuildinfo +1 -0
- package/typeOverloads/index.d.ts +1 -1
- package/typeOverloads/modules.d.ts +75 -82
- package/typeOverloads/reexports.d.ts +5 -5
- package/utils/releaseInfo.d.ts +1 -1
- package/utils/releaseInfo.js +1 -1
- package/DataGridPremium/package.json +0 -6
- package/components/package.json +0 -6
- package/esm/hooks/features/dataSource/cache.js +0 -3
- package/hooks/features/dataSource/cache.d.ts +0 -2
- package/hooks/features/dataSource/cache.js +0 -9
- package/hooks/package.json +0 -6
- package/material/package.json +0 -6
- package/models/package.json +0 -6
- package/modern/hooks/features/dataSource/cache.js +0 -3
- package/themeAugmentation/package.json +0 -6
- package/typeOverloads/package.json +0 -6
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { PromptResponse } from "../../hooks/features/promptControl/types.js";
|
|
3
|
+
type GridToolbarPromptControlProps = {
|
|
4
|
+
/**
|
|
5
|
+
* Called when the new prompt is ready to be processed.
|
|
6
|
+
* Provides the prompt and the data context and expects the grid state updates to be returned.
|
|
7
|
+
* @param {string} context The context of the prompt
|
|
8
|
+
* @param {string} query The query to process
|
|
9
|
+
* @returns {Promise<PromptResponse>} The grid state updates
|
|
10
|
+
*/
|
|
11
|
+
onPrompt: (context: string, query: string) => Promise<PromptResponse>;
|
|
12
|
+
/**
|
|
13
|
+
* Allow taking couple of random cell values from each column to improve the prompt context.
|
|
14
|
+
* If allowed, samples are taken from different rows.
|
|
15
|
+
* If not allowed, the column examples are used.
|
|
16
|
+
* @default false
|
|
17
|
+
*/
|
|
18
|
+
allowDataSampling?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* The BCP 47 language tag to use for the speech recognition.
|
|
21
|
+
* @default HTML lang attribute value or the user agent's language setting
|
|
22
|
+
*/
|
|
23
|
+
lang?: string;
|
|
24
|
+
};
|
|
25
|
+
declare function GridToolbarPromptControl(props: GridToolbarPromptControlProps): React.JSX.Element;
|
|
26
|
+
export { GridToolbarPromptControl };
|
|
@@ -10,9 +10,10 @@ import { useGridRootProps } from "../../hooks/utils/useGridRootProps.js";
|
|
|
10
10
|
import { RecordButton, BrowserSpeechRecognition } from "./RecordButton.js";
|
|
11
11
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
12
12
|
const supportsSpeechRecognition = !!BrowserSpeechRecognition;
|
|
13
|
-
const useUtilityClasses =
|
|
13
|
+
const useUtilityClasses = ownerState => {
|
|
14
14
|
const {
|
|
15
|
-
classes
|
|
15
|
+
classes,
|
|
16
|
+
recording
|
|
16
17
|
} = ownerState;
|
|
17
18
|
const slots = {
|
|
18
19
|
root: ['toolbarPromptControl', recording && 'toolbarPromptControl--recording'],
|
|
@@ -25,7 +26,12 @@ const useUtilityClasses = (ownerState, recording) => {
|
|
|
25
26
|
const GridToolbarPromptControlRoot = styled('div', {
|
|
26
27
|
name: 'MuiDataGrid',
|
|
27
28
|
slot: 'ToolbarPromptControl',
|
|
28
|
-
overridesResolver: (
|
|
29
|
+
overridesResolver: (props, styles) => {
|
|
30
|
+
const {
|
|
31
|
+
ownerState
|
|
32
|
+
} = props;
|
|
33
|
+
return [styles.toolbarPromptControl, ownerState.recording && styles['toolbarPromptControl--recording']];
|
|
34
|
+
}
|
|
29
35
|
})({
|
|
30
36
|
flex: 1,
|
|
31
37
|
display: 'flex',
|
|
@@ -71,7 +77,11 @@ function GridToolbarPromptControl(props) {
|
|
|
71
77
|
const [error, setError] = React.useState(null);
|
|
72
78
|
const [isRecording, setRecording] = React.useState(false);
|
|
73
79
|
const [query, setQuery] = React.useState('');
|
|
74
|
-
const
|
|
80
|
+
const ownerState = {
|
|
81
|
+
classes: rootProps.classes,
|
|
82
|
+
recording: isRecording
|
|
83
|
+
};
|
|
84
|
+
const classes = useUtilityClasses(ownerState);
|
|
75
85
|
const examplesFromData = React.useMemo(() => allowDataSampling ? sampleData(apiRef) : undefined, [apiRef, allowDataSampling]);
|
|
76
86
|
const processPrompt = React.useCallback(() => {
|
|
77
87
|
const context = generateContext(apiRef, examplesFromData);
|
|
@@ -109,10 +119,18 @@ function GridToolbarPromptControl(props) {
|
|
|
109
119
|
sort: s.direction
|
|
110
120
|
})));
|
|
111
121
|
const rows = getVisibleRows(apiRef, rootProps);
|
|
112
|
-
const
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
122
|
+
const rowSelectionModel = {
|
|
123
|
+
type: 'include',
|
|
124
|
+
ids: new Set()
|
|
125
|
+
};
|
|
126
|
+
if (result.select !== -1) {
|
|
127
|
+
for (let i = 0; i < result.select; i += 1) {
|
|
128
|
+
const row = rows.rows[i];
|
|
129
|
+
const id = apiRef.current.getRowId(row);
|
|
130
|
+
rowSelectionModel.ids.add(id);
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
apiRef.current.setRowSelectionModel(rowSelectionModel);
|
|
116
134
|
const columns = apiRef.current.getAllColumns();
|
|
117
135
|
const targetIndex = Number(columns.find(c => c.field === GRID_CHECKBOX_SELECTION_FIELD) !== undefined) + Number(result.grouping.length);
|
|
118
136
|
interestColumns.push(...Object.keys(result.aggregation));
|
|
@@ -145,10 +163,9 @@ function GridToolbarPromptControl(props) {
|
|
|
145
163
|
});
|
|
146
164
|
const placeholder = supportsSpeechRecognition ? apiRef.current.getLocaleText('toolbarPromptControlWithRecordingPlaceholder') : apiRef.current.getLocaleText('toolbarPromptControlPlaceholder');
|
|
147
165
|
return /*#__PURE__*/_jsx(GridToolbarPromptControlRoot, {
|
|
148
|
-
ownerState:
|
|
166
|
+
ownerState: ownerState,
|
|
149
167
|
className: classes.root,
|
|
150
168
|
children: /*#__PURE__*/_jsx(rootProps.slots.baseTextField, {
|
|
151
|
-
variant: "outlined",
|
|
152
169
|
placeholder: isRecording ? apiRef.current.getLocaleText('toolbarPromptControlRecordingPlaceholder') : placeholder,
|
|
153
170
|
"aria-label": apiRef.current.getLocaleText('toolbarPromptControlLabel'),
|
|
154
171
|
disabled: isLoading,
|
|
@@ -161,10 +178,9 @@ function GridToolbarPromptControl(props) {
|
|
|
161
178
|
onKeyDown: handleKeyDown,
|
|
162
179
|
error: !!error,
|
|
163
180
|
helperText: error,
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
children: /*#__PURE__*/_jsx(RecordButton, {
|
|
181
|
+
slotProps: {
|
|
182
|
+
input: {
|
|
183
|
+
startAdornment: supportsSpeechRecognition && /*#__PURE__*/_jsx(RecordButton, {
|
|
168
184
|
className: classes.recordButton,
|
|
169
185
|
lang: lang,
|
|
170
186
|
recording: isRecording,
|
|
@@ -173,11 +189,8 @@ function GridToolbarPromptControl(props) {
|
|
|
173
189
|
onUpdate: setQuery,
|
|
174
190
|
onDone: handleDone,
|
|
175
191
|
onError: setError
|
|
176
|
-
})
|
|
177
|
-
|
|
178
|
-
endAdornment: /*#__PURE__*/_jsx(rootProps.slots.baseInputAdornment, {
|
|
179
|
-
position: "end",
|
|
180
|
-
children: /*#__PURE__*/_jsx(rootProps.slots.baseTooltip, {
|
|
192
|
+
}),
|
|
193
|
+
endAdornment: /*#__PURE__*/_jsx(rootProps.slots.baseTooltip, {
|
|
181
194
|
title: apiRef.current.getLocaleText('toolbarPromptControlSendActionLabel'),
|
|
182
195
|
children: /*#__PURE__*/_jsx("div", {
|
|
183
196
|
children: /*#__PURE__*/_jsx(rootProps.slots.baseIconButton, {
|
|
@@ -194,7 +207,7 @@ function GridToolbarPromptControl(props) {
|
|
|
194
207
|
})
|
|
195
208
|
})
|
|
196
209
|
})
|
|
197
|
-
}
|
|
210
|
+
}
|
|
198
211
|
}
|
|
199
212
|
})
|
|
200
213
|
});
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
export declare const BrowserSpeechRecognition: any;
|
|
3
|
+
type SpeechRecognitionOptions = {
|
|
4
|
+
onUpdate: (value: string) => void;
|
|
5
|
+
onDone: (value: string) => void;
|
|
6
|
+
onError: (error: string) => void;
|
|
7
|
+
};
|
|
8
|
+
interface RecordButtonProps extends SpeechRecognitionOptions {
|
|
9
|
+
disabled: boolean;
|
|
10
|
+
lang?: string;
|
|
11
|
+
recording: boolean;
|
|
12
|
+
setRecording: (value: boolean) => void;
|
|
13
|
+
className: string;
|
|
14
|
+
}
|
|
15
|
+
declare function RecordButton(props: RecordButtonProps): React.JSX.Element;
|
|
16
|
+
export { RecordButton };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GridToolbarPromptControl as Unstable_GridToolbarPromptControl } from "./GridToolbarPromptControl.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { GridPremiumColumnMenu as GridColumnMenu, GRID_COLUMN_MENU_SLOTS_PREMIUM as GRID_COLUMN_MENU_SLOTS, GRID_COLUMN_MENU_SLOT_PROPS_PREMIUM as GRID_COLUMN_MENU_SLOT_PROPS } from "./GridPremiumColumnMenu.js";
|
|
@@ -2,6 +2,10 @@ import _extends from "@babel/runtime/helpers/esm/extends";
|
|
|
2
2
|
import { DATA_GRID_PRO_DEFAULT_SLOTS_COMPONENTS } from '@mui/x-data-grid-pro/internals';
|
|
3
3
|
import { GridPremiumColumnMenu } from "../components/GridPremiumColumnMenu.js";
|
|
4
4
|
import materialSlots from "../material/index.js";
|
|
5
|
+
import { GridBottomContainer } from "../components/GridBottomContainer.js";
|
|
6
|
+
import { GridPremiumToolbar } from "../components/GridPremiumToolbar.js";
|
|
5
7
|
export const DATA_GRID_PREMIUM_DEFAULT_SLOTS_COMPONENTS = _extends({}, DATA_GRID_PRO_DEFAULT_SLOTS_COMPONENTS, materialSlots, {
|
|
6
|
-
columnMenu: GridPremiumColumnMenu
|
|
8
|
+
columnMenu: GridPremiumColumnMenu,
|
|
9
|
+
bottomContainer: GridBottomContainer,
|
|
10
|
+
toolbar: GridPremiumToolbar
|
|
7
11
|
});
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { RefObject } from '@mui/x-internals/types';
|
|
2
|
+
import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
|
|
3
|
+
import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
|
|
4
|
+
import { GridAggregationFunction, GridAggregationFunctionDataSource, GridAggregationLookup } from "./gridAggregationInterfaces.js";
|
|
5
|
+
export declare const createAggregationLookup: ({
|
|
6
|
+
apiRef,
|
|
7
|
+
aggregationFunctions,
|
|
8
|
+
aggregationRowsScope,
|
|
9
|
+
getAggregationPosition,
|
|
10
|
+
isDataSource
|
|
11
|
+
}: {
|
|
12
|
+
apiRef: RefObject<GridPrivateApiPremium>;
|
|
13
|
+
aggregationFunctions: Record<string, GridAggregationFunction> | Record<string, GridAggregationFunctionDataSource>;
|
|
14
|
+
aggregationRowsScope: DataGridPremiumProcessedProps["aggregationRowsScope"];
|
|
15
|
+
getAggregationPosition: DataGridPremiumProcessedProps["getAggregationPosition"];
|
|
16
|
+
isDataSource: boolean;
|
|
17
|
+
}) => GridAggregationLookup;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { gridColumnLookupSelector, gridFilteredRowsLookupSelector, gridRowTreeSelector, GRID_ROOT_GROUP_ID } from '@mui/x-data-grid-pro';
|
|
1
|
+
import { gridColumnLookupSelector, gridFilteredRowsLookupSelector, gridRowTreeSelector, GRID_ROOT_GROUP_ID, gridRowNodeSelector } from '@mui/x-data-grid-pro';
|
|
2
2
|
import { getAggregationRules } from "./gridAggregationUtils.js";
|
|
3
3
|
import { gridAggregationModelSelector } from "./gridAggregationSelectors.js";
|
|
4
4
|
const getGroupAggregatedValue = (groupId, apiRef, aggregationRowsScope, aggregatedFields, aggregationRules, position) => {
|
|
@@ -20,7 +20,7 @@ const getGroupAggregatedValue = (groupId, apiRef, aggregationRowsScope, aggregat
|
|
|
20
20
|
// A.B
|
|
21
21
|
// A.B.A
|
|
22
22
|
// A.B.B
|
|
23
|
-
const rowNode = apiRef
|
|
23
|
+
const rowNode = gridRowNodeSelector(apiRef, rowId);
|
|
24
24
|
if (rowNode.type === 'group') {
|
|
25
25
|
return;
|
|
26
26
|
}
|
|
@@ -70,7 +70,7 @@ const getGroupAggregatedValueDataSource = (groupId, apiRef, aggregatedFields, po
|
|
|
70
70
|
const aggregatedField = aggregatedFields[j];
|
|
71
71
|
groupAggregationLookup[aggregatedField] = {
|
|
72
72
|
position,
|
|
73
|
-
value: apiRef.current.resolveGroupAggregation(groupId, aggregatedField)
|
|
73
|
+
value: apiRef.current.resolveGroupAggregation?.(groupId, aggregatedField) ?? ''
|
|
74
74
|
};
|
|
75
75
|
}
|
|
76
76
|
return groupAggregationLookup;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { GridAggregationFunction } from "./gridAggregationInterfaces.js";
|
|
2
|
+
export declare const GRID_AGGREGATION_FUNCTIONS: {
|
|
3
|
+
sum: GridAggregationFunction<unknown, number>;
|
|
4
|
+
avg: GridAggregationFunction<unknown, number>;
|
|
5
|
+
min: GridAggregationFunction<number | Date, number | Date>;
|
|
6
|
+
max: GridAggregationFunction<number | Date, number | Date>;
|
|
7
|
+
size: GridAggregationFunction<unknown, number>;
|
|
8
|
+
};
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import { GridRowId, GridRowModel, GridColDef, GridValueFormatter } from '@mui/x-data-grid-pro';
|
|
2
|
+
export interface GridAggregationState {
|
|
3
|
+
model: GridAggregationModel;
|
|
4
|
+
lookup: GridAggregationLookup;
|
|
5
|
+
}
|
|
6
|
+
export interface GridAggregationInitialState {
|
|
7
|
+
model?: GridAggregationModel;
|
|
8
|
+
}
|
|
9
|
+
export interface GridAggregationInternalCache {
|
|
10
|
+
rulesOnLastColumnHydration: GridAggregationRules;
|
|
11
|
+
rulesOnLastRowHydration: GridAggregationRules;
|
|
12
|
+
}
|
|
13
|
+
export interface GridAggregationApi {
|
|
14
|
+
/**
|
|
15
|
+
* Sets the aggregation model to the one given by `model`.
|
|
16
|
+
* @param {GridAggregationModel} model The aggregation model.
|
|
17
|
+
*/
|
|
18
|
+
setAggregationModel: (model: GridAggregationModel) => void;
|
|
19
|
+
}
|
|
20
|
+
export interface GridAggregationPrivateApi {
|
|
21
|
+
/**
|
|
22
|
+
* Applies the aggregation to the rows.
|
|
23
|
+
*/
|
|
24
|
+
applyAggregation: () => void;
|
|
25
|
+
}
|
|
26
|
+
export interface GridAggregationGetCellValueParams {
|
|
27
|
+
/**
|
|
28
|
+
* The row model of the row that the current cell belongs to.
|
|
29
|
+
*/
|
|
30
|
+
row: GridRowModel;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Grid aggregation function definition interface.
|
|
34
|
+
* @demos
|
|
35
|
+
* - [Aggregation functions](/x/react-data-grid/aggregation/#aggregation-functions)
|
|
36
|
+
*/
|
|
37
|
+
export interface GridAggregationFunction<V = any, AV = V> {
|
|
38
|
+
/**
|
|
39
|
+
* Function that takes the current cell values and generates the aggregated value.
|
|
40
|
+
* @template V, AV
|
|
41
|
+
* @param {GridAggregationParams<V>} params The params of the current aggregated cell.
|
|
42
|
+
* @returns {AV} The aggregated value.
|
|
43
|
+
*/
|
|
44
|
+
apply: (params: GridAggregationParams<V>) => AV | null | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Label of the aggregation function.
|
|
47
|
+
* Used for adding a label to the footer of the grouping column when this aggregation function is the only one being used.
|
|
48
|
+
* @default apiRef.current.getLocaleText('aggregationFunctionLabel{capitalize(name)})
|
|
49
|
+
*/
|
|
50
|
+
label?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Column types supported by this aggregation function.
|
|
53
|
+
* If not defined, all types are supported (in most cases this property should be defined).
|
|
54
|
+
*/
|
|
55
|
+
columnTypes?: string[];
|
|
56
|
+
/**
|
|
57
|
+
* Function for applying a formatter to the aggregated value.
|
|
58
|
+
* If not defined, the grid uses the formatter of the column.
|
|
59
|
+
*/
|
|
60
|
+
valueFormatter?: GridValueFormatter;
|
|
61
|
+
/**
|
|
62
|
+
* Indicates if the aggregated value has the same unit as the cells used to generate it.
|
|
63
|
+
* It can be used to apply a custom cell renderer only if the aggregated value has the same unit.
|
|
64
|
+
* @default true
|
|
65
|
+
*/
|
|
66
|
+
hasCellUnit?: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Function that allows to transform the value of the cell passed to the aggregation function applier.
|
|
69
|
+
* Useful for aggregating data from multiple row fields.
|
|
70
|
+
* @demo https://mui.com/x/react-data-grid/aggregation/#aggregating-data-from-multiple-row-fields
|
|
71
|
+
* @param {GridAggregationGetCellValueParams} params The params of the current cell
|
|
72
|
+
* @returns {V} The value of the cell that will be passed to the aggregation `apply` function
|
|
73
|
+
*/
|
|
74
|
+
getCellValue?: (params: GridAggregationGetCellValueParams) => V;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Grid aggregation function data source definition interface.
|
|
78
|
+
* @demos
|
|
79
|
+
* - [Server-side aggregation](/x/react-data-grid/server-side-data/aggregation/)
|
|
80
|
+
*/
|
|
81
|
+
export interface GridAggregationFunctionDataSource extends Omit<GridAggregationFunction, 'apply' | 'getCellValue'> {}
|
|
82
|
+
export interface GridAggregationParams<V = any> {
|
|
83
|
+
values: (V | undefined)[];
|
|
84
|
+
groupId: GridRowId;
|
|
85
|
+
field: GridColDef['field'];
|
|
86
|
+
}
|
|
87
|
+
export type GridAggregationModel = {
|
|
88
|
+
[field: string]: string;
|
|
89
|
+
};
|
|
90
|
+
export type GridAggregationLookup = {
|
|
91
|
+
[rowId: GridRowId]: {
|
|
92
|
+
[field: string]: {
|
|
93
|
+
position: GridAggregationPosition;
|
|
94
|
+
value: any;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
export type GridAggregationPosition = 'inline' | 'footer';
|
|
99
|
+
export interface GridAggregationCellMeta {
|
|
100
|
+
/**
|
|
101
|
+
* If `true`, the current aggregated value has the same unit as the value of the other cells of this row.
|
|
102
|
+
* For instance, "min" / "max" aggregation have the same unit as the other cells.
|
|
103
|
+
* If `false`, the current aggregated value has another unit or not unit.
|
|
104
|
+
* For instance, "size" aggregation has no unit.
|
|
105
|
+
*/
|
|
106
|
+
hasCellUnit: boolean;
|
|
107
|
+
/**
|
|
108
|
+
* Name of the aggregation function currently applied on this cell.
|
|
109
|
+
*/
|
|
110
|
+
aggregationFunctionName: string;
|
|
111
|
+
}
|
|
112
|
+
export interface GridAggregationHeaderMeta {
|
|
113
|
+
aggregationRule: GridAggregationRule;
|
|
114
|
+
}
|
|
115
|
+
export interface GridAggregationRule {
|
|
116
|
+
aggregationFunctionName: string;
|
|
117
|
+
aggregationFunction: GridAggregationFunction | GridAggregationFunctionDataSource;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Object containing all the aggregation rules that must be applied to the current columns.
|
|
121
|
+
* Unlike the aggregation model, those rules are sanitized and do not contain:
|
|
122
|
+
* - items for non-existing columns
|
|
123
|
+
* - items for non-aggregable columns (GridColDef.aggregable = false)
|
|
124
|
+
* - items for non-existing aggregation function
|
|
125
|
+
* - items for non-available aggregation function on the column (GridColDef.availableAggregationFunctions)
|
|
126
|
+
*/
|
|
127
|
+
export type GridAggregationRules = {
|
|
128
|
+
[field: string]: GridAggregationRule;
|
|
129
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { GridStatePremium } from "../../../models/gridStatePremium.js";
|
|
2
|
+
export declare const gridAggregationStateSelector: import("@mui/x-data-grid").OutputSelector<GridStatePremium, unknown, import("./gridAggregationInterfaces").GridAggregationState>;
|
|
3
|
+
/**
|
|
4
|
+
* Get the aggregation model, containing the aggregation function of each column.
|
|
5
|
+
* If a column is not in the model, it is not aggregated.
|
|
6
|
+
* @category Aggregation
|
|
7
|
+
*/
|
|
8
|
+
export declare const gridAggregationModelSelector: import("@mui/x-data-grid").OutputSelector<GridStatePremium, import("./gridAggregationInterfaces").GridAggregationState, import("./gridAggregationInterfaces").GridAggregationModel>;
|
|
9
|
+
/**
|
|
10
|
+
* Get the aggregation results as a lookup.
|
|
11
|
+
* @category Aggregation
|
|
12
|
+
*/
|
|
13
|
+
export declare const gridAggregationLookupSelector: import("@mui/x-data-grid").OutputSelector<GridStatePremium, import("./gridAggregationInterfaces").GridAggregationState, import("./gridAggregationInterfaces").GridAggregationLookup>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { createSelector } from '@mui/x-data-grid-pro/internals';
|
|
2
|
-
export const gridAggregationStateSelector = state => state.aggregation;
|
|
1
|
+
import { createSelector, createRootSelector } from '@mui/x-data-grid-pro/internals';
|
|
2
|
+
export const gridAggregationStateSelector = createRootSelector(state => state.aggregation);
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Get the aggregation model, containing the aggregation function of each column.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { RefObject } from '@mui/x-internals/types';
|
|
2
|
+
import { GridColDef, GridRowId } from '@mui/x-data-grid-pro';
|
|
3
|
+
import { GridColumnRawLookup, GridHydrateRowsValue } from '@mui/x-data-grid-pro/internals';
|
|
4
|
+
import { GridAggregationFunction, GridAggregationFunctionDataSource, GridAggregationModel, GridAggregationRule, GridAggregationRules } from "./gridAggregationInterfaces.js";
|
|
5
|
+
import { GridStatePremium } from "../../../models/gridStatePremium.js";
|
|
6
|
+
import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
|
|
7
|
+
import { GridApiPremium, GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
|
|
8
|
+
export declare const GRID_AGGREGATION_ROOT_FOOTER_ROW_ID = "auto-generated-group-footer-root";
|
|
9
|
+
export declare const getAggregationFooterRowIdFromGroupId: (groupId: GridRowId | null) => string;
|
|
10
|
+
type AggregationFunction = GridAggregationFunction | GridAggregationFunctionDataSource | undefined;
|
|
11
|
+
export declare const canColumnHaveAggregationFunction: ({
|
|
12
|
+
colDef,
|
|
13
|
+
aggregationFunctionName,
|
|
14
|
+
aggregationFunction,
|
|
15
|
+
isDataSource
|
|
16
|
+
}: {
|
|
17
|
+
colDef: GridColDef | undefined;
|
|
18
|
+
aggregationFunctionName: string;
|
|
19
|
+
aggregationFunction: AggregationFunction;
|
|
20
|
+
isDataSource: boolean;
|
|
21
|
+
}) => boolean;
|
|
22
|
+
export declare const getAvailableAggregationFunctions: ({
|
|
23
|
+
aggregationFunctions,
|
|
24
|
+
colDef,
|
|
25
|
+
isDataSource
|
|
26
|
+
}: {
|
|
27
|
+
aggregationFunctions: Record<string, GridAggregationFunction> | Record<string, GridAggregationFunctionDataSource>;
|
|
28
|
+
colDef: GridColDef;
|
|
29
|
+
isDataSource: boolean;
|
|
30
|
+
}) => string[];
|
|
31
|
+
export declare const mergeStateWithAggregationModel: (aggregationModel: GridAggregationModel) => (state: GridStatePremium) => GridStatePremium;
|
|
32
|
+
export declare const getAggregationRules: (columnsLookup: GridColumnRawLookup, aggregationModel: GridAggregationModel, aggregationFunctions: Record<string, GridAggregationFunction> | Record<string, GridAggregationFunctionDataSource>, isDataSource: boolean) => GridAggregationRules;
|
|
33
|
+
interface AddFooterRowsParams {
|
|
34
|
+
groupingParams: GridHydrateRowsValue;
|
|
35
|
+
getAggregationPosition: DataGridPremiumProcessedProps['getAggregationPosition'];
|
|
36
|
+
/**
|
|
37
|
+
* If `true`, there are some aggregation rules to apply
|
|
38
|
+
*/
|
|
39
|
+
hasAggregationRule: boolean;
|
|
40
|
+
apiRef: RefObject<GridPrivateApiPremium>;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Add a footer for each group that has at least one column with an aggregated value.
|
|
44
|
+
*/
|
|
45
|
+
export declare const addFooterRows: ({
|
|
46
|
+
groupingParams,
|
|
47
|
+
apiRef,
|
|
48
|
+
getAggregationPosition,
|
|
49
|
+
hasAggregationRule
|
|
50
|
+
}: AddFooterRowsParams) => GridHydrateRowsValue;
|
|
51
|
+
/**
|
|
52
|
+
* Compares two sets of aggregation rules to determine if they are equal or not.
|
|
53
|
+
*/
|
|
54
|
+
export declare const areAggregationRulesEqual: (previousValue: GridAggregationRules | undefined, newValue: GridAggregationRules) => boolean;
|
|
55
|
+
export declare const getAggregationFunctionLabel: ({
|
|
56
|
+
apiRef,
|
|
57
|
+
aggregationRule
|
|
58
|
+
}: {
|
|
59
|
+
apiRef: RefObject<GridApiPremium>;
|
|
60
|
+
aggregationRule: GridAggregationRule;
|
|
61
|
+
}) => string;
|
|
62
|
+
export {};
|
|
@@ -111,7 +111,7 @@ export const addFooterRows = ({
|
|
|
111
111
|
}
|
|
112
112
|
};
|
|
113
113
|
const updateRootGroupFooter = groupNode => {
|
|
114
|
-
const shouldHaveFooter = hasAggregationRule && getAggregationPosition(groupNode) === 'footer';
|
|
114
|
+
const shouldHaveFooter = hasAggregationRule && getAggregationPosition(groupNode) === 'footer' && groupNode.children.length > 0;
|
|
115
115
|
if (shouldHaveFooter) {
|
|
116
116
|
const rowId = getAggregationFooterRowIdFromGroupId(null);
|
|
117
117
|
newGroupingParams = addPinnedRow({
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type { GridAggregationState, GridAggregationInitialState, GridAggregationInternalCache, GridAggregationApi, GridAggregationGetCellValueParams, GridAggregationFunction, GridAggregationFunctionDataSource, GridAggregationParams, GridAggregationModel, GridAggregationLookup, GridAggregationPosition, GridAggregationCellMeta, GridAggregationHeaderMeta, GridAggregationRule, GridAggregationRules } from './gridAggregationInterfaces';
|
|
2
|
+
export * from "./gridAggregationSelectors.js";
|
|
3
|
+
export * from "./gridAggregationFunctions.js";
|
|
4
|
+
export { GRID_AGGREGATION_ROOT_FOOTER_ROW_ID, getAggregationFooterRowIdFromGroupId } from "./gridAggregationUtils.js";
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { RefObject } from '@mui/x-internals/types';
|
|
2
|
+
import { GridStateInitializer } from '@mui/x-data-grid-pro/internals';
|
|
3
|
+
import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
|
|
4
|
+
import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
|
|
5
|
+
export declare const aggregationStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'aggregationModel' | 'initialState'>, GridPrivateApiPremium>;
|
|
6
|
+
export declare const useGridAggregation: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "onAggregationModelChange" | "initialState" | "aggregationModel" | "getAggregationPosition" | "aggregationFunctions" | "aggregationRowsScope" | "disableAggregation" | "rowGroupingColumnMode" | "dataSource">) => void;
|
|
@@ -32,7 +32,6 @@ export const useGridAggregation = (apiRef, props) => {
|
|
|
32
32
|
const currentModel = gridAggregationModelSelector(apiRef);
|
|
33
33
|
if (currentModel !== model) {
|
|
34
34
|
apiRef.current.setState(mergeStateWithAggregationModel(model));
|
|
35
|
-
apiRef.current.forceUpdate();
|
|
36
35
|
}
|
|
37
36
|
}, [apiRef]);
|
|
38
37
|
const applyAggregation = React.useCallback(() => {
|
|
@@ -41,14 +40,14 @@ export const useGridAggregation = (apiRef, props) => {
|
|
|
41
40
|
getAggregationPosition: props.getAggregationPosition,
|
|
42
41
|
aggregationFunctions: props.aggregationFunctions,
|
|
43
42
|
aggregationRowsScope: props.aggregationRowsScope,
|
|
44
|
-
isDataSource: !!props.
|
|
43
|
+
isDataSource: !!props.dataSource
|
|
45
44
|
});
|
|
46
45
|
apiRef.current.setState(state => _extends({}, state, {
|
|
47
46
|
aggregation: _extends({}, state.aggregation, {
|
|
48
47
|
lookup: aggregationLookup
|
|
49
48
|
})
|
|
50
49
|
}));
|
|
51
|
-
}, [apiRef, props.getAggregationPosition, props.aggregationFunctions, props.aggregationRowsScope, props.
|
|
50
|
+
}, [apiRef, props.getAggregationPosition, props.aggregationFunctions, props.aggregationRowsScope, props.dataSource]);
|
|
52
51
|
const aggregationApi = {
|
|
53
52
|
setAggregationModel
|
|
54
53
|
};
|
|
@@ -72,12 +71,12 @@ export const useGridAggregation = (apiRef, props) => {
|
|
|
72
71
|
rulesOnLastRowHydration,
|
|
73
72
|
rulesOnLastColumnHydration
|
|
74
73
|
} = apiRef.current.caches.aggregation;
|
|
75
|
-
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(gridColumnLookupSelector(apiRef), gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.
|
|
74
|
+
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(gridColumnLookupSelector(apiRef), gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.dataSource);
|
|
76
75
|
|
|
77
76
|
// Re-apply the row hydration to add / remove the aggregation footers
|
|
78
77
|
if (!areAggregationRulesEqual(rulesOnLastRowHydration, aggregationRules)) {
|
|
79
|
-
if (props.
|
|
80
|
-
apiRef.current.
|
|
78
|
+
if (props.dataSource) {
|
|
79
|
+
apiRef.current.dataSource.fetchRows();
|
|
81
80
|
} else {
|
|
82
81
|
apiRef.current.requestPipeProcessorsApplication('hydrateRows');
|
|
83
82
|
applyAggregation();
|
|
@@ -86,10 +85,9 @@ export const useGridAggregation = (apiRef, props) => {
|
|
|
86
85
|
|
|
87
86
|
// Re-apply the column hydration to wrap / unwrap the aggregated columns
|
|
88
87
|
if (!areAggregationRulesEqual(rulesOnLastColumnHydration, aggregationRules)) {
|
|
89
|
-
apiRef.current.caches.aggregation.rulesOnLastColumnHydration = aggregationRules;
|
|
90
88
|
apiRef.current.requestPipeProcessorsApplication('hydrateColumns');
|
|
91
89
|
}
|
|
92
|
-
}, [apiRef, applyAggregation, props.aggregationFunctions, props.disableAggregation, props.
|
|
90
|
+
}, [apiRef, applyAggregation, props.aggregationFunctions, props.disableAggregation, props.dataSource]);
|
|
93
91
|
useGridApiEventHandler(apiRef, 'aggregationModelChange', checkAggregationRulesDiff);
|
|
94
92
|
useGridApiEventHandler(apiRef, 'columnsChange', checkAggregationRulesDiff);
|
|
95
93
|
useGridApiEventHandler(apiRef, 'filteredRowsSet', applyAggregation);
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { RefObject } from '@mui/x-internals/types';
|
|
2
|
+
import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
|
|
3
|
+
import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
|
|
4
|
+
export declare const useGridAggregationPreProcessors: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "aggregationFunctions" | "disableAggregation" | "getAggregationPosition" | "slotProps" | "slots" | "dataSource">) => void;
|
|
@@ -10,7 +10,7 @@ export const useGridAggregationPreProcessors = (apiRef, props) => {
|
|
|
10
10
|
// that the pre-processor is called it will already have been updated with the current rules.
|
|
11
11
|
const rulesOnLastColumnHydration = React.useRef({});
|
|
12
12
|
const updateAggregatedColumns = React.useCallback(columnsState => {
|
|
13
|
-
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(columnsState.lookup, gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.
|
|
13
|
+
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(columnsState.lookup, gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.dataSource);
|
|
14
14
|
columnsState.orderedFields.forEach(field => {
|
|
15
15
|
const shouldHaveAggregationValue = !!aggregationRules[field];
|
|
16
16
|
const haveAggregationColumnValue = !!rulesOnLastColumnHydration.current[field];
|
|
@@ -30,10 +30,11 @@ export const useGridAggregationPreProcessors = (apiRef, props) => {
|
|
|
30
30
|
columnsState.lookup[field] = column;
|
|
31
31
|
});
|
|
32
32
|
rulesOnLastColumnHydration.current = aggregationRules;
|
|
33
|
+
apiRef.current.caches.aggregation.rulesOnLastColumnHydration = aggregationRules;
|
|
33
34
|
return columnsState;
|
|
34
|
-
}, [apiRef, props.aggregationFunctions, props.disableAggregation, props.
|
|
35
|
+
}, [apiRef, props.aggregationFunctions, props.disableAggregation, props.dataSource]);
|
|
35
36
|
const addGroupFooterRows = React.useCallback(value => {
|
|
36
|
-
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(gridColumnLookupSelector(apiRef), gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.
|
|
37
|
+
const aggregationRules = props.disableAggregation ? {} : getAggregationRules(gridColumnLookupSelector(apiRef), gridAggregationModelSelector(apiRef), props.aggregationFunctions, !!props.dataSource);
|
|
37
38
|
const hasAggregationRule = Object.keys(aggregationRules).length > 0;
|
|
38
39
|
|
|
39
40
|
// If we did not have any aggregation footer before, and we still don't have any,
|
|
@@ -48,7 +49,7 @@ export const useGridAggregationPreProcessors = (apiRef, props) => {
|
|
|
48
49
|
getAggregationPosition: props.getAggregationPosition,
|
|
49
50
|
hasAggregationRule
|
|
50
51
|
});
|
|
51
|
-
}, [apiRef, props.disableAggregation, props.getAggregationPosition, props.aggregationFunctions, props.
|
|
52
|
+
}, [apiRef, props.disableAggregation, props.getAggregationPosition, props.aggregationFunctions, props.dataSource]);
|
|
52
53
|
const addColumnMenuButtons = React.useCallback((columnMenuItems, colDef) => {
|
|
53
54
|
if (props.disableAggregation || !colDef.aggregable) {
|
|
54
55
|
return columnMenuItems;
|
|
@@ -56,13 +57,13 @@ export const useGridAggregationPreProcessors = (apiRef, props) => {
|
|
|
56
57
|
const availableAggregationFunctions = getAvailableAggregationFunctions({
|
|
57
58
|
aggregationFunctions: props.aggregationFunctions,
|
|
58
59
|
colDef,
|
|
59
|
-
isDataSource: !!props.
|
|
60
|
+
isDataSource: !!props.dataSource
|
|
60
61
|
});
|
|
61
62
|
if (availableAggregationFunctions.length === 0) {
|
|
62
63
|
return columnMenuItems;
|
|
63
64
|
}
|
|
64
65
|
return [...columnMenuItems, 'columnMenuAggregationItem'];
|
|
65
|
-
}, [props.aggregationFunctions, props.disableAggregation, props.
|
|
66
|
+
}, [props.aggregationFunctions, props.disableAggregation, props.dataSource]);
|
|
66
67
|
const stateExportPreProcessing = React.useCallback(prevState => {
|
|
67
68
|
if (props.disableAggregation) {
|
|
68
69
|
return prevState;
|