Skip to content
This repository was archived by the owner on Jun 1, 2025. It is now read-only.

Commit 8f0a061

Browse files
authored
docs: review basic usage docs
1 parent d4c1168 commit 8f0a061

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,20 @@ import { type Column, type GridOption } from 'angular-slickgrid';
4040

4141
export class GridComponent implements OnInit {
4242
columnDefinitions: Column[] = [];
43-
gridOptions!: GridOption;
44-
dataset!: any[];
43+
gridOptions: GridOption;
44+
dataset: any[] = [];
4545

4646
onInit() {
4747
this.columnDefinitions = [
48-
{ id: 'username', name: 'Username', field: 'username'},
48+
{ id: 'firstName', name: 'First Name', field: 'firstName'},
49+
{ id: 'lastName', name: 'Last Name', field: 'lastName'},
4950
{ id: 'age', name: 'Age', field: 'age' }
5051
];
51-
this.gridOptions = { /*...*/ };
5252
this.dataset = [
53-
{ id: 1, username: 'John', age: 20 },
54-
{ id: 2, username: 'Jane', age: 21 }
53+
{ id: 1, firstName: 'John', lastName: 'Doe', age: 20 },
54+
{ id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }
5555
];
56+
this.gridOptions = { /*...*/ }; // optional grid options
5657
}
5758
}
5859
```
@@ -67,19 +68,20 @@ export class GridComponent implements OnInit {
6768
### Troubleshooting
6869

6970
> [!WARNING]
70-
> 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)
71+
> Because of its use of native Custom Event, this project **does not** work well with `strictTemplates`, 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)
7172
7273
### Styling Themes
7374

7475
Multiple styling themes are available
76+
- Default (UI agnostic)
7577
- Bootstrap (see all Angular-Slickgrid [live demos](https://ghiscoding.github.io/Angular-Slickgrid/))
7678
- Material (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example07))
7779
- Salesforce (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example16))
7880

79-
Also note that all of these themes also have **Dark Theme** equivalent and even though Bootstrap if often used as the default, it also works well with any other UI framework like Bulma, Material, ...
81+
Also note that all of these themes also have **Dark Theme** equivalent and even though Bootstrap is often used for live demos, it does work as well with any other UI framework like Bulma, Material, ...
8082

8183
### Demo page
82-
`Angular-Slickgrid` works with all `Bootstrap` versions, you can see a demo of each one below. It also works well with any other frameworks like Material or Bulma and there are also couple of extra styling themes based on Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/angular-slickgrid/styling/svg-icons)
84+
`Angular-Slickgrid` works with all `Bootstrap` versions, you can see a demo of each one below. It also works well with any other frameworks like Material or Bulma and there are also couple of extra styling themes based on Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/angular-slickgrid/styling/svg-icons) for more info.
8385

8486
[Angular-Slickgrid-Demos](https://github.com/ghiscoding/angular-slickgrid-demos) includes the following:
8587
- [Bootstrap 5 demo](https://ghiscoding.github.io/Angular-Slickgrid) / [examples repo](https://github.com/ghiscoding/angular-slickgrid-demos/tree/master/bootstrap5-demo-with-translate) - Code samples which uses `ngx-translate` to support multiple locales.
@@ -101,14 +103,14 @@ You like to use **Angular-Slickgrid**? Be sure to upvote ⭐ and maybe support m
101103
<a href='https://ko-fi.com/ghiscoding' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
102104

103105
### Contributions
104-
If you wish to contribute then make sure to follow the steps shown in the [CONTRIBUTING](https://github.com/ghiscoding/Angular-Slickgrid/blob/master/CONTRIBUTING.md) guide.
106+
If you wish to contribute, please make sure to follow the steps shown in the [CONTRIBUTING](https://github.com/ghiscoding/Angular-Slickgrid/blob/master/CONTRIBUTING.md) guide.
105107

106108
## Latest News & Releases
107109
Check out the [Releases](https://github.com/ghiscoding/Angular-Slickgrid/releases) section for all latest News & Releases.
108110

109111
## Angular Compatibility
110112

111-
> **Note** please be aware that only the latest version of Angular-Slickgrid is supported and will receive bug fixes. The reason older versions are not supported is simply because it's already a lot of work to maintain for a single developer.
113+
> **Note** please be aware that only the latest major version of Angular-Slickgrid is supported and will receive bug fixes. It's already a lot of work for a single developer like me to support.
112114
113115
| Angular-Slickgrid | Angular version | Migration Guide | Notes |
114116
|-------------------|-----------------|-----------------|-------|

0 commit comments

Comments
 (0)