Slickgrid-Universal
){kind=icon}
Documentation
📘 Documentation website powered by GitBook for version 4.0+ (or use the Wikis for older versions)
Live Demo
Live Demo website OR see Available Framework Wrappers table below for more demos.
Stackblitz links are also available for all supported frameworks (see table 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 and 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) project?
If you've used the original SlickGrid in the past, you might be wondering, should I use the @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)
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:
- avoids duplicate code by creating common packages available in Slickgrid-Universal and used by all frameworks
- many of the Services are decoupled because most project will never require all of these services all at once
- OData, GraphQL, Export to (CSV, Excel or PDF), Composite Editor, RxJS, ...
- 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 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 or the Ko-Fi button below would be much appreciated. Thanks in advance.
Live Demos & Available Framework Wrappers
The Slickgrid-Universal live demo 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 or Bulma, you could use any other UI libraries (like Google Material 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.
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
| Platform | Project Repos | Live Demo | Stackblitz | Downloads | Details |
|---|---|---|---|---|---|
 |
Angular-Slickgrid / Angular-Slickgrid-Demos |
demo |  |
 |
docs / changelog |
 |
Aurelia-Slickgrid / Aurelia-Slickgrid-Demos |
demo | |
 |
docs / changelog |
 |
Slickgrid-React / Slickgrid-React-Demos |
demo | |
 |
docs / changelog |
 |
Slickgrid-Vue / Slickgrid-Vue-Demos |
demo | |
 |
docs / changelog |
 |
Slickgrid-Universal-WebPack-Demo | demo | |
docs | |
 |
Slickgrid-Universal-Vite-Demo | demo | |
docs | |
 |
Slickgrid-Universal/vanilla-force-bundle | n/a | zip file | docs | |
 |
streamlit-slickgrid | demo | Python wrapper - community driven |
The Slickgrid-Universal live demo is a Vanilla Implementation (which is not associated to any framework) built with ViteJS and is also being used to run all E2E tests with Cypress for testing every UI functionalities. The Vanilla-force-bundle, which extends the 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 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 documentation for more infos.
Fully Tested with Vitest (Unit Tests) - Cypress (E2E Tests)
Slickgrid-Universal has 100% Unit Test Coverage, 5000+ Vitest unit tests and 1000+ Cypress E2E tests to cover all Examples 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
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 or Slickgrid-Universal WebPack Demo and/or take a look at all the 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.
- pnpm installation
This project uses pnpm workspaces, you can install pnpm by choosing 1 of these 2 choices:
a. following their installation
b. or install pnpm via Node corepack
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:
# 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
- 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.
# 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
- Build
You also need to run a full build in order to run the Vitest unit tests
# 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 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)
Cypress 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)
# 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