Skip to content

Commit eb7a588

Browse files
committed
docs: improve some docs and migration guides
1 parent 839e0a8 commit eb7a588

10 files changed

Lines changed: 22 additions & 21 deletions

File tree

docs/TOC.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363
* [Grid State & Presets](grid-functionalities/grid-state-preset.md)
6464
* [Grouping & Aggregators](grid-functionalities/grouping-aggregators.md)
6565
* [Header Menu & Header Buttons](grid-functionalities/header-menu-header-buttons.md)
66-
* [Header & Footer Slots](grid-functionalities/header-footer-slots.md)
6766
* [Custom Menu Slots](grid-functionalities/menu-slots.md)
6867
* [Pagination](grid-functionalities/pagination.md)
6968
* [Infinite Scroll](grid-functionalities/infinite-scroll.md)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ I recently found that some of the internal icons were wrongly using the `mdi-` p
8787

8888
### Auto-Enabled External Resources
8989

90-
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped and yours will prevail. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
90+
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
9191

9292
- ExcelExportService → `enableExcelExport: true`
9393
- PdfExportService → `enablePdfExport: true`
@@ -97,7 +97,7 @@ This change does not require any code change from the end user, but it is noneth
9797

9898
### Menu with Commands (slot renderer)
9999

100-
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and maybe override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
100+
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and even override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
101101

102102
The props above are currently tagged as deprecations in v10.x but it's strongly recommended to start using the new `commandListBuilder` and/or `hideCommands` to move away from the deprecated properties which will be removed in v11.x (next year). For example if we want to hide some built-in commands:
103103

frameworks/angular-slickgrid/docs/getting-started/quick-start.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,10 @@ The last step is really to explore all the pages that are available in the docum
257257
... and much more, just explore the Documentation through all the available pages.
258258

