You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,32 +33,32 @@ Side note, I am (`@ghiscoding`) a maintainer in both projects, which are Slickgr
33
33
34
34
### Why create this monorepo?
35
35
Below is a list of reasons as to why this project was created and why it was built as a monorepo project:
36
-
1. originally created to remove duplicated code from these 2 wrappers
37
-
[Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid) and [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid)
38
-
- prior to this monorepo, these 2 projects had ~90% duplicated code in common which was not very DRY.
39
-
-being a common source makes it a lot easier to maintain by pushing fixes in this common project here.
40
-
2. it also decoupled a few Services which are not required in every project (OData, GraphQL, Export to CSV, Export to Excel, Composite Editor, RxJS, ...)
41
-
3. and finally it is framework agnostic, it could be implemented in many different frameworks (if you are interested in adding a different framework wrapper, which is not listed in the [table](#available-framework-wrappers) below (maybe Svelte), then please open a new [Discussion](https://github.com/ghiscoding/slickgrid-universal/discussions))
36
+
1. originally created to remove duplicated code from the first 2 framework wrappers
37
+
-[Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid) and [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid)
38
+
2. it also decoupled a few Services which are simply not required in every project
39
+
-OData, GraphQL, Export to CSV, Export to Excel, Composite Editor, RxJS, ...
40
+
4. and finally it is framework agnostic, the same logic is reused in all different framework wrappers
41
+
- you can reuse the same grids and logic in many different frameworks, it's easily transportable
42
42
- you can use it in plain JavaScript (ES6) or TypeScript, i.e. we use plain JS (ES6) in our Salesforce environment with LWC (Lightning Web Component)
43
43
44
44
## Latest News & Releases
45
45
Check out the [Releases](https://github.com/ghiscoding/slickgrid-universal/releases) section for all the latest News & Releases.
46
46
47
47
### Like my work?
48
-
You could ⭐ the lib and perhaps support me with caffeine via GitHub sponsorship or the Ko-Fi button below. Thanks in advance.
48
+
You could star ⭐ the project and/or support me with caffeine via GitHub [sponsorship](https://github.com/sponsors/ghiscoding) or the Ko-Fi button below. Thanks in advance.
49
49
50
50
<ahref='https://ko-fi.com/ghiscoding'target='_blank'><imgheight='36'style='border:0px;height:36px;'src='https://storage.ko-fi.com/cdn/kofi3.png?v=6'border='0'alt='Buy Me a Coffee at ko-fi.com' /></a>
51
51
52
52
## Live Demos & Available Framework Wrappers
53
-
The GitHub [live demo](https://ghiscoding.github.io/slickgrid-universal) above shows 2 different UI themes (Material Design / Salesforce), but you could also choose the Bootstrap theme which is demoed in other frameworks from links available in the table below. Also note that even though the demos are built with either [Bootstrap](https://getbootstrap.com/) or [Bulma](https://bulma.io/), you could in theory use any other UI libraries. The project tries to be as much agnostic as possible and it does so by providing a large set of CSS/SASS variables which are available to customize however you want.
53
+
The GitHub [live demo](https://ghiscoding.github.io/slickgrid-universal) above shows 2 different UI themes (Material Design / Salesforce), but you could also choose the Bootstrap theme which is demoed in other frameworks from links available in the table below. Also note that even if the demos are built with either [Bootstrap](https://getbootstrap.com/) or [Bulma](https://bulma.io/), you could in theory use any other UI libraries. The project tries to be as much agnostic as possible and it does so by providing a large set of CSS/SASS variables which are available to you to customize the UI however you want.
|[Angular-Slickgrid](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/angular-slickgrid)|[demo](https://ghiscoding.github.io/angular-slickgrid-demos)|[](https://stackblitz.com/github/ghiscoding/angular-slickgrid-demos)|[Angular](https://angular.io/)|[docs](https://ghiscoding.gitbook.io/angular-slickgrid/getting-started/quick-start)|[](https://npmjs.org/package/angular-slickgrid)|[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/angular-slickgrid/CHANGELOG.md)|
60
60
|[Aurelia-Slickgrid](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/aurelia-slickgrid)|[demo](https://ghiscoding.github.io/aurelia-slickgrid-demos)|[](https://stackblitz.com/github/ghiscoding/aurelia-slickgrid-demos/tree/master/webpack-bs5-demo)|[Aurelia](https://aurelia.io/)|[docs](https://ghiscoding.gitbook.io/aurelia-slickgrid/getting-started/quick-start)|[](https://npmjs.org/package/aurelia-slickgrid)|[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/aurelia-slickgrid/CHANGELOG.md)|
61
-
|[Slickgrid-React](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/slickgrid-react/)|[demo](https://ghiscoding.github.io/slickgrid-react-demos)|[](https://stackblitz.com/github/ghiscoding/slickgrid-react-demos/tree/main/bootstrap5-i18n-demo)|[React](https://react.dev/)|[docs](https://ghiscoding.gitbook.io/slickgrid-react/getting-started/quick-start)|[](https://npmjs.org/package/slickgrid-react)|[changelog](https://github.com/ghiscoding/slickgrid-react/blob/master/CHANGELOG.md)|
61
+
|[Slickgrid-React](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/slickgrid-react/)|[demo](https://ghiscoding.github.io/slickgrid-react-demos)|[](https://stackblitz.com/github/ghiscoding/slickgrid-react-demos/tree/main/bootstrap5-i18n-demo)|[React](https://react.dev/)|[docs](https://ghiscoding.gitbook.io/slickgrid-react/getting-started/quick-start)|[](https://npmjs.org/package/slickgrid-react)|[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/slickgrid-react/CHANGELOG.md)|
62
62
|[Slickgrid-Vue](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/slickgrid-vue)|[demo](https://ghiscoding.github.io/slickgrid-vue-demos)|[](https://stackblitz.com/github/ghiscoding/slickgrid-vue-demos)|[Vue](https://vuejs.org/) - **new** 🚀 |[docs](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start)|[](https://npmjs.org/package/slickgrid-vue)|[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/slickgrid-vue/CHANGELOG.md)|
63
63
|[Slickgrid-Universal-WebPack-Demo](https://github.com/ghiscoding/slickgrid-universal-webpack-demo)|[demo](https://ghiscoding.github.io/slickgrid-universal-webpack-demo)|[](https://stackblitz.com/github/ghiscoding/slickgrid-universal-webpack-demo)| Vanilla / WebPack |[docs](https://ghiscoding.gitbook.io/slickgrid-universal/)|
64
64
| [Slickgrid-Universal-Vite-Demo](https://github.com/ghiscoding/slickgrid-universal-vite-demo) | [demo](https://ghiscoding.github.io/slickgrid-universal-vite-demo) | [](https://stackblitz.com/github/ghiscoding/slickgrid-universal-vite-demo) | Vanilla / Vite | [docs](https://ghiscoding.gitbook.io/slickgrid-universal/)
@@ -67,7 +67,7 @@ The GitHub [live demo](https://ghiscoding.github.io/slickgrid-universal) above s
67
67
The Slickgrid-Universal [live demo](https://ghiscoding.github.io/slickgrid-universal) is a Vanilla Implementation (which is not associated to any framework) built with [ViteJS](https://vitejs.dev/) (originally [WebPack](https://webpack.js.org/)) and is also being used to run all E2E tests with [Cypress](https://www.cypress.io/) for testing every UI functionalities. The [Vanilla-force-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle), which extends the [vanilla-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-bundle) package, is what we use in our SalesForce implementation (with Lightning Web Component) and it can also be used as a Standalone script (see [zip](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle/dist-grid-bundle-zip) file). These were all the original reasons to create this monorepo library but above all it was to avoid code duplication. Dark Mode is also shown in some of the examples (not all), see [Dark Mode](https://ghiscoding.gitbook.io/slickgrid-universal/styling/dark-mode) documentation for more infos.
Slickgrid-Universal has close to **100%** Unit Test Coverage, ~5,000 Vitest unit tests including ~900 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities (each framework implementation also includes the same amount of E2E tests), the goal is to offer peace of mind that pretty much all the code and PR changes are fully tested before releasing anything.
70
+
Slickgrid-Universal has close to **100%** Unit Test Coverage, ~5,000 Vitest unit tests including ~900 Cypress E2E tests to cover all [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities (each framework implementation also includes the same amount of E2E tests), the goal is to offer peace of mind that pretty much all the code and PR changes are fully tested before releasing anything. Every time a new Pull Request (PR) is created, it will run all unit tests and Cypress E2E tests for every framework wrappers.
0 commit comments