@mui/x-data-grid 5.2.2 → 5.3.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.
Files changed (5) hide show
  1. package/CHANGELOG.md +182 -41
  2. package/index-cjs.js +2 -2
  3. package/index-esm.js +2 -2
  4. package/package.json +4 -4
  5. package/x-data-grid.d.ts +3457 -2905
package/CHANGELOG.md CHANGED
@@ -3,6 +3,148 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## 5.3.0
7
+
8
+ _Jan 21, 2022_
9
+
10
+ A big thanks to the 9 contributors who made this release possible. Here are some highlights ✨:
11
+
12
+ - 🎁 Allow to group rows based on column value (#3277) @flaviendelangle
13
+
14
+ ⚠️ This feature is temporarily available on the Pro plan until the release of the Premium plan.
15
+
16
+ To avoid future regression for users of the Pro plan, the feature needs to be explicitly activated using the rowGrouping experimental feature flag.
17
+
18
+ ```tsx
19
+ // To fully control
20
+ <DataGridPro
21
+ rowGroupingModel={rowGroupingModel}
22
+ onRowGroupingModel={newModel => setRowGroupingModel(newModel)}
23
+ experimentalFeatures={{ rowGrouping: true }}
24
+ />
25
+
26
+ // To initialize without controlling
27
+ <DataGridPro
28
+ initialState={{
29
+ rowGrouping: {
30
+ model: rowGroupingModel,
31
+ },
32
+ }}
33
+ experimentalFeatures={{ rowGrouping: true }}
34
+ />
35
+ ```
36
+
37
+ See the [documentation](https://mui.com/components/data-grid/group-pivot/#row-grouping) for more details.
38
+
39
+ - ⚡ Add `is any of` filter operator (#2874) @alexfauquette
40
+
41
+ The new filter operator `is any of` allows the user to provide multiple values. It opens access to complex filtering pattern mixing `AND` and `OR` logic connectors, such as `status is any of filled or rejected, and currency is any of EUR or USD`.
42
+
43
+ <img src="https://user-images.githubusercontent.com/45398769/150486348-996a938f-db24-426f-bfe3-c06337f71807.gif" width="770" height="370">
44
+
45
+ - ✨ Introduce a `maxWidth` property in `GridColDef` (#3550) @flaviendelangle
46
+
47
+ You can now limit the width of the flex columns and the resizable columns with the new `maxWidth` property on `GridColDef`.
48
+
49
+ ```tsx
50
+ const columns: GridColDef[] = [
51
+ { field: 'director', flex: 1, maxWidth: 200 }, // will take the free space up to 200px and will not be resizable above 200px
52
+ { field: 'year', maxWidth: 150 }, // will not be resizable above 150px
53
+ ]
54
+ ```
55
+
56
+ - 🚀 Add component slots for a subset of used `@mui/material` components (#3490) @DanailH
57
+
58
+ To make the grid more flexible we added component slots for base `@mui/material` components that we use. Those component slots are prefixed with `Base` to differentiate them from the other grid specific components
59
+
60
+ For more information check the documentation [documentation](https://mui.com/api/data-grid/data-grid/#slots).
61
+
62
+ - 🔥 Allow to pass `csvOptions` and `printOptions` to `toolbar` component prop (#3623) @flaviendelangle
63
+
64
+ ```tsx
65
+ const CustomDataGrid = (props: DataGridProps) => {
66
+ return (
67
+ <DataGrid {...props} componentsProps={{ toolbar: { csvOptions: { delimiter: ';' } } }} />
68
+ )
69
+ }
70
+ ```
71
+
72
+ - 🙈 Add controlled behavior for the visible columns (#3554) @flaviendelangle
73
+
74
+ ```tsx
75
+ // To fully control
76
+ <DataGrid
77
+ columnVisibilityModel={columnVisibilityModel}
78
+ onColumnVisilibilityModelChange={newModel => setColumnVisibilityModel(newModel)}
79
+ />
80
+
81
+ // To initialize without controlling
82
+ <DataGrid
83
+ initialState={{
84
+ columns: {
85
+ columnVisibilityModel
86
+ }
87
+ }}
88
+ />
89
+ ```
90
+
91
+ See the [documentation](https://mui.com/components/data-grid/columns/#column-visibility) for more details.
92
+
93
+ The `hide` property from `GridColDef` still works but has been deprecated.
94
+
95
+ - 📚 Documentation improvements
96
+ - 🐞 Bugfixes
97
+
98
+ ### `@mui/x-data-grid@v5.3.0` / `@mui/x-data-grid-pro@v5.3.0`
99
+
100
+ #### Changes
101
+
102
+ - [DataGrid] Add component slots for a subset of used `@mui/material` components (#3490) @DanailH
103
+ - [DataGrid] Add controlled behavior for the visible columns (#3554) @flaviendelangle
104
+ - [DataGrid] Add debounce to text input (#3617) @m4theushw
105
+ - [DataGrid] Add `is any of` filter operator (#2874) @alexfauquette
106
+ - [DataGrid] Allow to pass `csvOptions` and `printOptions` to `GridToolbar` (#3623) @flaviendelangle
107
+ - [DataGrid] Disable `Hide` button if there's only one visible column (#3607) @cherniavskii
108
+ - [DataGrid] Fix line break characters breaking CSV rows (#3590) @cherniavskii
109
+ - [DataGrid] Fix potential memory leak warning (#3558) @m4theushw
110
+ - [DataGrid] Introduce a `maxWidth` property in `GridColDef` (#3550) @flaviendelangle
111
+ - [DataGrid] Make row editing work with `preProcessEditCellProps` (#3562) @flaviendelangle
112
+ - [DataGridPro] Export the column pinning selector (#3594) @flaviendelangle
113
+ - [DataGridPro] Keep row children expansion when updating the rows (#3604) @flaviendelangle
114
+ - [DataGridPro] Keep tree data grouping column width when regenerating the columns (#3603) @flaviendelangle
115
+ - [DataGridPremium] Allow to group rows based on column value (#3277) @flaviendelangle
116
+ - [l10n] Improve Finnish (fiFI) locale (#3621) @MijMa
117
+ - [l10n] Improve Ukrainian (ukUA) locale (#3586) @Neonin
118
+ - [l10n] Improve Czech (csCZ) and Slovak (skSK) locale (#3678) @Haaxor1689
119
+
120
+ ### Docs
121
+
122
+ - [docs] Add doc example for tree data children lazy loading (#3657) @flaviendelangle
123
+ - [docs] Fix typo exchanging `false` and `true` on columns hiding section (#3561) @alexfauquette
124
+ - [docs] Improve filtering documentation page (#3437) @flaviendelangle
125
+ - [docs] Include header badges as in the other components (#3606) @oliviertassinari
126
+ - [docs] Lint markdown in the CI (#3504) @oliviertassinari
127
+ - [docs] Make inputs to extend full height of the cell (#3567) @m4theushw
128
+ - [docs] Add documentation page about the grid state (#3431) @flaviendelangle
129
+ - [docs] Replace `@mui/styles` in `x-data-grid-generator` (#3560) @m4theushw
130
+ - [docs] Update usage of prop/property naming (#3649) @cherniavskii
131
+
132
+ ### Core
133
+
134
+ - [core] Log the output of the script (#3527) @oliviertassinari
135
+ - [core] Add ESLint rule to prevent direct state access (#3521) @m4theushw
136
+ - [core] Add language to markdown code block (#3651) @m4theushw
137
+ - [core] Add typing to the pre-processors methods (#3595) @flaviendelangle
138
+ - [core] Don't bump peer dependency ranges on dependency updates (#3646) @oliviertassinari
139
+ - [core] Rename more instances of Material-UI to MUI (#3525) @oliviertassinari
140
+ - [core] Renovate should not try to update node (#3645) @oliviertassinari
141
+ - [core] Report performance test results on each PR (#3551) @m4theushw
142
+ - [core] Update monorepo (#3653) @m4theushw
143
+ - [core] Update `l10n` issue with a single command line (#3588) @alexfauquette
144
+ - [test] Wait for promise to resolve before expect (#3597) @m4theushw
145
+ - [test] Split cell/row editing tests (#3618) @m4theushw
146
+ - [test] Skip tests on Safari (#3679) @m4theushw
147
+
6
148
  ## 5.2.2
7
149
 
8
150
  _Jan 6, 2022_
@@ -75,18 +217,11 @@ A big thanks to the 8 contributors who made this release possible. Here are some
75
217
  - [DataGrid] Refactor keyboard/click event management (#3275) @alexfauquette
76
218
  - [DataGrid] Fire change event when the state changes, instead of when the prop changes (#3388) @flaviendelangle
77
219
  - [DataGrid] Unsubscribe event listeners registered in uncommitted renders (#3310) @m4theushw
220
+ - [DataGrid] Rework state update methods and deprecate `useGridApi` and `useGridState` (#3325) @flaviendelangle
78
221
  - [l10n] Improve German (deDE) locale (#3430) @sebastianfrey
79
222
  - [l10n] Improve Hebrew (heIL) locale (#3445) @ColdAtNight
80
223
  - [l10n] Improve Dutch (nlNL) locale (#3429) @jaapjr
81
224
 
82
- ### Core
83
-
84
- - [core] Rework state update methods and deprecate `useGridApi` and `useGridState` (#3325) @flaviendelangle
85
- - [core] Add sections to some of the feature hooks (#3391) @flaviendelangle
86
- - [core] Generate exports snapshot for both `x-data-grid` and `x-data-grid-pro` packages (#3427) @flaviendelangle
87
- - [core] Remove 'x-data-grid' folder from DataGridPro bundle (#3394) @m4theushw
88
- - [core] Add link to OpenCollective (#3392) @oliviertassinari
89
-
90
225
  ### Docs
91
226
 
92
227
  - [docs] Improve pagination documentation page (#3424) @flaviendelangle
@@ -94,6 +229,13 @@ A big thanks to the 8 contributors who made this release possible. Here are some
94
229
  - [docs] Stop using TypeDoc to generate the API documentation (#3320) @flaviendelangle
95
230
  - [docs] Remove column pinning from "Upcoming features" (#3443) @alexfauquette
96
231
 
232
+ ### Core
233
+
234
+ - [core] Add sections to some of the feature hooks (#3391) @flaviendelangle
235
+ - [core] Generate exports snapshot for both `x-data-grid` and `x-data-grid-pro` packages (#3427) @flaviendelangle
236
+ - [core] Remove 'x-data-grid' folder from DataGridPro bundle (#3394) @m4theushw
237
+ - [core] Add link to OpenCollective (#3392) @oliviertassinari
238
+
97
239
  ## 5.2.0
98
240
 
99
241
  _Dec 9, 2021_
@@ -153,6 +295,18 @@ A big thanks to the 5 contributors who made this release possible. Here are some
153
295
  - [DataGrid] Fix `DatePicker` bug by limiting years to 4 digits (#3222) @alexfauquette
154
296
  - [DataGrid] Fix column menu position when closing (#3289) @m4theushw
155
297
  - [DataGrid] Fix to not crash when a sort item uses a non-existing column (#3224) @flaviendelangle
298
+ - [DataGrid] Type the `api` param in callback interfaces (#3315) @flaviendelangle
299
+
300
+ ### Docs
301
+
302
+ - [docs] Always use auto-generated `apiRef` documentation (#3266) @flaviendelangle
303
+ - [docs] Avoid 301 links (#3329) @oliviertassinari
304
+ - [docs] Disable the ad when not MIT (#3334) @oliviertassinari
305
+ - [docs] Fix 404 link to Zendesk @oliviertassinari
306
+ - [docs] Fix dead link on the overview page (#3326) @flaviendelangle
307
+ - [docs] Fix double MUI in the title (#3332) @oliviertassinari
308
+ - [docs] Fix duplicate "the" (#3365) @noam-honig
309
+ - [docs] Update branch to deploy docs (#3321) @m4theushw
156
310
 
157
311
  ### Core
158
312
 
@@ -163,22 +317,10 @@ A big thanks to the 5 contributors who made this release possible. Here are some
163
317
  - [core] Improve tests for Tree Data (#3366) @flaviendelangle
164
318
  - [core] Never import directly from the `__modules__` folder in the `x-data-grid-generator` package (#3379) @flaviendelangle
165
319
  - [core] Transition to a new StackOverflow tag (#3308) @oliviertassinari
166
- - [core] Type the `api` param in callback interfaces (#3315) @flaviendelangle
167
320
  - [core] Update monorepo (#3370) @flaviendelangle
168
321
  - [core] Use pre-processors for sorting and filtering (#3318) @flaviendelangle
169
322
  - [test] Replace `useFakeTimers` (#3323) @m4theushw
170
323
 
171
- ### Docs
172
-
173
- - [docs] Always use auto-generated `apiRef` documentation (#3266) @flaviendelangle
174
- - [docs] Avoid 301 links (#3329) @oliviertassinari
175
- - [docs] Disable the ad when not MIT (#3334) @oliviertassinari
176
- - [docs] Fix 404 link to Zendesk @oliviertassinari
177
- - [docs] Fix dead link on the overview page (#3326) @flaviendelangle
178
- - [docs] Fix double MUI in the title (#3332) @oliviertassinari
179
- - [docs] Fix duplicate "the" (#3365) @noam-honig
180
- - [docs] Update branch to deploy docs (#3321) @m4theushw
181
-
182
324
  ## 5.1.0
183
325
 
184
326
  _Dec 2, 2021_
@@ -310,12 +452,14 @@ A big thanks to the 3 contributors who made this release possible. Here are some
310
452
 
311
453
  ### `@mui/x-data-grid@v5.0.1` / `@mui/x-data-grid-pro@v5.0.1`
312
454
 
313
- #### Changes
314
-
315
455
  - [DataGrid] New API to validate the editing values (#3006) @m4theushw
316
456
  - [DataGrid] Use color-scheme to set dark mode on native components (#3146) @alexfauquette
317
457
  - [DataGrid] Fix the `@mui/x-data-grid` type entrypoint (#3196) @flaviendelangle
318
458
 
459
+ ### Docs
460
+
461
+ - [docs] Move sentence about disabling multi rows selection (#3167) @alexfauquette
462
+
319
463
  ### Core
320
464
 
321
465
  - [core] Drop `useGridContainerProps` (#3007) @flaviendelangle
@@ -324,10 +468,6 @@ A big thanks to the 3 contributors who made this release possible. Here are some
324
468
  - [core] Remove the `index.ts` of the export hooks (#3165) @flaviendelangle
325
469
  - [core] Set the correct release date for v5.0.0 in the CHANGELOG.md (#3192) @flaviendelangle
326
470
 
327
- ### Docs
328
-
329
- - [docs] Move sentence about disabling multi rows selection (#3167) @alexfauquette
330
-
331
471
  ## 5.0.0
332
472
 
333
473
  _Nov 23, 2021_
@@ -1428,6 +1568,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
1428
1568
  - The `onEditCellChange` prop was renamed to `onEditCellPropsChange`.
1429
1569
  - The `onEditCellChangeCommitted` prop was renamed to `onCellEditCommit`.
1430
1570
  - The `onEditRowModelChange` prop was removed. Use the new `onEditRowsModelChange` prop.
1571
+
1431
1572
  ```diff
1432
1573
  -onEditRowModelChange?: (params: GridEditRowModelParams)
1433
1574
  +onEditRowsModelChange?: (editRowsModel: GridEditRowsModel)
@@ -2666,7 +2807,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h
2666
2807
 
2667
2808
  ## [4.0.0-alpha.19](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.18...v4.0.0-alpha.19)
2668
2809
 
2669
- ###### _Feb 5, 2021_
2810
+ _Feb 5, 2021_
2670
2811
 
2671
2812
  Big thanks to the 5 contributors who made this release possible. Here are some highlights ✨:
2672
2813
 
@@ -2709,7 +2850,7 @@ Big thanks to the 5 contributors who made this release possible. Here are some h
2709
2850
 
2710
2851
  ## [4.0.0-alpha.18](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.17...v4.0.0-alpha.18)
2711
2852
 
2712
- ###### _Jan 26, 2021_
2853
+ _Jan 26, 2021_
2713
2854
 
2714
2855
  Big thanks to the 5 contributors who made this release possible. Here are some highlights ✨:
2715
2856
 
@@ -2796,7 +2937,7 @@ Big thanks to the 5 contributors who made this release possible. Here are some h
2796
2937
 
2797
2938
  ## [4.0.0-alpha.17](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.15...v4.0.0-alpha.17)
2798
2939
 
2799
- ###### _Jan 14, 2021_
2940
+ _Jan 14, 2021_
2800
2941
 
2801
2942
  Big thanks to the 4 contributors who made this release possible. Here are some highlights ✨:
2802
2943
 
@@ -2826,7 +2967,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h
2826
2967
 
2827
2968
  ## [4.0.0-alpha.15](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.14...v4.0.0-alpha.15)
2828
2969
 
2829
- ###### _Jan 7, 2021_
2970
+ _Jan 7, 2021_
2830
2971
 
2831
2972
  Big thanks to the 2 contributors who made this release possible. Here are some highlights ✨:
2832
2973
 
@@ -2849,7 +2990,7 @@ Big thanks to the 2 contributors who made this release possible. Here are some h
2849
2990
 
2850
2991
  ## [4.0.0-alpha.14](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.13...v4.0.0-alpha.14)
2851
2992
 
2852
- ###### _Dec 31, 2020_
2993
+ _Dec 31, 2020_
2853
2994
 
2854
2995
  Big thanks to the 5 contributors who made this release possible. Here are some highlights ✨:
2855
2996
 
@@ -2883,7 +3024,7 @@ Big thanks to the 5 contributors who made this release possible. Here are some h
2883
3024
 
2884
3025
  ## [4.0.0-alpha.13](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.12...v4.0.0-alpha.13)
2885
3026
 
2886
- ###### _Dec 16, 2020_
3027
+ _Dec 16, 2020_
2887
3028
 
2888
3029
  Big thanks to the 4 contributors who made this release possible. Here are some highlights ✨:
2889
3030
 
@@ -2912,7 +3053,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h
2912
3053
 
2913
3054
  ## [4.0.0-alpha.12](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.11...v4.0.0-alpha.12)
2914
3055
 
2915
- ###### _Dec 9, 2020_
3056
+ _Dec 9, 2020_
2916
3057
 
2917
3058
  Big thanks to the 6 contributors who made this release possible. Here are some highlights ✨:
2918
3059
 
@@ -2949,7 +3090,7 @@ Big thanks to the 6 contributors who made this release possible. Here are some h
2949
3090
 
2950
3091
  ## [4.0.0-alpha.11](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.10...v4.0.0-alpha.11)
2951
3092
 
2952
- ###### _Dec 2, 2020_
3093
+ _Dec 2, 2020_
2953
3094
 
2954
3095
  Big thanks to the 8 contributors who made this release possible. Here are some highlights ✨:
2955
3096
 
@@ -3007,7 +3148,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3007
3148
 
3008
3149
  ## [4.0.0-alpha.10](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.9...v4.0.0-alpha.10)
3009
3150
 
3010
- ###### _Nov 20, 2020_
3151
+ _Nov 20, 2020_
3011
3152
 
3012
3153
  ### @material-ui/x-grid@v4.0.0-alpha.10 / @material-ui/data-grid@v4.0.0-alpha.10
3013
3154
 
@@ -3029,7 +3170,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3029
3170
 
3030
3171
  ## [4.0.0-alpha.9](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.8...v4.0.0-alpha.9)
3031
3172
 
3032
- ###### _Nov 9, 2020_
3173
+ _Nov 9, 2020_
3033
3174
 
3034
3175
  ### @material-ui/x-grid@v4.0.0-alpha.9 / @material-ui/data-grid@v4.0.0-alpha.9
3035
3176
 
@@ -3067,7 +3208,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3067
3208
 
3068
3209
  ## [4.0.0-alpha.8](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.7...v4.0.0-alpha.8)
3069
3210
 
3070
- ###### _Oct 23, 2020_
3211
+ _Oct 23, 2020_
3071
3212
 
3072
3213
  ### @material-ui/x-grid@v4.0.0-alpha.8 / @material-ui/data-grid@v4.0.0-alpha.8
3073
3214
 
@@ -3084,7 +3225,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3084
3225
 
3085
3226
  ## [4.0.0-alpha.7](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.6...v4.0.0-alpha.7)
3086
3227
 
3087
- ###### _Oct 19, 2020_
3228
+ _Oct 19, 2020_
3088
3229
 
3089
3230
  ### @material-ui/x-grid@v4.0.0-alpha.7 / @material-ui/data-grid@v4.0.0-alpha.7
3090
3231
 
@@ -3113,7 +3254,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3113
3254
 
3114
3255
  ## [4.0.0-alpha.6](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.2...v4.0.0-alpha.6)
3115
3256
 
3116
- ###### _Sep 25, 2020_
3257
+ _Sep 25, 2020_
3117
3258
 
3118
3259
  ### @material-ui/x-grid@v4.0.0-alpha.6 / @material-ui/data-grid@v4.0.0-alpha.6
3119
3260
 
@@ -3130,13 +3271,13 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
3130
3271
 
3131
3272
  ## [4.0.0-alpha.2](https://github.com/mui-org/material-ui-x/compare/v4.0.0-alpha.1...v4.0.0-alpha.2)
3132
3273
 
3133
- ###### _Sep 18, 2020_
3274
+ _Sep 18, 2020_
3134
3275
 
3135
3276
  - [DataGrid] Fix wrongly exported types (#298) @dtassone
3136
3277
 
3137
3278
  ## [4.0.0-alpha.1](https://github.com/mui-org/material-ui-x/compare/v0.1.67...v4.0.0-alpha.1)
3138
3279
 
3139
- ###### _Sep 17, 2020_
3280
+ _Sep 17, 2020_
3140
3281
 
3141
3282
  This is the first public alpha release of the component after 6 months of development since the initial commit (March 15th 2020).
3142
3283
  `@material-ui/data-grid` is licensed under MIT while `@material-ui/x-grid` is licensed under a commercial license.