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

Commit 379a684

Browse files
Ghislain BeaulacGhislain Beaulac
authored andcommitted
update readme with demo link
1 parent a3c579f commit 379a684

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@
77
One of the best javascript datagrid [SlickGrid](https://github.com/mleibman/SlickGrid) which was originally developed by @mleibman is now available to Angular. I have used a few datagrids and slickgrid beats most of them in terms of functionalities and performance (it can easily deal with even a million row).
88

99
### Angular Compatibility
10-
- version `1.x.x` for Angular 4 to 6 (*ng6, need `rxjs-compat` as shown in this [post](https://github.com/ghiscoding/Angular-Slickgrid/issues/36#issuecomment-395710915))
10+
- version `1.x.x` for Angular 4 to 6
11+
- Angular 6, is only supported through `rxjs-compat` as shown in this [post](https://github.com/ghiscoding/Angular-Slickgrid/issues/36#issuecomment-395710915). It's preferable to upgrade to Angular 7+ as soon as possible.
1112
- version `2.x.x` for Angular 7+
1213

1314
### SlickGrid Source
14-
We will be using [6pac SlickGrid fork](https://github.com/6pac/SlickGrid/) (the most active fork since the original @mleibman fork was closed some time ago by his author personal reasons).
15+
We will be using [6pac SlickGrid fork](https://github.com/6pac/SlickGrid/), this the most active fork since the original @mleibman fork was closed some time ago by his author personal reasons. Also worth to know, I also contributed a lot to that fork to benefit Angular-Slickgrid.
1516

1617
### Goal
1718
The goal is of course to be able to run SlickGrid within Angular 4+ but also to incorporate as much as possible the entire list of functionalities (and more) that SlickGrid offers (you can see a vast list of samples on the [6pac SlickGrid examples](https://github.com/6pac/SlickGrid/wiki/Examples) website).
@@ -21,10 +22,13 @@ The goal is of course to be able to run SlickGrid within Angular 4+ but also to
2122
- [Bootstrap 3 demo](https://ghiscoding.github.io/Angular-Slickgrid) / [examples repo](https://github.com/ghiscoding/Angular-Slickgrid/tree/master/src/app/examples)
2223
- [Bootstrap 4 demo](https://ghiscoding.github.io/angular-slickgrid-bs4-demo) / [examples repo](https://github.com/ghiscoding/angular-slickgrid-bs4-demo/tree/master/src/app/examples)
2324

25+
#### Working Demo
26+
For a complete and working demo, you can clone the [Angular-Slickgrid Bootstrap 4](https://github.com/ghiscoding/angular-slickgrid-bs4-demo) repository. That repo is updated frequently and is the actual [Bootstrap 4 demo](https://ghiscoding.github.io/angular-slickgrid-bs4-demo).
27+
2428
#### Material Theme
2529
Technically speaking, `Material` theme is not provided, but it should still work.
26-
The styling might need some adjustments to make it look like `Material` but there's over 200+ [SASS variables](https://github.com/ghiscoding/Angular-Slickgrid/blob/master/dist/styles/sass/_variables.scss),
27-
so I'm sure making a theme is doable and if you do, please, please contribute it as a new theme to the project. Thank you.
30+
The styling might need some adjustments to make it look like `Material` but there's over 300+ [SASS variables](https://github.com/ghiscoding/Angular-Slickgrid/blob/master/dist/styles/sass/_variables.scss),
31+
so I'm sure making a Material Theme is totally doable and if you do, please contribute it as a new theme to the project. Thank you.
2832

2933
### NPM Package
3034
[Angular-Slickgrid on NPM](https://www.npmjs.com/package/angular-slickgrid)
@@ -38,29 +42,29 @@ The Wiki is where all the documentation and instructions will go, so please cons
3842
## Main features
3943
You can see some screenshots below and the instructions down below.
4044

41-
This is a work in progress, but so far here are some of the features that `angular-slickgrid` brings (on top of Slickgrid itself):
45+
See a quick look at the features that `angular-slickgrid` brings (on top of Slickgrid itself):
4246
- Easier use of SlickGrid within `Angular` as it is just a component (simply pass a column definitions and a dataset and you're good to go)
43-
- Bootstrap Theme with SASS variables for extra customization (if you create a theme, then please make a PR)
47+
- Bootstrap Theme with SASS variables for extra customization (if you create a new theme, then please make a PR)
4448
- Auto-resize (boolean flag), will resize the datagrid viewport with available space even on browser resize (basically takes available space of it's container)
45-
- Inline Editors (number, float, text, longText, date, ... you can also create your own custom ones)
46-
- Formatters to display something different in UI, for example a boolean flag can be shown as a Font-Awesome checkmark icon
47-
- Filters (input text, select, multi-select, single-select & even custom filter)
49+
- Inline Editors (number, float, text, longText, date picker, ... you can also create your own custom ones)
50+
- Formatters to display something different in UI. For example, a boolean flag can be shown as a Font-Awesome checkmark icon
51+
- Filters & Compound Filters (input text, single & multi select, slider, auto-complete, & even custom filter)
4852
- input text also support operators at the beginning of the input text:
4953
- `<`, `<=`, `>`, `>=`, `<>`, `!=`, `==`, `*`
5054
- `*` can be used for startsWith and endsWith
5155
- Grouping & Aggregators
56+
- Grouping by Column Dragging
5257
- Support all the SlickGrid [Controls](https://github.com/6pac/SlickGrid/tree/master/controls) and [Plugins](https://github.com/6pac/SlickGrid/tree/master/plugins)
5358
- Row(s) Selection
59+
- Row Detail View
5460
- Server side (backend) Services (filtering, sorting, pagination)
5561
- [GraphQL](https://github.com/ghiscoding/Angular-Slikgrid/wiki/GraphQL)
5662
- [OData](https://github.com/ghiscoding/Angular-Slickgrid/wiki/OData)
5763
- Some Features of SlickGrid itself which are working out of the gate
58-
- Sort/Multi-Sort (client/server side)
59-
- Header Row with Filters (currently support `Input` and `Select` dropdown, multi-select is planned)
6064
- Formatters (a few default ones were added, and you can easily create custom ones too)
6165
- Optimized DataView which brings a lot of functionalities (sort, grouping, and more)
6266
- even server side data is saved into the SlickGrid DataView
63-
- All the [SlickGrid Events](https://github.com/6pac/SlickGrid/wiki/Grid-Events) are supported, see the [Wiki](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Grid-&-DataView-Events)
67+
- Expose all the [SlickGrid Events](https://github.com/6pac/SlickGrid/wiki/Grid-Events), see the [Wiki](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Grid-&-DataView-Events)
6468
- Localization support with `ngx-translate`, please read the [Wiki - Localization](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Localization)
6569
- [Export to File](https://github.com/ghiscoding/Angular-Slickgrid/wiki/Export-to-File) CSV or Text file (Tab Delimited or Semicolon Delimited)
6670
- support Unicode as well, even unicorn emoji shows up in the export and it even works with IE11.

0 commit comments

Comments
 (0)