https://github.com/ghiscoding/slickgrid-universal
Slickgrid-Universal is a monorepo which includes all Editors, Filters, Extensions, Services related to SlickGrid usage and is also Framework Agnostic
https://github.com/ghiscoding/slickgrid-universal
csv-export datagrid datatable excel-export graphql grid javascript monorepo odata rxjs slickgrid typescript
Last synced: 16 days ago
JSON representation
Slickgrid-Universal is a monorepo which includes all Editors, Filters, Extensions, Services related to SlickGrid usage and is also Framework Agnostic
- Host: GitHub
- URL: https://github.com/ghiscoding/slickgrid-universal
- Owner: ghiscoding
- License: mit
- Created: 2020-03-12T21:08:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T20:18:18.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:27:25.243Z (over 1 year ago)
- Topics: csv-export, datagrid, datatable, excel-export, graphql, grid, javascript, monorepo, odata, rxjs, slickgrid, typescript
- Language: TypeScript
- Homepage: https://ghiscoding.github.io/slickgrid-universal/
- Size: 274 MB
- Stars: 88
- Watchers: 8
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- fucking-awesome-angular - slickgrid-universal - A monorepo which includes all editors, filters, extensions, and services related to framework agnostic <b><code> 2037⭐</code></b> <b><code> 430🍴</code></b> [SlickGrid](https://github.com/6pac/SlickGrid)) usage. (Third Party Components / Data Grids)
- awesome-angular - slickgrid-universal - A monorepo which includes all editors, filters, extensions, and services related to framework agnostic [SlickGrid](https://github.com/6pac/SlickGrid) usage. (Third Party Components / Data Grids)
README
# Slickgrid-Universal
[](https://opensource.org/licenses/MIT)
[](http://www.typescriptlang.org/)
[](https://github.com/lerna-lite/lerna-lite)
[](https://www.npmjs.com/package/@slickgrid-universal/common)
[](https://www.npmjs.com/package/@slickgrid-universal/common)
[](https://github.com/ghiscoding/slickgrid-universal/actions)
[)](https://cloud.cypress.io/projects/p5zxx6/runs)
[](https://vitest.dev/)
[](https://codecov.io/gh/ghiscoding/slickgrid-universal)
### Documentation
📘 [Documentation](https://ghiscoding.gitbook.io/slickgrid-universal/) website powered by GitBook for version 4.0+ (_or use the [Wikis](https://github.com/ghiscoding/slickgrid-universal/wiki) docs for older versions_)
### Live Demo
[Live Demo](https://ghiscoding.github.io/slickgrid-universal/) website OR take a look at the [Available Framework Wrappers](#available-framework-wrappers) table below for more demos.
Stackblitz links are also available for all supported frameworks (see [table](https://github.com/ghiscoding/slickgrid-universal?tab=readme-ov-file#available-framework-wrappers) below)
### Description
One of the best JavaScript data grid named "SlickGrid", which was originally developed by `@mleibman`, beats most other data grids in terms of features, customizability & performance (running smoothly with even a million rows).
This is a monorepo project (using [pnpm workspaces](https://pnpm.io/workspaces) and [Lerna-Lite](https://github.com/lerna-lite/lerna-lite)) which is regrouping a few packages under a single repository. It was originally requiring `@6pac/SlickGrid` as an external dependency, but that was dropped in v4.0, and it has been a standalone library ever since. The main goal of this project is to create a common repo that includes all Editors, Filters, Extensions and Services that could be used by any frameworks (the core project in itself is framework agnostic).
### What's the difference with the original SlickGrid (now [`@6pac/SlickGrid`](https://github.com/6pac/SlickGrid)) project?
If you've used the original SlickGrid in the past, you might be wondering, should I use the [`@6pac/SlickGrid`](https://github.com/6pac/SlickGrid) or Slickgrid-Universal? The main difference is that the original SlickGrid is like an unassembled IKEA product where it's very bare bone and unassembled, but on the other hand Slickgrid-Universal is an all-assembled product with batteries included. What that means is that Slickgrid-Universal comes with many built-in features like Formatters, Editors, Filters, Tree Data, ... which are not directly available in the original SlickGrid. So in the end SlickGrid (`@6pac/SlickGrid`) project is much smaller in size because it's very bare bone but you will have to implement many things yourself (Sorting/Filtering/Editing/...), and if you're looking at creating very basic grids with the smallest footprint possible, then SlickGrid might just work for you, otherwise Slickgrid-Universal has a more complete set of features out of the box with a bit larger download and installation size. Side note, I am (`@ghiscoding`) a maintainer in both projects (Slickgrid-Universal and [`@6pac/SlickGrid`](https://github.com/6pac/SlickGrid))
### Why create this monorepo?
Below is a list of reasons as to why this project was created and why it is built as a monorepo project:
1. avoids duplicate code by creating common packages available in Slickgrid-Universal and used by all frameworks
2. many of the services are decoupled because no project will ever require all the available services all at once
- OData, GraphQL, Export to (CSV, Excel or PDF), Composite Editor, RxJS, ...
4. and finally it is framework agnostic
- you can reuse the same grids and logic in many different frameworks, it's easily transportable
- you can use it in plain JavaScript (ES6) or TypeScript, for example we use it ourselves as plain JS (ES6) in our Salesforce environment with LWC (Lightning Web Component)
## Latest News & Releases
Check out the [Releases](https://github.com/ghiscoding/slickgrid-universal/releases) section for all the latest News & Releases.
### Like my work?
If you use and like the project, please give it a star ⭐ and/or support me with caffeine via GitHub [sponsorship](https://github.com/sponsors/ghiscoding) or the Ko-Fi button below would be much appreciated. Thanks in advance.
## Live Demos & Available Framework Wrappers
The Slickgrid-Universal [live demo](https://ghiscoding.github.io/slickgrid-universal) shows 2 different UI themes (Material Design / Salesforce) and you can also see the Bootstrap theme demoed in all other frameworks with links available in the table shown below. Also please note that even if all the demos are built with [Bootstrap](https://getbootstrap.com/) or [Bulma](https://bulma.io/), you could use any other UI libraries (like Google Material, Ms Fluent UI or anything else). The project tries to be agnostic as much as possible and it does so by providing a large set of CSS/SASS variables which are available to customize the UI however you want.
Multiple Themes are available:
- default (`slickgrid-theme-default.[s]css`)
- Bootstrap (`slickgrid-theme-bootstrap.[s]css`)
- Material (`slickgrid-theme-material.[s]css`)
- Salesforce (`slickgrid-theme-salesforce.[s]css`)
- Fluent UI (`slickgrid-theme-fluent.[s]css`)
### Available Framework Wrappers
> There's no **SolidJS** or **Svelte** wrappers, but if you are willing to help then let's talk and open a new [Discussion](https://github.com/ghiscoding/slickgrid-universal/discussions)
| Platform | Project Repos | Live Demo | Stackblitz | Downloads | Details |
| :------: | ------------- | --------- | ---------- | :-------: | ------- |
| 
| [Angular-Slickgrid](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/angular-slickgrid) /
[Angular-Slickgrid-Demos](https://github.com/ghiscoding/angular-slickgrid-demos) | [demo](https://ghiscoding.github.io/angular-slickgrid-demos) | [](https://stackblitz.com/github/ghiscoding/angular-slickgrid-demos) | [](https://npmjs.org/package/angular-slickgrid) | [docs](https://ghiscoding.gitbook.io/angular-slickgrid/getting-started/quick-start) /
[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/angular-slickgrid/CHANGELOG.md) |
| 
| [Aurelia-Slickgrid](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/aurelia-slickgrid) /
[Aurelia-Slickgrid-Demos](https://github.com/ghiscoding/aurelia-slickgrid-demos) | [demo](https://ghiscoding.github.io/aurelia-slickgrid-demos) | [](https://stackblitz.com/github/ghiscoding/aurelia-slickgrid-demos) | [](https://npmjs.org/package/aurelia-slickgrid) | [docs](https://ghiscoding.gitbook.io/aurelia-slickgrid/getting-started/quick-start) /
[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/aurelia-slickgrid/CHANGELOG.md) |
| 
| [Slickgrid-React](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/slickgrid-react/) /
[Slickgrid-React-Demos](https://github.com/ghiscoding/slickgrid-react-demos) | [demo](https://ghiscoding.github.io/slickgrid-react-demos) | [](https://stackblitz.com/github/ghiscoding/slickgrid-react-demos/) | [](https://npmjs.org/package/slickgrid-react) | [docs](https://ghiscoding.gitbook.io/slickgrid-react/getting-started/quick-start) /
[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/slickgrid-react/CHANGELOG.md) |
| 
| [Slickgrid-Vue](https://github.com/ghiscoding/slickgrid-universal/tree/master/frameworks/slickgrid-vue) /
[Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos) | [demo](https://ghiscoding.github.io/slickgrid-vue-demos) | [](https://stackblitz.com/github/ghiscoding/slickgrid-vue-demos) | [](https://npmjs.org/package/slickgrid-vue) | [docs](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start) /
[changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks/slickgrid-vue/CHANGELOG.md) |
| 
| [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) | | [docs](https://ghiscoding.gitbook.io/slickgrid-universal/) |
| 
| [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) | | [docs](https://ghiscoding.gitbook.io/slickgrid-universal/)
| 
| [Slickgrid-Universal/vanilla-force-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle) | n/a | | [zip](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle/dist-grid-bundle-zip) file | [docs](https://ghiscoding.gitbook.io/slickgrid-universal/getting-started/installation-salesforce) |
| 
| [streamlit-slickgrid](https://github.com/streamlit/streamlit-slickgrid/) | [demo](https://slickgrid.streamlit.app/) | | | Community Python wrapper |
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/) 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 LWC (Lightning Web Component) implementation and this Zip file 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 the library under a monorepo structure, but above all, it was mainly 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.
### Fully Tested with [Vitest](https://vitest.dev/) (Unit Tests) - [Cypress](https://www.cypress.io/) (E2E Tests)
Slickgrid-Universal has **100%** Unit Test Coverage, 5000+ Vitest unit tests and 1000+ Cypress E2E tests to cover **all** [Examples](https://ghiscoding.github.io/slickgrid-universal/) and most UI functionalities (each framework implementation also includes roughly the same amount of E2E tests), the goal is to offer peace of mind that pretty much all the code, features and PR changes are fully tested before releasing anything new. Every time a new Pull Request (PR) is created, it runs all unit tests and all Cypress E2E tests for all frameworks and they all run in parallel for a complete test suite.
### Available Public Packages
| Package Name | Version | Downloads | Changes | Optional |
| -------------| ------- | --------: | ------- | :------: |
| [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common) | [](https://www.npmjs.com/package/@slickgrid-universal/common) | [](https://www.npmjs.com/package/@slickgrid-universal/common) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/common/CHANGELOG.md) | |
| [@slickgrid-universal/binding](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/binding) | [](https://www.npmjs.com/package/@slickgrid-universal/binding) | [](https://www.npmjs.com/package/@slickgrid-universal/binding) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/binding/CHANGELOG.md) | |
| [@slickgrid-universal/event-pub-sub](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/event-pub-sub) | [](https://www.npmjs.com/package/@slickgrid-universal/event-pub-sub) | [](https://www.npmjs.com/package/@slickgrid-universal/event-pub-sub) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/event-pub-sub/CHANGELOG.md) | |
| [@slickgrid-universal/composite-editor-component](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/composite-editor-component) | [](https://www.npmjs.com/package/@slickgrid-universal/composite-editor-component) | [](https://www.npmjs.com/package/@slickgrid-universal/composite-editor-component) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/composite-editor-component/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/custom-footer-component](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/custom-footer-component) | [](https://www.npmjs.com/package/@slickgrid-universal/custom-footer-component) | [](https://www.npmjs.com/package/@slickgrid-universal/custom-footer-component) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/custom-footer-component/CHANGELOG.md) | |
| [@slickgrid-universal/custom-tooltip-plugin](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/custom-tooltip-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/custom-tooltip-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/custom-tooltip-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/custom-tooltip-plugin/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/empty-warning-component](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/empty-warning-component) | [](https://www.npmjs.com/package/@slickgrid-universal/empty-warning-component) | [](https://www.npmjs.com/package/@slickgrid-universal/empty-warning-component) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/empty-warning-component/CHANGELOG.md) | |
| [@slickgrid-universal/pagination-component](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/pagination-component) | [](https://www.npmjs.com/package/@slickgrid-universal/pagination-component) | [](https://www.npmjs.com/package/@slickgrid-universal/pagination-component) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/pagination-component/CHANGELOG.md) | |
| [@slickgrid-universal/excel-export](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/excel-export) | [](https://www.npmjs.com/package/@slickgrid-universal/excel-export) | [](https://www.npmjs.com/package/@slickgrid-universal/excel-export) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/excel-export/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/pdf-export](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/pdf-export) | [](https://www.npmjs.com/package/@slickgrid-universal/pdf-export) | [](https://www.npmjs.com/package/@slickgrid-universal/pdf-export) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/pdf-export/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/text-export](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/text-export) | [](https://www.npmjs.com/package/@slickgrid-universal/text-export) | [](https://www.npmjs.com/package/@slickgrid-universal/text-export) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/text-export/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/graphql](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/graphql) | [](https://www.npmjs.com/package/@slickgrid-universal/graphql) | [](https://www.npmjs.com/package/@slickgrid-universal/graphql) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/graphql/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/odata](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/odata) | [](https://www.npmjs.com/package/@slickgrid-universal/odata) | [](https://www.npmjs.com/package/@slickgrid-universal/odata) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/odata/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/sql](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/sql) | [](https://www.npmjs.com/package/@slickgrid-universal/sql) | [](https://www.npmjs.com/package/@slickgrid-universal/sql) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/sql/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/row-detail-view-plugin](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/row-detail-view-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/row-detail-view-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/row-detail-view-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/row-detail-view-plugin/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/rxjs-observable](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/rxjs-observable) | [](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable) | [](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/rxjs-observable/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/utils](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/utils) | [](https://www.npmjs.com/package/@slickgrid-universal/utils) | [](https://www.npmjs.com/package/@slickgrid-universal/utils) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/utils/CHANGELOG.md)
| [@slickgrid-universal/vanilla-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-bundle) | [](https://www.npmjs.com/package/@slickgrid-universal/vanilla-bundle) | [](https://www.npmjs.com/package/@slickgrid-universal/vanilla-bundle) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/vanilla-bundle/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/vanilla-force-bundle](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/vanilla-force-bundle) | [](https://www.npmjs.com/package/@slickgrid-universal/vanilla-force-bundle) | [](https://www.npmjs.com/package/@slickgrid-universal/vanilla-force-bundle) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/vanilla-force-bundle/CHANGELOG.md) | ✓ |
| ... | ... | | |
| [@slickgrid-universal/angular-row-detail-plugin](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/angular-row-detail-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/angular-row-detail-plugin) | [](https://www.npmjs.com/package/"@slickgrid-universal/angular-row-detail-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/angular-row-detail-plugin/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/aurelia-row-detail-plugin](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/aurelia-row-detail-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/aurelia-row-detail-plugin) | [](https://www.npmjs.com/package/"@slickgrid-universal/aurelia-row-detail-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/aurelia-row-detail-plugin/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/react-row-detail-plugin](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/react-row-detail-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/react-row-detail-plugin) | [](https://www.npmjs.com/package/"@slickgrid-universal/react-row-detail-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/react-row-detail-plugin/CHANGELOG.md) | ✓ |
| [@slickgrid-universal/vue-row-detail-plugin](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/vue-row-detail-plugin) | [](https://www.npmjs.com/package/@slickgrid-universal/vue-row-detail-plugin) | [](https://www.npmjs.com/package/"@slickgrid-universal/vue-row-detail-plugin) | [changelog](https://github.com/ghiscoding/slickgrid-universal/blob/master/frameworks-plugins/vue-row-detail-plugin/CHANGELOG.md) | ✓ |
## Installation
**NOTE:** the installation instructions below are **only** required if you want to contribute to this project, if you just want a quick Slickgrid-Universal demo, then I would suggest to try the following repos [Slickgrid-Universal Vite Demo](https://github.com/ghiscoding/slickgrid-universal-vite-demo) or [Slickgrid-Universal WebPack Demo](https://github.com/ghiscoding/slickgrid-universal-webpack-demo) and/or take a look at all the [available framework wrappers](https://github.com/ghiscoding/slickgrid-universal?tab=readme-ov-file#available-framework-wrappers) that you can clone and get started.
To get started with development in this monorepo, you will need to clone the repo and follow the steps shown below. Note that you must be at the root of the project in order to run the following commands, this project also requires `pnpm`.
1. pnpm installation
This project uses [pnpm workspaces](https://pnpm.io/workspaces), you can install pnpm by choosing 1 of these 2 choices:
a. following their [installation](https://pnpm.io/installation)
b. or install pnpm via Node [corepack](https://nodejs.org/api/corepack.html)
```sh
corepack enable
# optionally update pnpm to latest
corepack prepare pnpm@latest --activate
```
#### Specific Framework install
For a more targeted install, you could optionally install a specific framework (which avoids installing all frameworks).
You should only do that if you're only interested in contributing something specific to a framework wrapper, see commands below:
```sh
# install all framework wrappers
pnpm install
# or install only a single framework wrapper
# choose the command from list below depending on the framework
pnpm angular:install
pnpm aurelia:install
pnpm react:install
pnpm vue:install
```
2. Run Dev (Vanilla Implementation)
There is a Vanilla flavour implementation of this monorepo, vanilla means that it is not associated to any framework
and is written in plain TypeScript without being bound to any framework. The implementation is very similar to Angular and Aurelia.
It could be used as a guideline to implement it for other framework wrappers.
```bash
# dev vanilla (default)
pnpm run dev
# dev for Angular, Aurelia, React or Vue
pnpm run dev:angular
pnpm run dev:aurelia
pnpm run dev:react
pnpm run dev:vue
```
3. Build
You also need to run a full build in order to run the Vitest unit tests
```bash
# full build (all universal & all frameworks)
pnpm run build
# or only Slickgrid-Universal packages (excludes all frameworks)
pnpm run build:universal
```
### Tests
You must go through Installation Steps 1-3 prior to running the Vitest unit tests OR steps 1-2 for Cypress E2E tests.
#### [Vitest](https://vitest.dev/) Unit Tests
To run all unit tests (with Vitest), you can run one of the following commands (make sure that steps 1-3 were executed prior to running this command)
```bash
pnpm run test
```
#### [Cypress](https://cypress.io/) E2E Tests
To run all E2E tests (with Cypress), you can run one of the following commands (make sure that steps 1-2 were executed prior to running this command)
```bash
# will open the Cypress GUI
pnpm run cypress
# or run it in the shell (like a CI/CD would)
pnpm run cypress:ci
```
## Sponsors
Thanks to all my Sponsors
