slickgrid-react

Slickgrid-React

Brief introduction

One of the best JavasSript data grid SlickGrid, which was originally developed by @mleibman, is now available to the React world. SlickGrid beats most other data grids in terms of features, customizability & performance (running smoothly with even a million rows). Slickgrid-React is a wrapper on top of Slickgrid-Universal (which is a dependency), in the early beginning we used the 6pac/SlickGrid fork but that was dropped in >=v4.0 since Slickgrid-Universal is now a standalone project. SlickGrid was also recently rewritten with browser native code (no more jQuery 🎉).

Documentation

📘 Documentation website powered by GitBook for version 4+ (... or use the Wikis for older versions).

Installation

Available in Stackblitz (Codeflow) below, this can also be used to provide an issue repro.

Refer to the Docs - Quick Start and/or clone the Slickgrid-React-Demos repository. Please consult all documentation before opening new issues, also consider asking installation and/or general questions on Stack Overflow unless you think there's a bug with the library.

NPM Package

slickgrid-react on NPM

Basic Usage

import { type Column, type GridOption, SlickgridReact } from 'slickgrid-react';

export default function Example() {
  const [dataset] = useState(getData());

  const columnDefinitions: Column[] = [
    { id: 'firstName', name: 'First Name', field: 'firstName', sortable: true },
    { id: 'lastName', name: 'Last Name', field: 'lastName', sortable: true },
    { id: 'age', name: 'Age', field: 'age', type: 'number', sortable: true }
  ]);
  const gridOptions: GridOption = { /*...*/ }); // optional grid options

  function getData() {
    return [
    { id: 1, firstName: 'John', lastName: 'Doe', age: 20 },
    { id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }
    ];
  }

  return (
    <SlickgridReact gridId="grid1"
        columnDefinitions={columnDefinitions}
        gridOptions={gridOptions}
        dataset={dataset}
     />
  );
}

Troubleshooting

This project does not work well with React.StrictMode, so please make sure to disable it to avoid pulling your hair for days.

Versions Compatibility

Note please be aware that only the latest major version of Slickgrid-React will be supported and receive bug fixes (it's already a lot of work to maintain for a single developer like me).

Slickgrid-React	React version	Migration Guide	Notes
5.x	React 18+	Migration 5.x	modern UI / Dark Mode, requires Slickgrid-Universal 5.x
4.x		Migration 4.x	merge SlickGrid into Slickgrid-Universal, requires Slickgrid-Universal 4.x
3.x		Migration 3.x	removal of jQuery (now uses browser native code), requires Slickgrid-Universal 3.x
2.x	React 18+	Migration 2.x	removal of jQueryUI, requires Slickgrid-Universal 2.x version

Styling Themes

Multiple styling themes are available

• Default (UI agnostic)
• Bootstrap (see all Slickgrid-React live demos)
• Material (see Slickgrid-Universal)
• Salesforce (see Slickgrid-Universal)

Also note that all of these themes also have Dark Theme equivalent and even though Bootstrap is often used for live demos, it does work as well with any other UI framework like Bulma, Material, ...

Live Demo page

Slickgrid-React works with all Bootstrap versions, you can see a demo of each one below. It also works well with any other frameworks like Material or Bulma and there are also couple of extra styling themes based on Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the Docs - SVG Icons

• Bootstrap 5 demo / examples repo

Working Demos

For a complete set of working demos (40+ examples), we strongly suggest you to clone the Slickgrid-React Demos repository (instructions are provided inside it). The repo provides multiple examples and are updated every time a new release is out, so it is updated frequently and is used as the GitHub live demo page.

License

MIT License

Latest News & Releases

Check out the Releases section for all latest News & Releases.

Tested with Jest (Unit Tests) - Cypress (E2E Tests)

Slickgrid-Universal has 100% Unit Test Coverage and all Slickgrid-React Examples are tested with Cypress as E2E tests.

Like it? ⭐ it

You like Slickgrid-React? Be sure to upvote ⭐, and perhaps support me with caffeine ☕ or GitHub sponsoring and feel free to contribute. 👷👷‍♀️

Sponsors

Thanks to all my sponsors!