@mui/x-data-grid-premium 8.0.0-alpha.11 → 8.0.0-alpha.12

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.
Files changed (355) hide show
  1. package/CHANGELOG.md +161 -1
  2. package/DataGridPremium/DataGrid.d.ts +1 -1
  3. package/DataGridPremium/DataGridPremium.d.ts +6 -6
  4. package/DataGridPremium/DataGridPremium.js +15 -2
  5. package/DataGridPremium/index.d.ts +3 -3
  6. package/DataGridPremium/useDataGridPremiumComponent.d.ts +3 -3
  7. package/DataGridPremium/useDataGridPremiumComponent.js +3 -2
  8. package/DataGridPremium/useDataGridPremiumProps.d.ts +2 -2
  9. package/components/GridAggregationHeader.d.ts +2 -2
  10. package/components/GridAggregationRowOverlay.d.ts +3 -0
  11. package/components/GridAggregationRowOverlay.js +44 -0
  12. package/components/GridBottomContainer.d.ts +3 -0
  13. package/components/GridBottomContainer.js +51 -0
  14. package/components/GridColumnMenuAggregationItem.d.ts +2 -2
  15. package/components/GridColumnMenuAggregationItem.js +32 -42
  16. package/components/GridColumnMenuRowGroupItem.d.ts +1 -1
  17. package/components/GridColumnMenuRowUngroupItem.d.ts +1 -1
  18. package/components/GridDataSourceGroupingCriteriaCell.d.ts +2 -2
  19. package/components/GridDataSourceGroupingCriteriaCell.js +3 -6
  20. package/components/GridExcelExportMenuItem.d.ts +3 -3
  21. package/components/GridFooterCell.d.ts +2 -2
  22. package/components/GridGroupingColumnFooterCell.d.ts +1 -1
  23. package/components/GridGroupingColumnLeafCell.d.ts +1 -1
  24. package/components/GridGroupingCriteriaCell.d.ts +2 -2
  25. package/components/GridPremiumColumnMenu.d.ts +26 -26
  26. package/components/index.d.ts +5 -5
  27. package/components/promptControl/GridToolbarPromptControl.d.ts +22 -22
  28. package/components/promptControl/RecordButton.d.ts +9 -9
  29. package/components/promptControl/index.d.ts +1 -1
  30. package/components/reexports.d.ts +1 -1
  31. package/constants/dataGridPremiumDefaultSlotsComponents.d.ts +1 -1
  32. package/constants/dataGridPremiumDefaultSlotsComponents.js +3 -1
  33. package/esm/DataGridPremium/DataGrid.d.ts +8 -0
  34. package/esm/DataGridPremium/DataGridPremium.d.ts +16 -0
  35. package/esm/DataGridPremium/DataGridPremium.js +15 -2
  36. package/esm/DataGridPremium/index.d.ts +3 -0
  37. package/esm/DataGridPremium/useDataGridPremiumComponent.d.ts +4 -0
  38. package/esm/DataGridPremium/useDataGridPremiumComponent.js +4 -3
  39. package/esm/DataGridPremium/useDataGridPremiumProps.d.ts +6 -0
  40. package/esm/components/GridAggregationHeader.d.ts +7 -0
  41. package/esm/components/GridAggregationRowOverlay.d.ts +3 -0
  42. package/esm/components/GridAggregationRowOverlay.js +37 -0
  43. package/esm/components/GridBottomContainer.d.ts +3 -0
  44. package/esm/components/GridBottomContainer.js +43 -0
  45. package/esm/components/GridColumnMenuAggregationItem.d.ts +7 -0
  46. package/esm/components/GridColumnMenuAggregationItem.js +32 -42
  47. package/esm/components/GridColumnMenuRowGroupItem.d.ts +3 -0
  48. package/esm/components/GridColumnMenuRowUngroupItem.d.ts +3 -0
  49. package/esm/components/GridDataSourceGroupingCriteriaCell.d.ts +7 -0
  50. package/esm/components/GridDataSourceGroupingCriteriaCell.js +4 -7
  51. package/esm/components/GridExcelExportMenuItem.d.ts +9 -0
  52. package/esm/components/GridFooterCell.d.ts +9 -0
  53. package/esm/components/GridGroupingColumnFooterCell.d.ts +4 -0
  54. package/esm/components/GridGroupingColumnLeafCell.d.ts +4 -0
  55. package/esm/components/GridGroupingCriteriaCell.d.ts +7 -0
  56. package/esm/components/GridPremiumColumnMenu.d.ts +33 -0
  57. package/esm/components/index.d.ts +5 -0
  58. package/esm/components/promptControl/GridToolbarPromptControl.d.ts +26 -0
  59. package/esm/components/promptControl/RecordButton.d.ts +16 -0
  60. package/esm/components/promptControl/index.d.ts +1 -0
  61. package/esm/components/reexports.d.ts +1 -0
  62. package/esm/constants/dataGridPremiumDefaultSlotsComponents.d.ts +2 -0
  63. package/esm/constants/dataGridPremiumDefaultSlotsComponents.js +3 -1
  64. package/esm/hooks/features/aggregation/createAggregationLookup.d.ts +17 -0
  65. package/esm/hooks/features/aggregation/createAggregationLookup.js +3 -3
  66. package/esm/hooks/features/aggregation/gridAggregationFunctions.d.ts +8 -0
  67. package/esm/hooks/features/aggregation/gridAggregationInterfaces.d.ts +129 -0
  68. package/esm/hooks/features/aggregation/gridAggregationSelectors.d.ts +13 -0
  69. package/esm/hooks/features/aggregation/gridAggregationSelectors.js +2 -2
  70. package/esm/hooks/features/aggregation/gridAggregationUtils.d.ts +62 -0
  71. package/esm/hooks/features/aggregation/index.d.ts +4 -0
  72. package/esm/hooks/features/aggregation/useGridAggregation.d.ts +6 -0
  73. package/esm/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +4 -0
  74. package/esm/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +81 -0
  75. package/esm/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
  76. package/esm/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +40 -0
  77. package/esm/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -0
  78. package/esm/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -1
  79. package/esm/hooks/features/cellSelection/index.d.ts +1 -0
  80. package/esm/hooks/features/cellSelection/useGridCellSelection.d.ts +6 -0
  81. package/esm/hooks/features/cellSelection/useGridCellSelection.js +5 -6
  82. package/esm/hooks/features/clipboard/useGridClipboardImport.d.ts +4 -0
  83. package/esm/hooks/features/clipboard/useGridClipboardImport.js +2 -2
  84. package/esm/hooks/features/dataSource/models.d.ts +54 -0
  85. package/esm/hooks/features/dataSource/useGridDataSourcePremium.d.ts +4 -0
  86. package/esm/hooks/features/dataSource/useGridDataSourcePremium.js +10 -4
  87. package/esm/hooks/features/export/gridExcelExportInterface.d.ts +71 -0
  88. package/esm/hooks/features/export/index.d.ts +2 -0
  89. package/esm/hooks/features/export/index.js +1 -1
  90. package/esm/hooks/features/export/serializer/excelSerializer.d.ts +40 -0
  91. package/esm/hooks/features/export/serializer/excelSerializer.js +69 -180
  92. package/esm/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
  93. package/esm/hooks/features/export/serializer/setupExcelExportWebWorker.js +53 -0
  94. package/esm/hooks/features/export/serializer/utils.d.ts +36 -0
  95. package/esm/hooks/features/export/serializer/utils.js +93 -0
  96. package/esm/hooks/features/export/useGridExcelExport.d.ts +11 -0
  97. package/esm/hooks/features/export/useGridExcelExport.js +11 -5
  98. package/esm/hooks/features/index.d.ts +5 -0
  99. package/esm/hooks/features/promptControl/api.d.ts +2 -0
  100. package/esm/hooks/features/promptControl/index.d.ts +2 -0
  101. package/esm/hooks/features/promptControl/types.d.ts +25 -0
  102. package/esm/hooks/features/rowGrouping/createGroupingColDef.d.ts +57 -0
  103. package/esm/hooks/features/rowGrouping/createGroupingColDef.js +5 -5
  104. package/esm/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +44 -0
  105. package/esm/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +3 -0
  106. package/esm/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
  107. package/esm/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +54 -0
  108. package/esm/hooks/features/rowGrouping/index.d.ts +3 -0
  109. package/esm/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +4 -0
  110. package/esm/hooks/features/rowGrouping/useGridRowGrouping.d.ts +11 -0
  111. package/esm/hooks/features/rowGrouping/useGridRowGrouping.js +0 -1
  112. package/esm/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +4 -0
  113. package/esm/hooks/features/rows/index.d.ts +1 -0
  114. package/esm/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -0
  115. package/esm/hooks/index.d.ts +2 -0
  116. package/esm/hooks/utils/index.d.ts +1 -0
  117. package/esm/hooks/utils/useGridApiContext.d.ts +4 -0
  118. package/esm/hooks/utils/useGridApiRef.d.ts +4 -0
  119. package/esm/hooks/utils/useGridAriaAttributes.d.ts +2 -0
  120. package/esm/hooks/utils/useGridPrivateApiContext.d.ts +2 -0
  121. package/esm/hooks/utils/useGridRootProps.d.ts +2 -0
  122. package/esm/hooks/utils/useKeepGroupedColumnsHidden.d.ts +12 -0
  123. package/esm/index.d.ts +29 -0
  124. package/esm/index.js +7 -0
  125. package/esm/locales.d.ts +1 -0
  126. package/esm/material/icons.d.ts +15 -0
  127. package/esm/material/index.d.ts +8 -0
  128. package/esm/models/dataGridPremiumProps.d.ts +163 -0
  129. package/esm/models/gridApiPremium.d.ts +14 -0
  130. package/esm/models/gridGroupingValueGetter.d.ts +4 -0
  131. package/esm/models/gridPastedValueParser.d.ts +4 -0
  132. package/esm/models/gridPremiumIconSlotsComponent.d.ts +28 -0
  133. package/esm/models/gridPremiumSlotsComponent.d.ts +7 -0
  134. package/esm/models/gridStatePremium.d.ts +18 -0
  135. package/esm/models/index.d.ts +4 -0
  136. package/esm/package.json +1 -0
  137. package/esm/setupExcelExportWebWorker.d.ts +1 -0
  138. package/esm/setupExcelExportWebWorker.js +1 -0
  139. package/esm/themeAugmentation/index.d.ts +2 -0
  140. package/esm/themeAugmentation/overrides.d.ts +7 -0
  141. package/esm/themeAugmentation/props.d.ts +15 -0
  142. package/esm/typeOverloads/index.d.ts +2 -0
  143. package/esm/typeOverloads/modules.d.ts +97 -0
  144. package/esm/typeOverloads/reexports.d.ts +17 -0
  145. package/esm/utils/releaseInfo.d.ts +1 -0
  146. package/esm/utils/releaseInfo.js +1 -1
  147. package/hooks/features/aggregation/createAggregationLookup.d.ts +16 -10
  148. package/hooks/features/aggregation/createAggregationLookup.js +2 -2
  149. package/hooks/features/aggregation/gridAggregationFunctions.d.ts +7 -7
  150. package/hooks/features/aggregation/gridAggregationInterfaces.d.ts +81 -82
  151. package/hooks/features/aggregation/gridAggregationSelectors.d.ts +3 -3
  152. package/hooks/features/aggregation/gridAggregationSelectors.js +1 -2
  153. package/hooks/features/aggregation/gridAggregationUtils.d.ts +42 -25
  154. package/hooks/features/aggregation/index.d.ts +4 -4
  155. package/hooks/features/aggregation/useGridAggregation.d.ts +3 -3
  156. package/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +3 -3
  157. package/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +67 -62
  158. package/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
  159. package/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +34 -34
  160. package/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -2
  161. package/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -2
  162. package/hooks/features/cellSelection/index.d.ts +1 -1
  163. package/hooks/features/cellSelection/useGridCellSelection.d.ts +3 -3
  164. package/hooks/features/cellSelection/useGridCellSelection.js +5 -6
  165. package/hooks/features/clipboard/useGridClipboardImport.d.ts +2 -2
  166. package/hooks/features/clipboard/useGridClipboardImport.js +2 -2
  167. package/hooks/features/dataSource/models.d.ts +41 -34
  168. package/hooks/features/dataSource/useGridDataSourcePremium.d.ts +3 -3
  169. package/hooks/features/dataSource/useGridDataSourcePremium.js +10 -4
  170. package/hooks/features/export/gridExcelExportInterface.d.ts +52 -52
  171. package/hooks/features/export/index.d.ts +2 -2
  172. package/hooks/features/export/index.js +2 -2
  173. package/hooks/features/export/serializer/excelSerializer.d.ts +23 -51
  174. package/hooks/features/export/serializer/excelSerializer.js +74 -187
  175. package/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
  176. package/hooks/features/export/serializer/setupExcelExportWebWorker.js +59 -0
  177. package/hooks/features/export/serializer/utils.d.ts +36 -0
  178. package/hooks/features/export/serializer/utils.js +106 -0
  179. package/hooks/features/export/useGridExcelExport.d.ts +3 -3
  180. package/hooks/features/export/useGridExcelExport.js +10 -3
  181. package/hooks/features/index.d.ts +5 -5
  182. package/hooks/features/promptControl/api.d.ts +2 -2
  183. package/hooks/features/promptControl/index.d.ts +2 -2
  184. package/hooks/features/promptControl/types.d.ts +15 -15
  185. package/hooks/features/rowGrouping/createGroupingColDef.d.ts +44 -32
  186. package/hooks/features/rowGrouping/createGroupingColDef.js +4 -4
  187. package/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +32 -32
  188. package/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +2 -2
  189. package/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
  190. package/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +30 -22
  191. package/hooks/features/rowGrouping/index.d.ts +3 -3
  192. package/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +3 -3
  193. package/hooks/features/rowGrouping/useGridRowGrouping.d.ts +3 -3
  194. package/hooks/features/rowGrouping/useGridRowGrouping.js +0 -1
  195. package/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +3 -3
  196. package/hooks/features/rows/index.d.ts +1 -1
  197. package/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -1
  198. package/hooks/index.d.ts +2 -2
  199. package/hooks/utils/index.d.ts +1 -1
  200. package/hooks/utils/useGridApiContext.d.ts +2 -2
  201. package/hooks/utils/useGridApiRef.d.ts +2 -2
  202. package/hooks/utils/useGridAriaAttributes.d.ts +1 -1
  203. package/hooks/utils/useGridPrivateApiContext.d.ts +2 -2
  204. package/hooks/utils/useGridRootProps.d.ts +2 -2
  205. package/hooks/utils/useKeepGroupedColumnsHidden.d.ts +4 -4
  206. package/index.d.ts +10 -12
  207. package/index.js +1 -1
  208. package/locales.d.ts +1 -1
  209. package/material/icons.d.ts +6 -6
  210. package/material/index.d.ts +6 -6
  211. package/models/dataGridPremiumProps.d.ts +140 -134
  212. package/models/gridApiPremium.d.ts +4 -6
  213. package/models/gridGroupingValueGetter.d.ts +2 -2
  214. package/models/gridPastedValueParser.d.ts +2 -2
  215. package/models/gridPremiumIconSlotsComponent.d.ts +26 -26
  216. package/models/gridPremiumSlotsComponent.d.ts +2 -3
  217. package/models/gridStatePremium.d.ts +7 -7
  218. package/models/index.d.ts +4 -4
  219. package/modern/DataGridPremium/DataGrid.d.ts +8 -0
  220. package/modern/DataGridPremium/DataGridPremium.d.ts +16 -0
  221. package/modern/DataGridPremium/DataGridPremium.js +15 -2
  222. package/modern/DataGridPremium/index.d.ts +3 -0
  223. package/modern/DataGridPremium/useDataGridPremiumComponent.d.ts +4 -0
  224. package/modern/DataGridPremium/useDataGridPremiumComponent.js +4 -3
  225. package/modern/DataGridPremium/useDataGridPremiumProps.d.ts +6 -0
  226. package/modern/components/GridAggregationHeader.d.ts +7 -0
  227. package/modern/components/GridAggregationRowOverlay.d.ts +3 -0
  228. package/modern/components/GridAggregationRowOverlay.js +37 -0
  229. package/modern/components/GridBottomContainer.d.ts +3 -0
  230. package/modern/components/GridBottomContainer.js +43 -0
  231. package/modern/components/GridColumnMenuAggregationItem.d.ts +7 -0
  232. package/modern/components/GridColumnMenuAggregationItem.js +32 -42
  233. package/modern/components/GridColumnMenuRowGroupItem.d.ts +3 -0
  234. package/modern/components/GridColumnMenuRowUngroupItem.d.ts +3 -0
  235. package/modern/components/GridDataSourceGroupingCriteriaCell.d.ts +7 -0
  236. package/modern/components/GridDataSourceGroupingCriteriaCell.js +4 -7
  237. package/modern/components/GridExcelExportMenuItem.d.ts +9 -0
  238. package/modern/components/GridFooterCell.d.ts +9 -0
  239. package/modern/components/GridGroupingColumnFooterCell.d.ts +4 -0
  240. package/modern/components/GridGroupingColumnLeafCell.d.ts +4 -0
  241. package/modern/components/GridGroupingCriteriaCell.d.ts +7 -0
  242. package/modern/components/GridPremiumColumnMenu.d.ts +33 -0
  243. package/modern/components/index.d.ts +5 -0
  244. package/modern/components/promptControl/GridToolbarPromptControl.d.ts +26 -0
  245. package/modern/components/promptControl/RecordButton.d.ts +16 -0
  246. package/modern/components/promptControl/index.d.ts +1 -0
  247. package/modern/components/reexports.d.ts +1 -0
  248. package/modern/constants/dataGridPremiumDefaultSlotsComponents.d.ts +2 -0
  249. package/modern/constants/dataGridPremiumDefaultSlotsComponents.js +3 -1
  250. package/modern/hooks/features/aggregation/createAggregationLookup.d.ts +17 -0
  251. package/modern/hooks/features/aggregation/createAggregationLookup.js +3 -3
  252. package/modern/hooks/features/aggregation/gridAggregationFunctions.d.ts +8 -0
  253. package/modern/hooks/features/aggregation/gridAggregationInterfaces.d.ts +129 -0
  254. package/modern/hooks/features/aggregation/gridAggregationSelectors.d.ts +13 -0
  255. package/modern/hooks/features/aggregation/gridAggregationSelectors.js +2 -2
  256. package/modern/hooks/features/aggregation/gridAggregationUtils.d.ts +62 -0
  257. package/modern/hooks/features/aggregation/index.d.ts +4 -0
  258. package/modern/hooks/features/aggregation/useGridAggregation.d.ts +6 -0
  259. package/modern/hooks/features/aggregation/useGridAggregationPreProcessors.d.ts +4 -0
  260. package/modern/hooks/features/aggregation/wrapColumnWithAggregation.d.ts +81 -0
  261. package/modern/hooks/features/aggregation/wrapColumnWithAggregation.js +6 -5
  262. package/modern/hooks/features/cellSelection/gridCellSelectionInterfaces.d.ts +40 -0
  263. package/modern/hooks/features/cellSelection/gridCellSelectionSelector.d.ts +2 -0
  264. package/modern/hooks/features/cellSelection/gridCellSelectionSelector.js +2 -1
  265. package/modern/hooks/features/cellSelection/index.d.ts +1 -0
  266. package/modern/hooks/features/cellSelection/useGridCellSelection.d.ts +6 -0
  267. package/modern/hooks/features/cellSelection/useGridCellSelection.js +5 -6
  268. package/modern/hooks/features/clipboard/useGridClipboardImport.d.ts +4 -0
  269. package/modern/hooks/features/clipboard/useGridClipboardImport.js +2 -2
  270. package/modern/hooks/features/dataSource/models.d.ts +54 -0
  271. package/modern/hooks/features/dataSource/useGridDataSourcePremium.d.ts +4 -0
  272. package/modern/hooks/features/dataSource/useGridDataSourcePremium.js +10 -4
  273. package/modern/hooks/features/export/gridExcelExportInterface.d.ts +71 -0
  274. package/modern/hooks/features/export/index.d.ts +2 -0
  275. package/modern/hooks/features/export/index.js +1 -1
  276. package/modern/hooks/features/export/serializer/excelSerializer.d.ts +40 -0
  277. package/modern/hooks/features/export/serializer/excelSerializer.js +69 -180
  278. package/modern/hooks/features/export/serializer/setupExcelExportWebWorker.d.ts +2 -0
  279. package/modern/hooks/features/export/serializer/setupExcelExportWebWorker.js +53 -0
  280. package/modern/hooks/features/export/serializer/utils.d.ts +36 -0
  281. package/modern/hooks/features/export/serializer/utils.js +93 -0
  282. package/modern/hooks/features/export/useGridExcelExport.d.ts +11 -0
  283. package/modern/hooks/features/export/useGridExcelExport.js +11 -5
  284. package/modern/hooks/features/index.d.ts +5 -0
  285. package/modern/hooks/features/promptControl/api.d.ts +2 -0
  286. package/modern/hooks/features/promptControl/index.d.ts +2 -0
  287. package/modern/hooks/features/promptControl/types.d.ts +25 -0
  288. package/modern/hooks/features/rowGrouping/createGroupingColDef.d.ts +57 -0
  289. package/modern/hooks/features/rowGrouping/createGroupingColDef.js +5 -5
  290. package/modern/hooks/features/rowGrouping/gridRowGroupingInterfaces.d.ts +44 -0
  291. package/modern/hooks/features/rowGrouping/gridRowGroupingSelector.d.ts +3 -0
  292. package/modern/hooks/features/rowGrouping/gridRowGroupingSelector.js +2 -2
  293. package/modern/hooks/features/rowGrouping/gridRowGroupingUtils.d.ts +54 -0
  294. package/modern/hooks/features/rowGrouping/index.d.ts +3 -0
  295. package/modern/hooks/features/rowGrouping/useGridDataSourceRowGroupingPreProcessors.d.ts +4 -0
  296. package/modern/hooks/features/rowGrouping/useGridRowGrouping.d.ts +11 -0
  297. package/modern/hooks/features/rowGrouping/useGridRowGrouping.js +0 -1
  298. package/modern/hooks/features/rowGrouping/useGridRowGroupingPreProcessors.d.ts +4 -0
  299. package/modern/hooks/features/rows/index.d.ts +1 -0
  300. package/modern/hooks/features/rows/useGridRowAriaAttributes.d.ts +1 -0
  301. package/modern/hooks/index.d.ts +2 -0
  302. package/modern/hooks/utils/index.d.ts +1 -0
  303. package/modern/hooks/utils/useGridApiContext.d.ts +4 -0
  304. package/modern/hooks/utils/useGridApiRef.d.ts +4 -0
  305. package/modern/hooks/utils/useGridAriaAttributes.d.ts +2 -0
  306. package/modern/hooks/utils/useGridPrivateApiContext.d.ts +2 -0
  307. package/modern/hooks/utils/useGridRootProps.d.ts +2 -0
  308. package/modern/hooks/utils/useKeepGroupedColumnsHidden.d.ts +12 -0
  309. package/modern/index.d.ts +29 -0
  310. package/modern/index.js +1 -1
  311. package/modern/locales.d.ts +1 -0
  312. package/modern/material/icons.d.ts +15 -0
  313. package/modern/material/index.d.ts +8 -0
  314. package/modern/models/dataGridPremiumProps.d.ts +163 -0
  315. package/modern/models/gridApiPremium.d.ts +14 -0
  316. package/modern/models/gridGroupingValueGetter.d.ts +4 -0
  317. package/modern/models/gridPastedValueParser.d.ts +4 -0
  318. package/modern/models/gridPremiumIconSlotsComponent.d.ts +28 -0
  319. package/modern/models/gridPremiumSlotsComponent.d.ts +7 -0
  320. package/modern/models/gridStatePremium.d.ts +18 -0
  321. package/modern/models/index.d.ts +4 -0
  322. package/modern/package.json +1 -0
  323. package/modern/setupExcelExportWebWorker.d.ts +1 -0
  324. package/modern/setupExcelExportWebWorker.js +1 -0
  325. package/modern/themeAugmentation/index.d.ts +2 -0
  326. package/modern/themeAugmentation/overrides.d.ts +7 -0
  327. package/modern/themeAugmentation/props.d.ts +15 -0
  328. package/modern/typeOverloads/index.d.ts +2 -0
  329. package/modern/typeOverloads/modules.d.ts +97 -0
  330. package/modern/typeOverloads/reexports.d.ts +17 -0
  331. package/modern/utils/releaseInfo.d.ts +1 -0
  332. package/modern/utils/releaseInfo.js +1 -1
  333. package/package.json +39 -9
  334. package/setupExcelExportWebWorker.d.ts +1 -0
  335. package/setupExcelExportWebWorker.js +12 -0
  336. package/themeAugmentation/index.d.ts +2 -2
  337. package/themeAugmentation/overrides.d.ts +3 -4
  338. package/themeAugmentation/props.d.ts +9 -11
  339. package/tsconfig.build.tsbuildinfo +1 -0
  340. package/typeOverloads/index.d.ts +1 -1
  341. package/typeOverloads/modules.d.ts +75 -82
  342. package/typeOverloads/reexports.d.ts +5 -5
  343. package/utils/releaseInfo.d.ts +1 -1
  344. package/utils/releaseInfo.js +1 -1
  345. package/DataGridPremium/package.json +0 -6
  346. package/components/package.json +0 -6
  347. package/esm/hooks/features/dataSource/cache.js +0 -3
  348. package/hooks/features/dataSource/cache.d.ts +0 -2
  349. package/hooks/features/dataSource/cache.js +0 -9
  350. package/hooks/package.json +0 -6
  351. package/material/package.json +0 -6
  352. package/models/package.json +0 -6
  353. package/modern/hooks/features/dataSource/cache.js +0 -3
  354. package/themeAugmentation/package.json +0 -6
  355. package/typeOverloads/package.json +0 -6
