angular-slickgrid

Angular-Slickgrid

Brief introduction

Angular-SlickGrid is a custom component created specifically for Angular framework, it is a wrapper on top of Slickgrid-Universal library which contains the core functionalities. Slickgrid-Universal is written with TypeScript in browser native code, it is framework agnostic and is a monorepo that includes all Editors, Filters, Extensions and Services related to SlickGrid usage with also a few optional packages (like GraphQL, OData, Export to Excel, ...).

Documentation

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

For common issues, see the Troubleshooting Section below

Installation

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

A good starting point is the Docs - Quick Start and/or simply clone the Angular-Slickgrid Demos repository. Please review all documentation and closed issues before opening any new issue, also consider asking installation and/or general questions on Stack Overflow unless you think there's a bug with the library.

npm install angular-slickgrid

License

MIT License

Basic Grid

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

interface User {
  firstName: string;
  lastName: string;
  age: number;
}

export class GridComponent implements OnInit {
  columnDefinitions: Column[] = []; // it could also be `Column<User>[]`
  gridOptions: GridOption;
  dataset: User[] = [];

  onInit() {
    this.columnDefinitions = [
      { 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 }
    ];
    this.dataset = [
      { id: 1, firstName: 'John', lastName: 'Doe', age: 20 },
      { id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }
    ];
    this.gridOptions = { /*...*/ }; // optional grid options
  }
}

<angular-slickgrid gridId="grid2"
    [columns]="columnDefinitions"
    [options]="gridOptions"
    [dataset]="dataset">
</angular-slickgrid>

Troubleshooting

[!WARNING] Because of its use of native Custom Event, this project does not work well with strictTemplates, so please make sure to either disable strictTemplates or cast your event as any (see this discussion for more info)

Styling Themes

Multiple styling themes are available

• Default (UI agnostic)
• Bootstrap (see all Angular-Slickgrid 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, ...

Demo page

Angular-Slickgrid 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 for more info.

Angular-Slickgrid-Demos includes the following:

• Bootstrap 5 demo / examples repo - Code samples which uses ngx-translate to support multiple locales.
• Bootstrap 5 (single Locale) / examples repo - Code Sample with a single Locale (without ngx-translate)

Working Demo

For a complete set of working demos (40+ examples), we strongly suggest you clone Angular-Slickgrid Demos repository (instructions are provided inside it). The demo repo provides multiple examples and are updated on every new project release, so it is updated frequently and is also the GitHub live demo page for the Bootstrap 5 demo.

git clone https://github.com/ghiscoding/angular-slickgrid-demos
cd bootstrap5-demo-with-translate # or any of the other demos
npm install
npm start

Like it? ⭐ it

You like to use Angular-Slickgrid? Be sure to upvote ⭐ and perhaps support me with caffeine ☕ or GitHub sponsoring and feel free to contribute.

Contributions

If you wish to contribute, please make sure to follow the steps shown in the CONTRIBUTING guide.

Latest News & Releases

Make sure to check out the Releases section for all latest News & Releases.

Angular Compatibility

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

Angular-Slickgrid	Angular version	Migration Guide	Notes
9.x	>=19.0	Migration 9.x	ESM-Only, requires Slickgrid-Universal 9.x version
8.x	>=18.0	Migration 8.x	Modern UI / Dark Mode, requires Slickgrid-Universal 5.x version
7.x	>=17.0	Migration 7.x	merge SlickGrid into Slickgrid-Universal, requires Slickgrid-Universal 4.x version
6.x	>=16.0	Migration 6.x	removal of jQuery (now uses browser native code), requires Slickgrid-Universal 3.x version
5.x	>=14.0	Migration 5.x	removal of jQueryUI, requires Slickgrid-Universal 2.x version
4.x	>=13.0	Migration 4.x	for Ivy build only, requires Slickgrid-Universal 1.x version
3.x	>=12.0	Migration 3.x	the lib now uses Slickgrid-Universal monorepo v0.19.2. Also, IE11 is EOL and no longer supported.
2.x	7-11.x	Migration 2.x	support multiple grids on the same page
1.x	4-6.x

Note For a full compatibility table of every Angular-Slickgrid versions with Slickgrid-Universal, please take a look at the Versions Compatibility Table - Wiki.

ngx-translate Compatibility

Angular-Slickgrid uses ngx-translate library to support Locales, it is also required that is even when using a single Locale. The reason is because, we use @Optional() TranslateService in the lib and for that to work, it requires ngx-translate to be installed. Once you run the build and if you are using a single Locale then the tree shaking process should remove these optional dependencies. See their version compatibility table below for more info

Angular Version	@ngx-translate/core
19+	16.x
16+	15.x
13+ (Ivy only)	14.x
10-13	13.x
8-9	12.x
7	11.x

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

Slickgrid-Universal & Angular-Slickgrid both have 100% Unit Test Coverage and also every Angular-Slickgrid Examples are fully tested with Cypress as E2E tests.

Troubleshooting Section

• strictTemplates error