Skip to content

Commit f9222c0

Browse files
committed
docs: improve migration docs and fix some typos
1 parent e3b7f4c commit f9222c0

5 files changed

Lines changed: 92 additions & 27 deletions

File tree

docs/migrations/migration-to-9.x.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Embracing ESM-only builds ⚡
22

3-
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder), this will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is becoming a single execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot any wrapper, etc... will be so much easier to handle). Now Slickgrid-Universal name totally makes sense with this new structure change. 🌐
3+
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder). This change will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is now a single click execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot all wrappers, etc... will be so much easier to handle). With this new structure change, Slickgrid-Universal name is now making even more sense. 🌐
4+
5+
The other great thing about having everything under the same roof/project is that every package will now be released at the same time with the exact same version number across the board. Everything will be released under v9.0 and whenever any new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
46

57
Wait, what happened to version 6 to 8?
68

79
I'm skipping versions 6-8 and going straight to v9.0 because some of the wrappers (Angular-Slickgrid, Aurelia-Slickgrid) were already at v8.x and so the next available major version bump for everyone is v9.0
810

9-
The other great thing about having everything under the same roof/project is that every package will be released at the exact same time with the exact same versions across the board. Everything will be released under v9.0 and whenever a new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
10-
1111
#### Major Changes - Quick Summary
1212
- minimum requirements bump
1313
- Node v20+
@@ -173,9 +173,9 @@ Below are a list of Enums being deprecated and you should think about migrating
173173
| | `SortDirection.DESC` | `'DESC'` or `'desc'` |
174174
| - | - | - |
175175

176-
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as `options`
176+
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as simply `options`
177177

178-
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if need be). You can start using `options` in v9.0 and above.
178+
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if you wanted). You can start using `options` in v9.0 and above (or keep using `editorOptions`, `filterOptions`).
179179

180180
```diff
181181
import { type MultipleSelectOption } from '@slickgrid-universal/common';
@@ -195,4 +195,17 @@ columnDefinitions = [{
195195
} as MultipleSelectOption,
196196
}
197197
}];
198+
199+
// or reuse the same `options`
200+
+ const msOptions = { maxHeight: 250, useSelectOptionLabelToHtml: true } as MultipleSelectOption;
201+
202+
columnDefinitions = [{
203+
id: 'duration', field: 'duration', name: 'Duration',
204+
editor: {
205+
+ options: msOptions,
206+
},
207+
filter: {
208+
+ options: msOptions,
209+
},
210+
}];
198211
```

frameworks/angular-slickgrid/docs/migrations/migration-to-9.x.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Embracing ESM-only builds ⚡
22

3-
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder), this will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is becoming a single execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot any wrapper, etc... will be so much easier to handle). Now Slickgrid-Universal name totally makes sense with this new structure change 🌐
3+
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder). This change will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is now a single click execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot all wrappers, etc... will be so much easier to handle). With this new structure change, Slickgrid-Universal name is now making even more sense. 🌐
44

5-
The other great thing about having everything under the same roof/project is that every package will be released at the exact same time with the exact same versions across the board. Everything will be released under v9.0 and whenever a new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
5+
The other great thing about having everything under the same roof/project is that every package will now be released at the same time with the exact same version number across the board. Everything will be released under v9.0 and whenever any new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
66

77
I also decided to align all SlickGrid examples in all frameworks and Angular-Slickgrid turned out to have many example offsets, so just be aware that the example numbering might have changed a little (ie: Row Detail is now Example 19 instead of 21).
88

@@ -194,9 +194,9 @@ Below are a list of Enums being deprecated and you should think about migrating
194194
| | `SortDirection.DESC` | `'DESC'` or `'desc'` |
195195
| - | - | - |
196196

197-
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as `options`
197+
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as simply `options`
198198

199-
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if need be). You can start using `options` in v9.0 and above.
199+
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if you wanted). You can start using `options` in v9.0 and above (or keep using `editorOptions`, `filterOptions`).
200200

201201
```diff
202202
import { type MultipleSelectOption } from '@slickgrid-universal/common';
@@ -216,4 +216,17 @@ columnDefinitions = [{
216216
} as MultipleSelectOption,
217217
}
218218
}];
219+
220+
// or reuse the same `options`
221+
+ const msOptions = { maxHeight: 250, useSelectOptionLabelToHtml: true } as MultipleSelectOption;
222+
223+
columnDefinitions = [{
224+
id: 'duration', field: 'duration', name: 'Duration',
225+
editor: {
226+
+ options: msOptions,
227+
},
228+
filter: {
229+
+ options: msOptions,
230+
},
231+
}];
219232
```

frameworks/aurelia-slickgrid/docs/migrations/migration-to-9.x.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Embracing ESM-only builds ⚡
22

3-
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder), this will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is becoming a single execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot any wrapper, etc... will be so much easier to handle). Now Slickgrid-Universal name totally makes sense with this new structure change 🌐
3+
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder). This change will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is now a single click execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot all wrappers, etc... will be so much easier to handle). With this new structure change, Slickgrid-Universal name is now making even more sense. 🌐
44

