Aurelia-Slickgrid

One of the best javascript datagrid SlickGrid which was originally developed by @mleibman is now available to Aurelia. I have used a few datagrids and SlickGrid beats most of them in terms of functionalities and performance (it can easily deal with even a million row). We will be using the 6pac/SlickGrid fork, this is the most active fork since the original @mleibman fork was closed some time ago by his author for personal reasons. Also worth to know, I also contributed a lot to the 6pac/SlickGrid fork for the benefit of Aurelia-Slickgrid.

Installation

Refer to the Wiki - HOWTO Step by Step and/or clone the Aurelia-Slickgrid Demos repository. Please consult all Wikis 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 install aurelia-slickgrid

License

MIT License

Like it? :star: it

You like and use Aurelia-Slickgrid? Be sure to upvote :star: and feel free to contribute. :construction_worker:

Like my work?

You could :star: the lib and maybe support me with cafeine :coffee:. Thanks.

Demo page

Aurelia-Slickgrid works with all Bootstrap versions, you can see a demo of each one below.

• Bootstrap 4 demo / examples repo
• Bootstrap 5 demo / examples repo

There are also 2 new Themes, Material & Salesforce that are available as well and if you wish to use SVG then take a look at the Wiki - SVG Icons.

Working Demos

For a complete working set of demos, you can clone the Aurelia-Slickgrid Demos repository (instructions are provided in the demo repo). This repo provides multiple samples (RequireJS, WebPack, CLI, ...) and it is also worth to know that the 2 WebPacks demos are updated frequently since they are the actual live GitHub Bootstrap 4 demo / Bootstrap 5 demo.

Wiki / Documentation

The Wikis is where you'll find all the documentation and instructions for the lib, so please consult the Aurelia-Slickgrid - Wiki before opening any new issue. The Wiki - HOWTO is a great place to start with.

Latest News & Releases

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

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

Aurelia-Slickgrid has 100% Unit Test Coverage, we are talking of 15,000+ lines of code (3,750+ unit tests, most of these tests were moved into Slickgrid-Universal) fully tested with Jest. On the UI side, all Aurelia-Slickgrid Example are tested with Cypress, there are over 550+ Cypress E2E tests.

Usage

How to load data with Fetch-Client or Http-Client?

You might have noticed that all demos are made with mocked dataset that are embedded in each examples, that is mainly for demo purposes, but you might be wondering how to connect this with a FetchClient or Http-Client? Easy... just replace the mocked data, assigned to the dataset property, by your FetchClient call and that's it. The dataset property can be changed at any time, which is why you can use local data and/or connect it to a Promise or an async call with FetchClient (internally it's just a SETTER that refreshes the grid). See Example 22 for a demo showing how to load a JSON file with FetchClient.

Main features

You can see a few screenshots below to demo some of the lib features as well as instructions underneath them and if that is not enough to convince you then head over to the Wiki - Main Features.

Missing features

What if Aurelia-Slickgrid is missing feature(s) compare to the original core library 6pac/SlickGrid?

Fear not, you can simply reference the SlickGrid and DataView objects, just like in the core lib (they are exposed through Custom Events). For more info continue reading on Wiki - SlickGrid & DataView objects and Wiki - Grid & DataView Events

Screenshots

Screenshots from the demo app with the Bootstrap theme.

Slickgrid example with Formatters (last column shown is a custom Formatter)

You can also see the Grid Menu opened (aka hambuger menu)

Filter and Sort (clientside with DataView)

Editors and/or onCellClick

Pinned (aka frozen) Columns/Rows

Draggable Grouping & Aggregators

Slickgrid Example with Server Side (Filter/Sort/Pagination)

Comes with OData & GraphQL support (you can implement custom too)

Composite Editor Modal Windows