SlickGrid

This is the 6pac SlickGrid repo

This is the main 'base' SlickGrid repository. For specific frameworks (Angular, React and Vue) see Slickgrid-Universal which has official wrappers for all these frameworks and more.

This repo builds on the legacy of the mleibman/SlickGrid original project, which stopped being updated in 2014.

We extended the project from the original SlickGrid foundation while also including the following changes:

• added a few more Plugins: RowDetail, CellMenu, ContextMenu, GridMenu, CustomTooltip, GridState
• merged X-SlickGrid code into the project in v2 to bring permanent column/row freezing (later replaced by Pinning in v6, see below)
• removed jQueryUI requirement in v3 (replaced it with SortableJS which was later dropped in v6)
• removed jQuery requirement in v4
• modernized the project in v5 by migrating to TypeScript (we kept IIFE and added ES6/ESM build targets) and we also gave SlickGrid a fresh and more modern look via a new Alpine Theme (CSS/SASS)
• in v6, we completely rewrote Freezing into Pinning and also brought a new Sticky columns/rows, we also dropped SortableJS which makes SlickGrid a zero dependencies project (we now use native HTML5 drag & drop for column reordering and draggable grouping)

Common Questions & Answers

• Do I need TypeScript to use version >=5.0?
  • Not at all, you can use regular JavaScript if you wish by using the dist/browser folder, ESM folder or from CDN. The Stackblitz and installation examples shown below are mostly written with JavaScript.
• Can I use it with "xyz" framework?
  • Sure we provide an ES6/ESM build which should work with most frameworks... but for more specific frameworks (Angular, React and Vue) you may want to take a look at Slickgrid-Universal which has official wrappers for all these frameworks and more.
• Do I still need jQuery?
  • Not anymore, it's totally optional since v4.0 (you can still use jQuery if you wish, but it's totally optional)

Documentation 📖

📘 Visit our new Documentation website to get started

Vite Demo

You can also see a ViteJS demo in the ./vite-demo folder (also available via the Stackblitz link below). This Vite demo was created mostly to test the project ESM build and the SASS imports as well.

Stackblitz

You can try out the live Vite demo (mentioned just above) via the Stackblitz button. You can also use it to provide bug or feature requests.

Note: the Stackblitz demo is only including a couple of examples, note however that there are a lot more examples available in the Examples Wiki page

Examples

Check out the Examples from the docs website or the Examples Wiki page for a full list of examples demonstrating new features and use cases, such as dynamic grid creation and editors with third party controls.

Also take a look at the new SlickGrid docs website and GitHub Releases for recent news.

For a basic TypeScript example, take a look at the v5.0 Annoucement & Migration guide shown below and also the TypeScript Example Wiki.

Below is one of the available examples available in Stackblitz (which is mentioned just above)

Installation

There are multiple ways to use and install SlickGrid, you can use it as a standalone <script> (IIFE) or install it through NPM and then import or require SlickGrid (ESM import is preferred for tree shaking).

This is the beginning of the README. Read the rest at the original. Read the full README ↗