259259
### 9. How to load data with `HttpClient`?
260-
You might notice that all demos are made with mocked dataset that are embedded in each examples, that is mainly for demo purposes, but you might be wondering how to connect this with an `HttpClient`? Easy... just replace the mocked data assignment to the `dataset` property with your `HttpClient` call and that's it. Basically, the `dataset` property can be changed at any time, which is why you can use local data and/or connect it to a `Promise` or an `Observable` with `HttpClient` (internally it's just a SETTER that refreshes the grid). See [Example 22](https://ghiscoding.github.io/angular-slickgrid-demos/#/example22) for a demo showing how to load a JSON file with `HttpClient`.
260+
You might notice that all demos are made with mocked dataset that are embedded in each examples, that is mainly for demo purposes, but you might be wondering how to connect this with an `HttpClient`? Easy... just replace the mocked data assignment to the `dataset` property with your `HttpClient` call and that's it. Basically, the `dataset` property can be changed at any time, which is why you can use local data and/or connect it to a `Promise` or an `Observable` with `HttpClient` (internally it's just a SETTER that refreshes the grid). See [Example 22](https://ghiscoding.github.io/angular-slickgrid-demos/#/example22) for a demo showing how to load a JSON file with `HttpClient`. If you're using Signal, then just use `[dataset]="dataset()"` and that's it, any changes to the dataset will automatically flow to the grid.
261261

262262
### 10. Live Demo - Clone the Examples
263-
The best way to get started is to clone the [Angular-Slickgrid-demos](https://github.com/ghiscoding/angular-slickgrid-demos), it has multiple examples and it is also updated frequently since it is used for the GitHub Bootstrap 5 live demo page.
263+
The best way to get started is to clone the [Angular-Slickgrid-demos](https://github.com/ghiscoding/angular-slickgrid-demos), it has multiple examples and it is also updated frequently since it is used for the GitHub live demo page.
264264

265265
##### All Live Demo Examples have links to the actual code
266266
If you would like to inspect the code from a particular Example, just click on the "see code" (top right) which is available in all live demo examples.
@@ -277,8 +277,8 @@ Visit the [Troubleshooting](troubleshooting.md) section for more common errors.
277277
### 14. Having some issues?
278278

279279
After reading all this Getting Started guide, then what if you have an issue with the grid?
280-
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and we'll try to help.
280+
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and I'll try to help.
281281

282282
### Final word
283283

284-
This project is Open Source and is, for the most part, mainly done in my spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks so... That is it, thank you and don't forget to the project if you like the lib 😉
284+
This project is Open Source and is, for the most part, mainly done in spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks... That is it, and please don't forget to upvote the project if you like and if it's useful to you⭐ thank you 😉

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ I recently found that some of the internal icons were wrongly using the `mdi-` p
191191

192192
### Auto-Enabled External Resources
193193

194-
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped and yours will prevail. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
194+
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
195195

196196
- ExcelExportService → `enableExcelExport: true`
197197
- PdfExportService → `enablePdfExport: true`
@@ -201,7 +201,7 @@ This change does not require any code change from the end user, but it is noneth
201201

202202
### Menu with Commands (slot renderer)
203203

204-
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and maybe override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
204+
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and even override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
205205

206206
The props above are currently tagged as deprecations in v10.x but it's strongly recommended to start using the new `commandListBuilder` and/or `hideCommands` to move away from the deprecated properties which will be removed in v11.x (next year). For example if we want to hide some built-in commands:
207207

frameworks/aurelia-slickgrid/docs/getting-started/quick-start.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,8 @@ What if `Aurelia-Slickgrid` is missing feature(s) versus the original `SlickGrid
156156
### 13. Having some issues?
157157

158158
After reading all this Getting Started guide, then what if you have an issue with the grid?
159-
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and we'll try to help.
159+
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and I'll try to help.
160160

161161
### Final word
162-
This project is Open Source and is, for the most part, mainly done in spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks... That is it, thank you and don't forget to ⭐ it if you like the lib 😉
162+
163+
This project is Open Source and is, for the most part, mainly done in spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks... That is it, and please don't forget to upvote the project if you like and if it's useful to you⭐ thank you 😉

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ I recently found that some of the internal icons were wrongly using the `mdi-` p
108108

109109
### Auto-Enabled External Resources
110110

111-
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped and yours will prevail. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
111+
This change does not require any code change from the end user, but it is nonetheless a change to be aware of. The reason I decided to implement this one, is that even myself I often forget to enable the associated resource flags and I would assume that if you want to load the resource then it's probably because you want to use it, so... auto-enabling the resource(s) makes sense. For example, if your register `ExcelExportService` then the library will now auto-enable the resources with their associated flags (which in this case is `enableExcelExport:true`)... unless you have already enabled/disabled the flag yourself, then in that case the internal assignment will simply be skipped. Also just to be clear, the list of auto-enabled external resources is rather small and so it will auto-enable the following resources:
112112

113113
- ExcelExportService → `enableExcelExport: true`
114114
- PdfExportService → `enablePdfExport: true`
@@ -118,7 +118,7 @@ This change does not require any code change from the end user, but it is noneth
118118

119119
### Menu with Commands (slot renderer)
120120

121-
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and maybe override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
121+
All menu plugins (Cell Menu, Context Menu, Header Menu and Grid Menu) now have a new UI feature `commandListBuilder: (items) => items` which is now allowing you to filter/sort and even override built-in commands rendering. With this new feature in place, I can deprecate all `hide...` properties and also `positionOrder` since you can now do this with the new builder. You could also use a new `hideCommands` which accepts an array of built-in command names. This will remove a large amount of `hide...` properties (about 30) that keeps increasing anytime a new built-in command gets added (in other words, this will simplify maintenance for both you and me).
122122

123123
The props above are currently tagged as deprecations in v10.x but it's strongly recommended to start using the new `commandListBuilder` and/or `hideCommands` to move away from the deprecated properties which will be removed in v11.x (next year). For example if we want to hide some built-in commands:
124124

frameworks/slickgrid-react/docs/getting-started/quick-start.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,8 @@ What if `Slickgrid-React` is missing feature(s) versus the original `SlickGrid`?
148148
### 11. Having some issues?
149149

150150
After reading all this Getting Started guide, then what if you have an issue with the grid?
151-
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and we'll try to help.
151+
Please start by searching any related [issues](https://github.com/ghiscoding/slickgrid-universal/issues). If you can't find anything in the issues filder and you also made sure to also look through the multiple Documentation pages as well, then go ahead and fill in a [new issue](https://github.com/ghiscoding/slickgrid-universal/issues/new) and I'll try to help.
152152

153153
### Final word
154-
This project is Open Source and is, for the most part, mainly done in spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks... That is it, thank you and don't forget to ⭐ it if you like the lib 😉
154+
155+
This project is Open Source and is, for the most part, mainly done in spare time. So please be respectful when creating issues (and fill in the issue template) and I will try to help you out. If you like my work, you can also [buy me a coffee](https://ko-fi.com/ghiscoding) ☕️, some part of the code happens when I'm at StarBucks... That is it, and please don't forget to upvote the project if you like and if it's useful to you⭐ thank you 😉

0 commit comments

Comments
 (0)