@mui/x-data-grid 5.0.1 → 5.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +272 -5
  2. package/index-cjs.js +2 -2
  3. package/index-esm.js +2 -2
  4. package/package.json +10 -5
  5. package/themeAugmentation/props.d.ts +1 -1
  6. package/x-data-grid.d.ts +4396 -3548
package/CHANGELOG.md CHANGED
@@ -3,14 +3,281 @@
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.2.2
7
+
8
+ _Jan 6, 2022_
9
+
10
+ A big thanks to the 9 contributors who made this release possible. Here are some highlights ✨:
11
+
12
+ - 🎁 Add `hideable` option to `GridColDef` (#3433) @m4theushw
13
+ - ⚡ Add support for column-based `sortingOrder` with the new `sortingOrder` option in `GridColDef` (#3449) @Quppa
14
+ - ✨ Allow to initialize the `page` and `pageSize` without controlling them with the `initialState` prop (#3495) @flaviendelangle
15
+ - 🙈 Allow to precisely control which children rows to expand with the new `isGroupExpandedByDefault` prop (#3444) @flaviendelangle
16
+ - 🌍 Add Finnish (fiFI) locale (#3485) @kurkle
17
+ - 📚 Documentation improvements
18
+ - 🐞 Bugfixes
19
+
20
+ ### `@mui/x-data-grid@v5.2.2` / `@mui/x-data-grid-pro@v5.2.2`
21
+
22
+ #### Changes
23
+
24
+ - [DataGrid] Add `hideable` option to GridColDef (#3433) @alexfauquette
25
+ - [DataGrid] Add `sortingOrder` to GridColDef (#3449) @Quppa
26
+ - [DataGrid] Add the page and pageSize to the initialState prop (#3495) @flaviendelangle
27
+ - [DataGrid] Avoid re-render when pressing key inside already focused cell (#3484) @m4theushw
28
+ - [DataGrid] Close other actions menus when opening a new one (#3492) @m4theushw
29
+ - [DataGrid] Deprecate `getValue` param from the cell and row params (#3369) @flaviendelangle
30
+ - [DataGrid] Fix value parsing in date input (#3307) @alexfauquette
31
+ - [DataGrid] Fix can't enter 0 on numeric column (#3491) @m4theushw
32
+ - [DataGrid] Fix scrolling bug when an action is focused (#3483) @alexfauquette
33
+ - [DataGrid] Remove `line-height` from `GridCell` (#3446) @DanailH
34
+ - [DataGridPro] Block edition for auto-generated rows (#3547) @flaviendelangle
35
+ - [DataGridPro] Expose the field of the tree data grouping column as a constant (#3549) @flaviendelangle
36
+ - [DataGridPro] Fix resizing of right pinned columns (#3502) @m4theushw
37
+ - [DataGridPro] Add new prop `isGroupExpandedByDefault` (#3444) @flaviendelangle
38
+ - [l10n] Add Finnish (fiFI) locale (#3485) @kurkle
39
+ - [l10n] Improve French (frFR) locale (#3494) @Zenoo
40
+ - [l10n] Improve Italian (itIT) locale (#3452) @destegabry
41
+ - [l10n] Improve Vietnamese (viVN) locale (#3493) @hckhanh
42
+
43
+ ### Docs
44
+
45
+ - [docs] Generate imports dynamically from the packages export list (#3488) @flaviendelangle
46
+ - [docs] Make demos compatible with `preProcessEditCellProps` (#3453) @m4theushw
47
+
48
+ ### Core
49
+
50
+ - [test] Add test for row checkbox toggling using the Space key (#3262) @alexfauquette
51
+ - [core] Increase CI efficiency (#3441) @oliviertassinari
52
+ - [core] Refactor sorting comparator (#3390) @flaviendelangle
53
+ - [core] Update dependency on the core (#3526) @oliviertassinari
54
+ - [core] Update tweet example in release readme (#3481) @DanailH
55
+
56
+ ## 5.2.1
57
+
58
+ _Dec 17, 2021_
59
+
60
+ A big thanks to the 8 contributors who made this release possible. Here are some highlights ✨:
61
+
62
+ - 🖨️ Improve the print export to break the pages correctly (#3302) @flaviendelangle
63
+ - 🎁 Add `pinnable` option to `GridColDef` (#3425) @m4theushw
64
+ - 📚 Documentation improvements
65
+ - 🐞 Bugfixes
66
+
67
+ ### `@mui/x-data-grid@v5.2.1` / `@mui/x-data-grid-pro@v5.2.1`
68
+
69
+ #### Changes
70
+
71
+ - [DataGridPro] Add `pinnable` option (#3425) @m4theushw
72
+ - [DataGridPro] Avoid filtering columns if no column is pinned (#3438) @m4theushw
73
+ - [DataGrid] Avoid page break inside a row in the Print Export (#3302) @flaviendelangle
74
+ - [DataGrid] Fix `GridEditDateCell` to handle `editRowsModel` correctly (#3267) @alexfauquette
75
+ - [DataGrid] Refactor keyboard/click event management (#3275) @alexfauquette
76
+ - [DataGrid] Fire change event when the state changes, instead of when the prop changes (#3388) @flaviendelangle
77
+ - [DataGrid] Unsubscribe event listeners registered in uncommitted renders (#3310) @m4theushw
78
+ - [l10n] Improve German (deDE) locale (#3430) @sebastianfrey
79
+ - [l10n] Improve Hebrew (heIL) locale (#3445) @ColdAtNight
80
+ - [l10n] Improve Dutch (nlNL) locale (#3429) @jaapjr
81
+
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
+ ### Docs
91
+
92
+ - [docs] Improve pagination documentation page (#3424) @flaviendelangle
93
+ - [docs] Include @mui/x-data-grid as dependency in the CodeSandbox (#3396) @m4theushw
94
+ - [docs] Stop using TypeDoc to generate the API documentation (#3320) @flaviendelangle
95
+ - [docs] Remove column pinning from "Upcoming features" (#3443) @alexfauquette
96
+
97
+ ## 5.2.0
98
+
99
+ _Dec 9, 2021_
100
+
101
+ A big thanks to the 5 contributors who made this release possible. Here are some highlights ✨:
102
+
103
+ ### `@mui/x-data-grid@v5.2.0` / `@mui/x-data-grid-pro@v5.2.0`
104
+
105
+ - 🚀 Introduce the [column pinning](https://mui.com/components/data-grid/columns/#column-pinning) feature (#2946) @m4theushw
106
+
107
+ <img src="https://user-images.githubusercontent.com/42154031/145425635-b6314fbe-2f1e-4b73-908f-33ee1fda20c7.gif" width="964" height="657">
108
+
109
+ - 🔥 Add ability to disable export options (#3270) @alexfauquette
110
+
111
+ You can disable either export options by setting `disableToolbarButton` to `true`.
112
+
113
+ ```tsx
114
+ <GridToolbarExport csvOptions={{ disableToolbarButton: true }} />
115
+ ```
116
+
117
+ ```tsx
118
+ <GridToolbarExport printOptions={{ disableToolbarButton: true }} />
119
+ ```
120
+
121
+ - 🙈 Add a new option to hide the amount of descendant on the grouping cells of the Tree Data (#3368) @flaviendelangle
122
+
123
+ ```tsx
124
+ <DataGridPro
125
+ treeData
126
+ rows={rows}
127
+ columns={columns}
128
+ groupingColDef={{ hideDescendantCount }}
129
+ />
130
+ ```
131
+
132
+ - ⚠️ Deprecate the `getValue` param for the `valueGetter` callback (#3314) @flaviendelangle
133
+
134
+ Instead, you can access directly the row in the params
135
+
136
+ ```diff
137
+ -valueGetter: (params) => `${params.getValue(params.id, 'firstName') || ''} ${params.getValue(params.id, 'lastName') || ''}`
138
+ +valueGetter: (params) => `${params.row.firstName || ''} ${params.row.lastName || ''}`
139
+ ```
140
+
141
+ - 📚 Documentation improvements
142
+ - 🐞 Bugfixes
143
+
144
+ #### Changes
145
+
146
+ - [DataGridPro] Add column pinning (#2946) @m4theushw
147
+ - [DataGridPro] Add `hideDescendantCount` option to Tree Data (#3368) @flaviendelangle
148
+ - [DataGridPro] Do not expand row children with <kbd>Shift</kbd> + Space (#3380) @flaviendelangle
149
+ - [DataGridPro] Pass a list of `fields` to the callback version of `groupingColDef` (#3316) @flaviendelangle
150
+ - [DataGrid] Deprecate the `getValue` param for the `valueGetter` callback (#3314) @flaviendelangle
151
+ - [DataGrid] Add ability to disable export options (#3270) @alexfauquette
152
+ - [DataGrid] Filter value are conserved when possible (#3198) @alexfauquette
153
+ - [DataGrid] Fix `DatePicker` bug by limiting years to 4 digits (#3222) @alexfauquette
154
+ - [DataGrid] Fix column menu position when closing (#3289) @m4theushw
155
+ - [DataGrid] Fix to not crash when a sort item uses a non-existing column (#3224) @flaviendelangle
156
+
157
+ ### Core
158
+
159
+ - [core] Add funding field (#3331) @oliviertassinari
160
+ - [core] Fix missing LICENSE file (#3330) @oliviertassinari
161
+ - [core] Fix release month in CHANGELOG (#3367) @m4theushw
162
+ - [core] Fix `yarn prettier` script (#3292) @oliviertassinari
163
+ - [core] Improve tests for Tree Data (#3366) @flaviendelangle
164
+ - [core] Never import directly from the `__modules__` folder in the `x-data-grid-generator` package (#3379) @flaviendelangle
165
+ - [core] Transition to a new StackOverflow tag (#3308) @oliviertassinari
166
+ - [core] Type the `api` param in callback interfaces (#3315) @flaviendelangle
167
+ - [core] Update monorepo (#3370) @flaviendelangle
168
+ - [core] Use pre-processors for sorting and filtering (#3318) @flaviendelangle
169
+ - [test] Replace `useFakeTimers` (#3323) @m4theushw
170
+
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
+ ## 5.1.0
183
+
184
+ _Dec 2, 2021_
185
+
186
+ A big thanks to the 11 contributors who made this release possible. Here are some highlights ✨:
187
+
188
+ ### `@mui/x-data-grid@v5.1.0` / `@mui/x-data-grid-pro@v5.1.0`
189
+
190
+ - 🚀 Introduce the [tree data](https://mui.com/components/data-grid/group-pivot/#tree-data) feature (#2725) @flaviendelangle
191
+
192
+ <img src="https://user-images.githubusercontent.com/42154031/144259216-fc4f90ac-4d8b-4253-bc95-009204349a4c.gif" width="854" height="453" />
193
+
194
+ - 💅 Add support for `sx` prop in the DataGrid and DataGridPro (#3281) @m4theushw
195
+ - 🔦 Improve focus management in the filter panel (#3004) @alexfauquette
196
+ - 🎁 Add strict typing to the event publisher and listener (#3022) (@flaviendelangle)
197
+
198
+ The `apiRef.current.subscribeEvent`, `apiRef.current.publishEvent` and `useGridApiEventHandler` are now fully typed and gives you the correct arguments based on the event you are listening to or emitting.
199
+
200
+ ```ts
201
+ const handleRowClick: GridEventListener<'rowClick'> = (
202
+ params, // has type `GridRowParams`
203
+ event, // has type `MuiEvent<React.MouseEvent<HTMLElement>>
204
+ details, // has type `GridCallbackDetails
205
+ ) => {
206
+ /* ... */
207
+ };
208
+
209
+ // with string event name
210
+ apiRef.current.subscribeEvent('rowClick', handleRowClick);
211
+ useGridApiEventHandler(apiRef, 'rowClick', handleRowClick);
212
+
213
+ // or with enum event name
214
+ apiRef.current.subscribeEvent(GridEvents.rowClick, handleRowClick);
215
+ useGridApiEventHandler(apiRef, GridEvents.rowClick, handleRowClick);
216
+ ```
217
+
218
+ - 🌎 Translation updates for many locales
219
+
220
+ If you are using DataGrid or DataGridPro in another language, check [this issue](https://github.com/mui-org/material-ui-x/issues/3211) to discover which translations are missing.
221
+
222
+ - 📚 Documentation improvements
223
+ - 🐞 Bugfixes
224
+
225
+ #### Changes
226
+
227
+ - [DataGridPro] Add tree data (#2725) @flaviendelangle
228
+ - [DataGridPro] Remove the callback version of the `groupigColDef` prop (#3317) @flaviendelangle
229
+ - [DataGridPro] Improve license file (#3278) @oliviertassinari
230
+ - [DataGridPro] Add types for event publishers and listeners (#3022) @flaviendelangle
231
+ - [DataGrid] Add support for `sx` prop (#3281) @m4theushw
232
+ - [DataGrid] Do not debounce the initial resizing of the grid (#3213) @flaviendelangle
233
+ - [DataGrid] Fix usage of dynamic columns (#3204) @flaviendelangle
234
+ - [DataGrid] Move focus when selecting option with <kbd>Enter</kbd> in the `singleSelect` (#3220) @m4theushw
235
+ - [DataGrid] Focus on the last value input when a filter is added or removed (#3004) @alexfauquette
236
+ - [DataGrid] Prepare the tree structure for grouping sorting / filtering (#3301) @flaviendelangle
237
+ - [DataGrid] Rework keyboard navigation (#3193) @flaviendelangle
238
+ - [DataGrid] Set minimum dimensions to `GridOverlay` when no row is provided (#3261) @flaviendelangle
239
+ - [DataGrid] Improve German (deDE) locale (#3271, #3230, #3293) @sebastianfrey
240
+ - [DataGrid] Improve Hebrew (heIL) locale (#3294) @ColdAtNight
241
+ - [DataGrid] Improve Russian (ruRU) locale (#3290, #3288) @Alim-El
242
+ - [DataGrid] Improve Korean (koKR) locale (#3232, #3273) @zzossig
243
+ - [DataGrid] Improve Greek (elGR) locale (#3169) @clytras
244
+
245
+ ### Core
246
+
247
+ - [core] Add script to sync translation files (#3201) @m4theushw
248
+ - [core] Create dedicated `InputComponent` for `singleSelect` and `date` columns #3227 @alexfauquette
249
+ - [core] Fix `EventManager` to not run listeners removed after registration #3206 @flaviendelangle
250
+ - [core] Group Renovate updates (#3263) @flaviendelangle
251
+ - [core] Reflect the change of default branch (#3235) @oliviertassinari
252
+ - [core] Replace @mui/core with @mui/base (#3217) @m4theushw
253
+ - [core] Split docs generation script (#3189) @flaviendelangle
254
+ - [core] Update monorepo (#3303) @m4theushw
255
+ - [test] Improve testing of the keyboard navigation (#3187) @flaviendelangle
256
+ - [test] Force effect to run on location change (#3283) @m4theushw
257
+ - [core] Rework columns state management (#3264) @flaviendelangle
258
+
259
+ ### Docs
260
+
261
+ - [docs] Improve demo to allow to experiment with `autoHeight` (#3216) @alexfauquette
262
+ - [docs] Fix broken images (#3300) @oliviertassinari
263
+ - [docs] Fix the wrong release date (#3269) @DanailH
264
+ - [docs] Fix typo in CHANGELOG.md (#3214) @gjoseph
265
+ - [docs] Improve plan icon placement (#3298) @oliviertassinari
266
+ - [docs] Improve rows documentation (#3209) @flaviendelangle
267
+ - [docs] Include row pinning (#3191) @oliviertassinari
268
+ - [docs] Fix presentation of key combinations (#3297) @oliviertassinari
269
+ - [docs] Replace @mui/styles on demos (#3274) @m4theushw
270
+ - [docs] Add demos using cell/row editing with server-side persistence (#3124) @flaviendelangle
271
+ - [docs] Use relative links (#3299) @oliviertassinari
272
+
6
273
  ## 5.0.1
7
274
 
8
- _Nov 17, 2021_
275
+ _Nov 23, 2021_
9
276
 
10
277
  A big thanks to the 3 contributors who made this release possible. Here are some highlights ✨:
11
278
 
12
279
  - 🎁 New API to validate the editing values (#3006) @m4theushw
13
-
280
+
14
281
  You can now use the `preProcessEditCellProps` key in `GridColDef` to synchronously or asynchronously validate the values committed.
15
282
 
16
283
  ```ts
@@ -63,9 +330,9 @@ A big thanks to the 3 contributors who made this release possible. Here are some
63
330
 
64
331
  ## 5.0.0
65
332
 
66
- _Nov 16, 2021_
333
+ _Nov 23, 2021_
67
334
 
68
- 🎉 We are execited to introduce [MUI X v5.0.0](https://mui.com/blog/mui-x-v5/) 🎉!
335
+ 🎉 We are excited to introduce [MUI X v5.0.0](https://mui.com/blog/mui-x-v5/) 🎉!
69
336
 
70
337
  If you want to migrate the DataGrid or DataGridPro from v4 to v5, take a look at the [migration guide](https://mui.com/components/data-grid/migration-v4/).
71
338
  This version is fully compatible with `@mui/material@5.X` and can be used with `@material-ui/core@4.x` with some [additional steps](https://mui.com/components/data-grid/migration-v4/#using-mui-x-v5-with-mui-core-v4).
@@ -383,7 +650,7 @@ A big thanks to the 5 contributors who made this release possible. Here are some
383
650
  - [DataGrid] Remove the `state` prop and use the `initialState` prop (#2848) @flaviendelangle
384
651
 
385
652
  Note that `initialState` only allows the `preferencePanel`, `filter.filterModel` and `sort.sortModel` keys.
386
- To fully control the state, use the the feature's model prop and change callback (e.g. `filterModel` and `onFilterModelChange`).
653
+ To fully control the state, use the feature's model prop and change callback (e.g. `filterModel` and `onFilterModelChange`).
387
654
 
388
655
  ```diff
389
656
  <DataGrid