@@ -4,37 +4,37 @@ export type GridCellSelectionModel = Record<GridRowId, Record<GridColDef['field'
4
4
  * The cell selection API interface that is available in the grid [[apiRef]].
5
5
  */
6
6
  export interface GridCellSelectionApi {
7
- /**
8
- * Determines if a cell is selected or not.
9
- * @param {GridRowId} id The id of the row.
10
- * @param {GridColDef['field']} field The field.
11
- * @returns {boolean} A boolean indicating if the cell is selected.
12
- */
13
- isCellSelected: (id: GridRowId, field: GridColDef['field']) => boolean;
14
- /**
15
- * Returns an object containing the selection state of the cells.
16
- * The keys of the object correspond to the row IDs.
17
- * The value of each key is also an object, which has a column field for a key and a boolean value for its selection state.
18
- * @returns {GridCellSelectionModel} Object containing the selection state of the cells
19
- */
20
- getCellSelectionModel: () => GridCellSelectionModel;
21
- /**
22
- * Updates the cell selection model according to the value passed to the `newModel` argument.
23
- * Any cell already selected will be unselected.
24
- * @param {GridCellSelectionModel} newModel The cells to select.
25
- */
26
- setCellSelectionModel: (newModel: GridCellSelectionModel) => void;
27
- /**
28
- * Selects all cells that are inside the range given by `start` and `end` coordinates.
29
- * @param {GridCellCoordinates} start Object containing the row ID and field of the first cell to select.
30
- * @param {GridCellCoordinates} end Object containing the row ID and field of the last cell to select.
31
- * @param {boolean} keepOtherSelected Whether to keep current selected cells or discard. Default is false.
32
- */
33
- selectCellRange: (start: GridCellCoordinates, end: GridCellCoordinates, keepOtherSelected?: boolean) => void;
34
- /**
35
- * Returns an array containing only the selected cells.
36
- * Each item is an object with the ID and field of the cell.
37
- * @returns {GridCellCoordinates[]} Array with the selected cells.
38
- */
39
- getSelectedCellsAsArray: () => GridCellCoordinates[];
40
- }
7
+ /**
8
+ * Determines if a cell is selected or not.
9
+ * @param {GridRowId} id The id of the row.
10
+ * @param {GridColDef['field']} field The field.
11
+ * @returns {boolean} A boolean indicating if the cell is selected.
12
+ */
13
+ isCellSelected: (id: GridRowId, field: GridColDef['field']) => boolean;
14
+ /**
15
+ * Returns an object containing the selection state of the cells.
16
+ * The keys of the object correspond to the row IDs.
17
+ * The value of each key is also an object, which has a column field for a key and a boolean value for its selection state.
18
+ * @returns {GridCellSelectionModel} Object containing the selection state of the cells
19
+ */
20
+ getCellSelectionModel: () => GridCellSelectionModel;
21
+ /**
22
+ * Updates the cell selection model according to the value passed to the `newModel` argument.
23
+ * Any cell already selected will be unselected.
24
+ * @param {GridCellSelectionModel} newModel The cells to select.
25
+ */
26
+ setCellSelectionModel: (newModel: GridCellSelectionModel) => void;
27
+ /**
28
+ * Selects all cells that are inside the range given by `start` and `end` coordinates.
29
+ * @param {GridCellCoordinates} start Object containing the row ID and field of the first cell to select.
30
+ * @param {GridCellCoordinates} end Object containing the row ID and field of the last cell to select.
31
+ * @param {boolean} keepOtherSelected Whether to keep current selected cells or discard. Default is false.
32
+ */
33
+ selectCellRange: (start: GridCellCoordinates, end: GridCellCoordinates, keepOtherSelected?: boolean) => void;
34
+ /**
35
+ * Returns an array containing only the selected cells.
36
+ * Each item is an object with the ID and field of the cell.
37
+ * @returns {GridCellCoordinates[]} Array with the selected cells.
38
+ */
39
+ getSelectedCellsAsArray: () => GridCellCoordinates[];
40
+ }
@@ -1,2 +1,2 @@
1
- import { GridStatePremium } from '../../../models/gridStatePremium';
2
- export declare const gridCellSelectionStateSelector: (state: GridStatePremium) => import("./gridCellSelectionInterfaces").GridCellSelectionModel;
1
+ import { GridStatePremium } from "../../../models/gridStatePremium.js";
2
+ export declare const gridCellSelectionStateSelector: import("@mui/x-data-grid").OutputSelector<GridStatePremium, unknown, import("./gridCellSelectionInterfaces").GridCellSelectionModel>;
@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.gridCellSelectionStateSelector = void 0;
7
- const gridCellSelectionStateSelector = state => state.cellSelection;
8
- exports.gridCellSelectionStateSelector = gridCellSelectionStateSelector;
7
+ var _internals = require("@mui/x-data-grid-pro/internals");
8
+ const gridCellSelectionStateSelector = exports.gridCellSelectionStateSelector = (0, _internals.createRootSelector)(state => state.cellSelection);
@@ -1 +1 @@
1
- export * from './gridCellSelectionInterfaces';
1
+ export * from "./gridCellSelectionInterfaces.js";
@@ -1,6 +1,6 @@
1
1
  import { RefObject } from '@mui/x-internals/types';