5-
The other great thing about having everything under the same roof/project is that every package will be released at the exact same time with the exact same versions across the board. Everything will be released under v9.0 and whenever a new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
5+
The other great thing about having everything under the same roof/project is that every package will now be released at the same time with the exact same version number across the board. Everything will be released under v9.0 and whenever any new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
66

77
#### Major Changes - Quick Summary
88
- minimum requirements bump
@@ -195,14 +195,14 @@ Below are a list of Enums being deprecated and you should think about migrating
195195
| | `SortDirection.DESC` | `'DESC'` or `'desc'` |
196196
| - | - | - |
197197

198-
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as `options`
198+
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as simply `options`
199199

200-
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if need be). You can start using `options` in v9.0 and above.
200+
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if you wanted). You can start using `options` in v9.0 and above (or keep using `editorOptions`, `filterOptions`).
201201

202202
```diff
203203
import { type MultipleSelectOption } from '@slickgrid-universal/common';
204204

205-
this.columnDefinitions = [{
205+
columnDefinitions = [{
206206
id: 'duration', field: 'duration', name: 'Duration',
207207
editor: {
208208
- editorOptions: {
@@ -217,4 +217,17 @@ this.columnDefinitions = [{
217217
} as MultipleSelectOption,
218218
}
219219
}];
220+
221+
// or reuse the same `options`
222+
+ const msOptions = { maxHeight: 250, useSelectOptionLabelToHtml: true } as MultipleSelectOption;
223+
224+
columnDefinitions = [{
225+
id: 'duration', field: 'duration', name: 'Duration',
226+
editor: {
227+
+ options: msOptions,
228+
},
229+
filter: {
230+
+ options: msOptions,
231+
},
232+
}];
220233
```

frameworks/slickgrid-react/docs/migrations/migration-to-9.x.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Embracing ESM-only builds ⚡
22

3-
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder), this will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is becoming a single execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot any wrapper, etc... will be so much easier to handle). Now Slickgrid-Universal name totally makes sense with this new structure change 🌐
3+
This new release is focused around 2 things, we now ship ESM-only builds (in other words, CommonJS builds are fully dropped and only ESM will remain), this move will cut the npm download size by half. The other big change is an internal one which is an organizational one, I'm moving all framework wrappers directly into Slickgrid-Universal (Angular, Aurelia, React and Vue wrappers are now all located under the [frameworks/](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/) folder). This change will help tremendously with the project maintenance (any new PR will now run against all frameworks all at once (catching bugs early), publishing a new version is now a single click execution for all frameworks all at once, and finally having a single codebase to test & troubleshoot all wrappers, etc... will be so much easier to handle). With this new structure change, Slickgrid-Universal name is now making even more sense. 🌐
4+
5+
The other great thing about having everything under the same roof/project is that every package will now be released at the same time with the exact same version number across the board. Everything will be released under v9.0 and whenever any new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
46

57
Wait, what happened to version 6 to 8?
68

79
I'm skipping versions 6-8 and going straight to v9.0 because some of the wrappers (Angular-Slickgrid, Aurelia-Slickgrid) were already at v8.x and so the next available major version bump for everyone is v9.0
810

9-
The other great thing about having everything under the same roof/project is that every package will be released at the exact same time with the exact same versions across the board. Everything will be released under v9.0 and whenever a new feature/bugfix comes in, then every package will be bumped to v9.1 and so on (no more version discrepancies).
10-
1111
#### Major Changes - Quick Summary
1212
- minimum requirements bump
1313
- React v19+
@@ -221,14 +221,14 @@ Below are a list of Enums being deprecated and you should think about migrating
221221
| | `SortDirection.DESC` | `'DESC'` or `'desc'` |
222222
| - | - | - |
223223

224-
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as `options`
224+
##### deprecating `editorOptions` and `filterOptions`, they are being renamed as simply `options`
225225

226-
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if need be). You can start using `options` in v9.0 and above.
226+
in order to make it easier to merge and simplify editor/filter options, I'm renaming the options to a single `options` property which will make it more easily transportable (you will be able to reuse the same `options` for both the editor/filter if you wanted). You can start using `options` in v9.0 and above (or keep using `editorOptions`, `filterOptions`).
227227

228228
```diff
229229
import { type MultipleSelectOption } from '@slickgrid-universal/common';
230230

231-
setColumns([{
231+
columnDefinitions = [{
232232
id: 'duration', field: 'duration', name: 'Duration',
233233
editor: {
234234
- editorOptions: {
@@ -242,5 +242,18 @@ setColumns([{
242242
maxHeight: 250, useSelectOptionLabelToHtml: true,
243243
} as MultipleSelectOption,
244244
}
245-
}]);
245+
}];
246+
247+
// or reuse the same `options`
248+
+ const msOptions = { maxHeight: 250, useSelectOptionLabelToHtml: true } as MultipleSelectOption;
249+
250+
columnDefinitions = [{
251+
id: 'duration', field: 'duration', name: 'Duration',
252+
editor: {
253+
+ options: msOptions,
254+
},
255+
filter: {
256+
+ options: msOptions,
257+
},
258+
}];
246259
```

0 commit comments

Comments
 (0)