angular-slickgrid 8.10.2 → 8.12.0

package/README.md

@@ -33,10 +33,41 @@ A good starting point is the **[Docs - Quick Start](https://ghiscoding.gitbook.i
 npm install angular-slickgrid
 ```
 
+#### Basic Grid
+
+```ts
+import { type Column, type GridOption } from 'angular-slickgrid';
+
+export class GridComponent implements OnInit {
+  columnDefinitions: Column[] = [];
+  gridOptions!: GridOption;
+  dataset!: any[];
+
+  onInit() {
+    this.columnDefinitions = [
+      { id: 'username', name: 'Username', field: 'username'},
+      { id: 'age', name: 'Age', field: 'age' }
+    ];
+    this.gridOptions = { /*...*/ };
+    this.dataset = [
+      { id: 1, username: 'John', age: 20 },
+      { id: 2, username: 'Jane', age: 21 }
+    ];
+  }
+}
+```
+
+```html
+<angular-slickgrid gridId="grid2"
+    [columnDefinitions]="columnDefinitions"
+    [gridOptions]="gridOptions"
+    [dataset]="dataset">
+</angular-slickgrid>
+```
 ### Troubleshooting
 
 > [!WARNING]
-> This project **does not** work well with `strictTemplates` because of its use of native Custom Event, so please make sure to either `strictTemplates` or cast your event as `any` (see this [discussion](https://github.com/ghiscoding/Angular-Slickgrid/discussions/815) for more info)
+> This project **does not** work well with `strictTemplates` because of its use of native Custom Event, so please make sure to either disable `strictTemplates` or cast your event as `any` (see this [discussion](https://github.com/ghiscoding/Angular-Slickgrid/discussions/815) for more info)
 
 ### Styling Themes
 
@@ -114,3 +145,27 @@ Slickgrid-Universal has **100%** Unit Test Coverage and all Angular-Slickgrid Ex
 - [Angular 12 with WebPack 5 - how to fix polyfill error](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Versions-Compatibility-Table#angular-12-with-webpack-5---how-to-fix-polyfill-error)
 - [`ngcc` Build Warnings (Angular >=8.0 && <16.0)](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Versions-Compatibility-Table#ngcc-build-warnings-angular-80--160)
 - [`strictTemplates` error](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Versions-Compatibility-Table#stricttemplates-error)
+
+## Sponsors
+
+<div>
+  <span>
+    <a href="https://github.com/wundergraph" class="Link" title="Wundergraph" target="_blank"><img src="https://avatars.githubusercontent.com/u/64281914" width="50" height="50" valign="middle" /></a>
+  </span>
+  &nbsp;
+  <span>
+    <a href="https://github.com/johnsoncodehk" class="Link" title="johnsoncodehk (Volar)" target="_blank"><img src="https://avatars.githubusercontent.com/u/16279759" width="50" height="50" valign="middle" /></a>
+  </span>
+   &nbsp;
+  <span>
+    <a href="https://github.com/kevinburkett" class="Link" title="kevinburkett" target="_blank"><img class="circle avatar-user" src="https://avatars.githubusercontent.com/u/48218815?s=52&amp;v=4" width="45" height="45" valign="middle" /></a>
+  </span>
+  &nbsp;
+  <span>
+    <a href="https://github.com/anton-gustafsson" class="Link" title="anton-gustafsson" target="_blank"><img src="https://avatars.githubusercontent.com/u/22906905?s=52&v=4" width="50" height="50" valign="middle" /></a>
+  </span>
+  &nbsp;
+  <span>
+    <a href="https://github.com/gibson552" class="Link" title="gibson552" target="_blank"><img src="https://avatars.githubusercontent.com/u/84058359?s=52&v=4" width="50" height="50" valign="middle" /></a>
+  </span>
+</div>