2
2
  import { GridStateInitializer } from '@mui/x-data-grid-pro/internals';
3
- import { DataGridPremiumProcessedProps } from '../../../models/dataGridPremiumProps';
4
- import { GridPrivateApiPremium } from '../../../models/gridApiPremium';
3
+ import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
4
+ import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
5
5
  export declare const cellSelectionStateInitializer: GridStateInitializer<Pick<DataGridPremiumProcessedProps, 'cellSelectionModel' | 'initialState'>>;
6
- export declare const useGridCellSelection: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "cellSelection" | "cellSelectionModel" | "onCellSelectionModelChange" | "pagination" | "paginationMode" | "ignoreValueFormatterDuringExport" | "clipboardCopyCellDelimiter" | "columnHeaderHeight">) => void;
6
+ export declare const useGridCellSelection: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "cellSelection" | "cellSelectionModel" | "onCellSelectionModelChange" | "pagination" | "paginationMode" | "ignoreValueFormatterDuringExport" | "clipboardCopyCellDelimiter" | "columnHeaderHeight">) => void;
@@ -49,11 +49,11 @@ const useGridCellSelection = (apiRef, props) => {
49
49
  if (!props.cellSelection) {
50
50
  return false;
51
51
  }
52
- const cellSelectionModel = (0, _gridCellSelectionSelector.gridCellSelectionStateSelector)(apiRef.current.state);
52
+ const cellSelectionModel = (0, _gridCellSelectionSelector.gridCellSelectionStateSelector)(apiRef);
53
53
  return cellSelectionModel[id] ? !!cellSelectionModel[id][field] : false;
54
54
  }, [apiRef, props.cellSelection]);
55
55
  const getCellSelectionModel = React.useCallback(() => {
56
- return (0, _gridCellSelectionSelector.gridCellSelectionStateSelector)(apiRef.current.state);
56
+ return (0, _gridCellSelectionSelector.gridCellSelectionStateSelector)(apiRef);
57
57
  }, [apiRef]);
58
58
  const setCellSelectionModel = React.useCallback(newModel => {
59
59
  if (!props.cellSelection) {
@@ -62,7 +62,6 @@ const useGridCellSelection = (apiRef, props) => {
62
62
  apiRef.current.setState(prevState => (0, _extends2.default)({}, prevState, {
63
63
  cellSelection: newModel
64
64
  }));
65
- apiRef.current.forceUpdate();
66
65
  }, [apiRef, props.cellSelection]);
67
66
  const selectCellRange = React.useCallback((start, end, keepOtherSelected = false) => {
68
67
  const startRowIndex = apiRef.current.getRowIndexRelativeToVisibleRows(start.id);
@@ -193,7 +192,7 @@ const useGridCellSelection = (apiRef, props) => {
193
192
  if (!mousePosition.current || !apiRef.current.virtualScrollerRef?.current) {
194
193
  return;
195
194
  }
196
- const dimensions = (0, _xDataGridPro.gridDimensionsSelector)(apiRef.current.state);
195
+ const dimensions = (0, _xDataGridPro.gridDimensionsSelector)(apiRef);
197
196
  const {
198
197
  x: mouseX,
199
198
  y: mouseY
@@ -253,7 +252,7 @@ const useGridCellSelection = (apiRef, props) => {
253
252
  if (!virtualScrollerRect) {
254
253
  return;
255
254
  }
256
- const dimensions = (0, _xDataGridPro.gridDimensionsSelector)(apiRef.current.state);
255
+ const dimensions = (0, _xDataGridPro.gridDimensionsSelector)(apiRef);
257
256
  const {
258
257
  x,
259
258
  y
@@ -462,7 +461,7 @@ const useGridCellSelection = (apiRef, props) => {
462
461
  if (apiRef.current.getSelectedCellsAsArray().length <= 1) {
463
462
  return value;
464
463
  }
465
- const sortedRowIds = (0, _xDataGridPro.gridSortedRowIdsSelector)(apiRef.current.state);
464
+ const sortedRowIds = (0, _xDataGridPro.gridSortedRowIdsSelector)(apiRef);
466
465
  const cellSelectionModel = apiRef.current.getCellSelectionModel();
467
466
  const unsortedSelectedRowIds = Object.keys(cellSelectionModel);
468
467
  const sortedSelectedRowIds = sortedRowIds.filter(id => unsortedSelectedRowIds.includes(`${id}`));
@@ -1,4 +1,4 @@
1
1
  import { RefObject } from '@mui/x-internals/types';
2
- import { GridPrivateApiPremium } from '../../../models/gridApiPremium';
2
+ import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
3
3
  import type { DataGridPremiumProcessedProps } from '../../../models/dataGridPremiumProps';
4
- export declare const useGridClipboardImport: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "pagination" | "paginationMode" | "processRowUpdate" | "onProcessRowUpdateError" | "getRowId" | "onClipboardPasteStart" | "onClipboardPasteEnd" | "splitClipboardPastedText" | "disableClipboardPaste" | "onBeforeClipboardPasteStart">) => void;
4
+ export declare const useGridClipboardImport: (apiRef: RefObject<GridPrivateApiPremium>, props: Pick<DataGridPremiumProcessedProps, "pagination" | "paginationMode" | "processRowUpdate" | "onProcessRowUpdateError" | "getRowId" | "onClipboardPasteStart" | "onClipboardPasteEnd" | "splitClipboardPastedText" | "disableClipboardPaste" | "onBeforeClipboardPasteStart">) => void;
@@ -263,7 +263,6 @@ const useGridClipboardImport = (apiRef, props) => {
263
263
  const onProcessRowUpdateError = props.onProcessRowUpdateError;
264
264
  const getRowId = props.getRowId;
265
265
  const enableClipboardPaste = !props.disableClipboardPaste;
266
- const rootEl = apiRef.current.rootElementRef?.current;
267
266
  const logger = (0, _internals.useGridLogger)(apiRef, 'useGridClipboardImport');
268
267
  const splitClipboardPastedText = props.splitClipboardPastedText;
269
268
  const {
@@ -286,6 +285,7 @@ const useGridClipboardImport = (apiRef, props) => {
286
285
  return;
287
286
  }
288
287
  }
288
+ const rootEl = apiRef.current.rootElementRef?.current;
289
289
  if (!rootEl) {
290
290
  return;
291
291
  }
@@ -326,7 +326,7 @@ const useGridClipboardImport = (apiRef, props) => {
326
326
  paginationMode
327
327
  });
328
328
  cellUpdater.applyUpdates();
329
- }, [apiRef, processRowUpdate, onProcessRowUpdateError, getRowId, enableClipboardPaste, rootEl, splitClipboardPastedText, pagination, paginationMode, onBeforeClipboardPasteStart, logger]);
329
+ }, [apiRef, processRowUpdate, onProcessRowUpdateError, getRowId, enableClipboardPaste, splitClipboardPastedText, pagination, paginationMode, onBeforeClipboardPasteStart, logger]);
330
330
  const checkIfCanStartEditing = React.useCallback((initialValue, {
331
331
  event
332
332
  }) => {
@@ -1,47 +1,54 @@
1
1
  import type { GridColDef, GridRowId, GridValidRowModel, GridDataSource, GridGetRowsResponse, GridGetRowsParams, GridDataSourceApiBase, GridDataSourcePrivateApi } from '@mui/x-data-grid-pro';
2
2
  import type { GridAggregationModel } from '../aggregation/gridAggregationInterfaces';
3
3
  export interface GridGetRowsResponsePremium extends GridGetRowsResponse {
4
- /**
5
- * Row to be used for aggregation footer row.
6
- * It must provide the values for the aggregated columns passed in
7
- * `GridGetRowsParams.aggregationModel`.
8
- */
9
- aggregateRow?: GridValidRowModel;
4
+ /**
5
+ * Row to be used for aggregation footer row.
6
+ * It must provide the values for the aggregated columns passed in
7
+ * `GridGetRowsParams.aggregationModel`.
8
+ */
9
+ aggregateRow?: GridValidRowModel;
10
10
  }
11
11
  export interface GridGetRowsParamsPremium extends GridGetRowsParams {
12
- aggregationModel?: GridAggregationModel;
12
+ /**
13
+ * List of aggregated columns.
14
+ */
15
+ aggregationModel?: GridAggregationModel;
16
+ /**
17
+ * List of grouped columns (only applicable with `rowGrouping`).
18
+ */
19
+ groupFields?: GridColDef['field'][];
13
20
  }
14
21
  export interface GridDataSourcePremium extends Omit<GridDataSource, 'getRows'> {
15
- /**
16
- * This method will be called when the grid needs to fetch some rows.
17
- * @param {GridGetRowsParamsPremium} params The parameters required to fetch the rows.
18
- * @returns {Promise<GridGetRowsResponsePremium>} A promise that resolves to the data of type [GridGetRowsResponsePremium].
19
- */
20
- getRows(params: GridGetRowsParamsPremium): Promise<GridGetRowsResponsePremium>;
21
- /**
22
- * Used to get the aggregated value for a parent row.
23
- * @param {GridValidRowModel} row The row to extract the aggregated value from.
24
- * @param {GridColDef['field']} field The field to extract the aggregated value for.
25
- * @returns {string} The aggregated value for a specific aggregated column.
26
- */
27
- getAggregatedValue?: (row: GridValidRowModel, field: GridColDef['field']) => string;
22
+ /**
23
+ * This method will be called when the grid needs to fetch some rows.
24
+ * @param {GridGetRowsParamsPremium} params The parameters required to fetch the rows.
25
+ * @returns {Promise<GridGetRowsResponsePremium>} A promise that resolves to the data of type [GridGetRowsResponsePremium].
26
+ */
27
+ getRows(params: GridGetRowsParamsPremium): Promise<GridGetRowsResponsePremium>;
28
+ /**
29
+ * Used to get the aggregated value for a parent row.
30
+ * @param {GridValidRowModel} row The row to extract the aggregated value from.
31
+ * @param {GridColDef['field']} field The field to extract the aggregated value for.
32
+ * @returns {string} The aggregated value for a specific aggregated column.
33
+ */
34
+ getAggregatedValue?: (row: GridValidRowModel, field: GridColDef['field']) => string;
28
35
  }
29
36
  export interface GridDataSourceApiBasePremium extends Omit<GridDataSourceApiBase, 'fetchRows'> {
30
- /**
31
- * Fetches the rows from the server.
32
- * If no `parentId` option is provided, it fetches the root rows.
33
- * Any missing parameter from `params` will be filled from the state (sorting, filtering, etc.).
34
- * @param {GridRowId} parentId The id of the parent node (default: `GRID_ROOT_GROUP_ID`).
35
- * @param {Partial<GridGetRowsParamsPremium>} params Request parameters override.
36
- */
37
- fetchRows: (parentId?: GridRowId, params?: Partial<GridGetRowsParamsPremium>) => void;
37
+ /**
38
+ * Fetches the rows from the server.
39
+ * If no `parentId` option is provided, it fetches the root rows.
40
+ * Any missing parameter from `params` will be filled from the state (sorting, filtering, etc.).
41
+ * @param {GridRowId} parentId The id of the parent node (default: `GRID_ROOT_GROUP_ID`).
42
+ * @param {Partial<GridGetRowsParamsPremium>} params Request parameters override.
43
+ */
44
+ fetchRows: (parentId?: GridRowId, params?: Partial<GridGetRowsParamsPremium>) => void;
38
45
  }
39
46
  export interface GridDataSourceApiPremium {
40
- /**
41
- * The data source API.
42
- */
43
- unstable_dataSource: GridDataSourceApiBasePremium;
47
+ /**
48
+ * The data source API.
49
+ */
50
+ unstable_dataSource: GridDataSourceApiBasePremium;
44
51
  }
45
52
  export interface GridDataSourcePremiumPrivateApi extends GridDataSourcePrivateApi {
46
- resolveGroupAggregation: (groupId: GridRowId, field: string) => any;
47
- }
53
+ resolveGroupAggregation: (groupId: GridRowId, field: string) => any;
54
+ }
@@ -1,4 +1,4 @@
1
1
  import { RefObject } from '@mui/x-internals/types';
2
- import { GridPrivateApiPremium } from '../../../models/gridApiPremium';
3
- import { DataGridPremiumProcessedProps } from '../../../models/dataGridPremiumProps';
4
- export declare const useGridDataSourcePremium: (apiRef: RefObject<GridPrivateApiPremium>, props: DataGridPremiumProcessedProps) => void;
2
+ import { GridPrivateApiPremium } from "../../../models/gridApiPremium.js";
3
+ import { DataGridPremiumProcessedProps } from "../../../models/dataGridPremiumProps.js";
4
+ export declare const useGridDataSourcePremium: (apiRef: RefObject<GridPrivateApiPremium>, props: DataGridPremiumProcessedProps) => void;
@@ -10,18 +10,21 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
10
10
  var React = _interopRequireWildcard(require("react"));
11
11
  var _xDataGridPro = require("@mui/x-data-grid-pro");
12
12
  var _internals = require("@mui/x-data-grid-pro/internals");
13
- var _cache = require("./cache");
13
+ function getKeyPremium(params) {
14
+ return JSON.stringify([params.filterModel, params.sortModel, params.groupKeys, params.groupFields, params.start, params.end, params.aggregationModel]);
15
+ }
14
16
  const options = {
15
17
  cacheOptions: {
16
- getKey: _cache.getKeyPremium
18
+ getKey: getKeyPremium
17
19
  }
18
20
  };
19
21
  const useGridDataSourcePremium = (apiRef, props) => {
20
22
  const {
21
23
  api,
22
24
  strategyProcessor,
23
- events
24
- } = (0, _internals.useGridDataSourceBase)(apiRef, props, options);
25
+ events,
26
+ setStrategyAvailability
27
+ } = (0, _internals.useGridDataSourceBasePro)(apiRef, props, options);
25
28
  const aggregateRowRef = React.useRef({});
26
29
  const processDataSourceRows = React.useCallback(({
27
30
  params,
@@ -58,5 +61,8 @@ const useGridDataSourcePremium = (apiRef, props) => {
58
61
  Object.entries(events).forEach(([event, handler]) => {
59
62
  (0, _xDataGridPro.useGridApiEventHandler)(apiRef, event, handler);
60
63
  });
64
+ React.useEffect(() => {
65
+ setStrategyAvailability();
66
+ }, [setStrategyAvailability]);
61
67
  };
62
68
  exports.useGridDataSourcePremium = useGridDataSourcePremium;
@@ -3,11 +3,11 @@ import { GridFileExportOptions, GridExportFormat as GridExportFormatCommunity, G
3
3
  export type GridExportFormat = GridExportFormatCommunity | 'excel';
4
4
  export type GridExportExtension = GridExportExtensionCommunity | 'xlsx';
5
5
  export interface GridExceljsProcessInput {
6
- workbook: Excel.Workbook;
7
- worksheet: Excel.Worksheet;
6
+ workbook: Excel.Workbook;
7
+ worksheet: Excel.Worksheet;
8
8
  }
9
9
  export interface ColumnsStylesInterface {
10
- [field: string]: Partial<Excel.Style>;
10
+ [field: string]: Partial<Excel.Style>;
11
11
  }
12
12
  /**
13
13
  * The options to apply on the Excel export.
@@ -15,57 +15,57 @@ export interface ColumnsStylesInterface {
15
15
  * - [Excel export](/x/react-data-grid/export/#excel-export)
16
16
  */
17
17
  export interface GridExcelExportOptions extends GridFileExportOptions {
18
- /**
19
- * Function to return the Worker instance to be called.
20
- * @returns {() => Worker} A Worker instance.
21
- */
22
- worker?: () => Worker;
23
- /**
24
- * Name given to the worksheet containing the columns valueOptions.
25
- * valueOptions are added to this worksheet if they are provided as an array.
26
- */
27
- valueOptionsSheetName?: string;
28
- /**
29
- * Method called before adding the rows to the workbook.
30
- * Not supported when `worker` is set.
31
- * To use with web workers, use the option in `setupExcelExportWebWorker`.
32
- * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
33
- * @returns {Promise<void>} A promise which resolves after processing the input.
34
- * */
35
- exceljsPreProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
36
- /**
37
- * Method called after adding the rows to the workbook.
38
- * Not supported when `worker` is set.
39
- * To use with web workers, use the option in `setupExcelExportWebWorker`.
40
- * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
41
- * @returns {Promise<void>} A promise which resolves after processing the input.
42
- * */
43
- exceljsPostProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
44
- /**
45
- * Object mapping column field to Exceljs style
46
- * */
47
- columnsStyles?: ColumnsStylesInterface;
48
- /**
49
- * If `true`, the headers of the column groups will be added into the file.
50
- * @default true
51
- */
52
- includeColumnGroupsHeaders?: boolean;
18
+ /**
19
+ * Function to return the Worker instance to be called.
20
+ * @returns {() => Worker} A Worker instance.
21
+ */
22
+ worker?: () => Worker;
23
+ /**
24
+ * Name given to the worksheet containing the columns valueOptions.
25
+ * valueOptions are added to this worksheet if they are provided as an array.
26
+ */
27
+ valueOptionsSheetName?: string;
28
+ /**
29
+ * Method called before adding the rows to the workbook.
30
+ * Not supported when `worker` is set.
31
+ * To use with web workers, use the option in `setupExcelExportWebWorker`.
32
+ * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
33
+ * @returns {Promise<void>} A promise which resolves after processing the input.
34
+ * */
35
+ exceljsPreProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
36
+ /**
37
+ * Method called after adding the rows to the workbook.
38
+ * Not supported when `worker` is set.
39
+ * To use with web workers, use the option in `setupExcelExportWebWorker`.
40
+ * @param {GridExceljsProcessInput} processInput object containing the workbook and the worksheet.
41
+ * @returns {Promise<void>} A promise which resolves after processing the input.
42
+ * */
43
+ exceljsPostProcess?: (processInput: GridExceljsProcessInput) => Promise<void>;
44
+ /**
45
+ * Object mapping column field to Exceljs style
46
+ * */
47
+ columnsStyles?: ColumnsStylesInterface;
48
+ /**
49
+ * If `true`, the headers of the column groups will be added into the file.
50
+ * @default true
51
+ */
52
+ includeColumnGroupsHeaders?: boolean;
53
53
  }
54
54
  /**
55
55
  * The excel export API interface that is available in the grid [[apiRef]].
56
56
  */
57
57
  export interface GridExcelExportApi {
58
- /**
59
- * Returns the grid data as an exceljs workbook.
60
- * This method is used internally by `exportDataAsExcel`.
61
- * @param {GridExcelExportOptions} options The options to apply on the export.
62
- * @returns {Promise<Excel.Workbook>} The data in a exceljs workbook object.
63
- */
64
- getDataAsExcel: (options?: GridExcelExportOptions) => Promise<Excel.Workbook> | null;
65
- /**
66
- * Downloads and exports an Excel file of the grid's data.
67
- * @param {GridExcelExportOptions} options The options to apply on the export.
68
- * @returns {Promise<void>} A promise which resolves after exporting to Excel.
69
- */
70
- exportDataAsExcel: (options?: GridExcelExportOptions) => Promise<void>;
71
- }
58
+ /**
59
+ * Returns the grid data as an exceljs workbook.
60
+ * This method is used internally by `exportDataAsExcel`.
61
+ * @param {GridExcelExportOptions} options The options to apply on the export.
62
+ * @returns {Promise<Excel.Workbook>} The data in a exceljs workbook object.
63
+ */
64
+ getDataAsExcel: (options?: GridExcelExportOptions) => Promise<Excel.Workbook> | null;
65
+ /**
66
+ * Downloads and exports an Excel file of the grid's data.
67
+ * @param {GridExcelExportOptions} options The options to apply on the export.
68
+ * @returns {Promise<void>} A promise which resolves after exporting to Excel.
69
+ */
70
+ exportDataAsExcel: (options?: GridExcelExportOptions) => Promise<void>;
71
+ }
@@ -1,2 +1,2 @@
1
- export * from './gridExcelExportInterface';
2
- export { setupExcelExportWebWorker } from './serializer/excelSerializer';
1
+ export * from "./gridExcelExportInterface.js";
2
+ export { setupExcelExportWebWorker } from "./serializer/setupExcelExportWebWorker.js";
@@ -9,7 +9,7 @@ var _exportNames = {
9
9
  Object.defineProperty(exports, "setupExcelExportWebWorker", {
10
10
  enumerable: true,
11
11
  get: function () {
12
- return _excelSerializer.setupExcelExportWebWorker;
12
+ return _setupExcelExportWebWorker.setupExcelExportWebWorker;
13
13
  }
14
14
  });
15
15
  var _gridExcelExportInterface = require("./gridExcelExportInterface");
@@ -24,4 +24,4 @@ Object.keys(_gridExcelExportInterface).forEach(function (key) {
24
24
  }
25
25
  });
26
26
  });
27
- var _excelSerializer = require("./serializer/excelSerializer");
27
+ var _setupExcelExportWebWorker = require("./serializer/setupExcelExportWebWorker");
@@ -1,18 +1,11 @@
1
1
  import type * as Excel from 'exceljs';
2
2
  import { RefObject } from '@mui/x-internals/types';
3
3
  import { GridRowId, GridColDef } from '@mui/x-data-grid-pro';
4
- import { GridStateColDef, GridColumnGroupLookup } from '@mui/x-data-grid/internals';
5
- import { ColumnsStylesInterface, GridExcelExportOptions } from '../gridExcelExportInterface';
6
- import { GridPrivateApiPremium } from '../../../../models/gridApiPremium';
7
- interface SerializedRow {
8
- row: Record<string, undefined | number | boolean | string | Date>;
9
- dataValidation: Record<string, Excel.DataValidation>;
10
- outlineLevel: number;
11
- mergedCells: {
12
- leftIndex: number;
13
- rightIndex: number;
14
- }[];
15
- }
4
+ import { GridStateColDef } from '@mui/x-data-grid/internals';
5
+ import { ColumnsStylesInterface, GridExcelExportOptions } from "../gridExcelExportInterface.js";
6
+ import { GridPrivateApiPremium } from "../../../../models/gridApiPremium.js";
7
+ import { SerializedColumns, SerializedRow, ValueOptionsData } from "./utils.js";
8
+ export type { ExcelExportInitEvent } from './utils';
16
9
  /**
17
10
  * FIXME: This function mutates the colspan info, but colspan info assumes that the columns
18
11
  * passed to it are always consistent. In this case, the exported columns may differ from the
@@ -20,49 +13,28 @@ interface SerializedRow {
20
13
  * The caller of this function MUST call `resetColSpan()` before and after usage.
21
14
  */
22
15
  export declare const serializeRowUnsafe: (id: GridRowId, columns: GridStateColDef[], apiRef: RefObject<GridPrivateApiPremium>, defaultValueOptionsFormulae: {
23
- [field: string]: {
24
- address: string;
25
- };
16
+ [field: string]: {
17
+ address: string;
18
+ };
26
19
  }, options: Pick<BuildExcelOptions, "escapeFormulas">) => SerializedRow;
27
20
  export declare const serializeColumn: (column: GridColDef, columnsStyles: ColumnsStylesInterface) => {
28
- key: string;
29
- headerText: string;
30
- width: number;
31
- style: {
32
- numFmt?: string | undefined;
33
- font?: Partial<Excel.Font> | undefined;
34
- alignment?: Partial<Excel.Alignment> | undefined;
35
- protection?: Partial<Excel.Protection> | undefined;
36
- border?: Partial<Excel.Borders> | undefined;
37
- fill?: Excel.Fill | undefined;
38
- };
21
+ key: string;
22
+ headerText: string;
23
+ width: number;
24
+ style: {
25
+ numFmt?: string | undefined;
26
+ font?: Partial<Excel.Font> | undefined;
27
+ alignment?: Partial<Excel.Alignment> | undefined;
28
+ protection?: Partial<Excel.Protection> | undefined;
29
+ border?: Partial<Excel.Borders> | undefined;
30
+ fill?: Excel.Fill | undefined;
31
+ };
39
32
  };
40
- type SerializedColumns = Array<{
41
- key: string;
42
- width: number;
43
- style: Partial<Excel.Style>;
44
- headerText: string;
45
- }>;
46
33
  export declare function serializeColumns(columns: GridStateColDef[], styles: ColumnsStylesInterface): SerializedColumns;
47
- type ValueOptionsData = Record<string, {
48
- values: (string | number)[];
49
- address: string;
50
- }>;
51
34
  export declare function getDataForValueOptionsSheet(columns: GridStateColDef[], valueOptionsSheetName: string, api: GridPrivateApiPremium): Promise<ValueOptionsData>;
52
35
  interface BuildExcelOptions extends Pick<GridExcelExportOptions, 'exceljsPreProcess' | 'exceljsPostProcess'>, Pick<Required<GridExcelExportOptions>, 'valueOptionsSheetName' | 'includeHeaders' | 'includeColumnGroupsHeaders' | 'escapeFormulas'> {
53
- columns: GridStateColDef[];
54
- rowIds: GridRowId[];
55
- columnsStyles?: ColumnsStylesInterface;
56
- }
57
- export declare function buildExcel(options: BuildExcelOptions, apiRef: RefObject<GridPrivateApiPremium>): Promise<Excel.Workbook>;
58
- export interface ExcelExportInitEvent {
59
- serializedColumns: SerializedColumns;
60
- serializedRows: SerializedRow[];
61
- valueOptionsSheetName: string;
62
- columnGroupPaths: Record<string, string[]>;
63
- columnGroupDetails: GridColumnGroupLookup;
64
- valueOptionsData: ValueOptionsData;
65
- options: Omit<GridExcelExportOptions, 'exceljsPreProcess' | 'exceljsPostProcess' | 'columnsStyles' | 'valueOptionsSheetName'>;
36
+ columns: GridStateColDef[];
37
+ rowIds: GridRowId[];
38
+ columnsStyles?: ColumnsStylesInterface;
66
39
  }
67
- export declare function setupExcelExportWebWorker(workerOptions?: Pick<GridExcelExportOptions, 'exceljsPostProcess' | 'exceljsPreProcess'>): void;
68
- export {};
40
+ export declare function buildExcel(options: BuildExcelOptions, apiRef: RefObject<GridPrivateApiPremium>): Promise<Excel.Workbook>;