Slickgrid the fastest & most customizable javascript datagrid now available in Aurelia with Bootstrap 3/4 theme support
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode add vscode task to copy scripts for easier Github update Jan 19, 2019
aurelia-slickgrid update to latest version 2.8.0 Jan 19, 2019
client-cli feat(headermenu): add Clear Filter to each Column Header Menu (#130) Jan 12, 2019
doc add vscode task to copy scripts for easier Github update Jan 19, 2019
images Add examples & missing Plugins from Slickgrid-ES6 Jan 19, 2017
screenshots refactor(readme): update a few of the print screens Jan 17, 2019
test remove unused unit test that keeps failing Dec 16, 2017
.editorconfig Add GridExtraService with Highlight and RowSelection, replaced mouse … Nov 11, 2017
.eslintrc.json initial commit Jan 7, 2017
.gitignore feat(build): distribution folder shouldn't be part of the Git (#128) Jan 11, 2019
.npmignore refactor(npm): remove images from NPM build Jan 11, 2019
CONTRIBUTING.md fix(doc): updated contributing as per comment in #10 Mar 1, 2018
ISSUE_TEMPLATE.md fix(grouping): Filter & Grouping should work together, closes #90 (#91) Aug 18, 2018
LICENSE refactor(doc): updated contribution, issue template and license Feb 27, 2018
README.md refactor(readme): update a few of the print screens Jan 17, 2019
config.js initial commit Jan 7, 2017
karma.conf.js initial commit for the Complete Rewrite based on the work of Angular-… Oct 5, 2017
package.json add vscode task to copy scripts for easier Github update Jan 19, 2019
tsconfig.json feat(grid): Export to File (#15) Feb 26, 2018
tslint.json feat(grid): Export to File (#15) Feb 26, 2018
typings.json initial commit for the Complete Rewrite based on the work of Angular-… Oct 5, 2017

README.md

Aurelia-Slickgrid

License: MIT TypeScript npm version NPM downloads

One of the best javascript datagrid SlickGrid which was originally developed by @mleibman is now available to Aurelia. I have tried and 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).

SlickGrid Source

We will be using 6pac SlickGrid fork (the most active fork since the original @mleibman fork was closed some time ago by his author for personal reasons).

Goal

The goal is of course to be able to run SlickGrid within Aurelia but also to incorporate as much as possible the entire list of functionalities (and more) that SlickGrid offers (you can see a vast list of samples on the 6pac SlickGrid examples website).

Demo page

Aurelia-Slickgrid supports both Bootstrap 3 and Bootstrap 4, you can see a demo of each one below.

NPM Package

Aurelia-Slickgrid on NPM

Installation

Refer to the Wiki - HOWTO Step by Step

Wiki / Documentation

The Wiki is where all the documentation and instructions will go, so please consult the Aurelia-Slickgrid - Wiki before opening any issues. The Wiki - HOWTO is a great place to start with.

Main features

You can see some screenshots below and the instructions down below.

This is a work in progress, but so far here are some of the features that aurelia-slickgrid brings (on top of Slickgrid itself):

  • Easier use of SlickGrid within Aurelia as it is just a component (simply pass a column definitions and a dataset and you're good to go)
  • Bootstrap Theme with SASS variables for extra customization (if you create a theme, then please make a PR)
  • Auto-resize (boolean flag), will resize the datagrid viewport with available space, that includes when browser resize (basically takes available space from it's parent container)
  • Support all SlickGrid Controls and Plugins.
  • Row(s) Selection
  • Server side (backend) Services (filtering, sorting, pagination)
  • Some features of SlickGrid itself which are working out of the gate
    • Sort/Multi-Sort (client/server side)
    • Header Row with Filters (currently support Input and Select dropdown, multi-select is planned)
    • Inline Editors (a few defaults were added, and you can easily create custom ones too)
    • Formatters (this as well includes some defaults and they are customizable)
    • Optimized DataView which brings a lot of functionalities (sort, grouping, and more)
      • even server side data is saved back into a SlickGrid DataView to use these functionalities (e.g grouping)
    • All the SlickGrid Events are supported, see the Wiki
  • Pinned (aka frozen) Columns/Rows, see the Wiki

License

MIT License

Contributions/Comments

Contributions are welcome, this is what the community is for. If you wish to suggest something and/or want to make a PR (Pull Request), please feel free to do so.

Use it, like it?

You like and use this great library Aurelia-Slickgrid? You can always upvote ⭐️ and/or contribute :)

Like my work?

If you like my work, you can also support me with caffeine 😄 Buy Me a Coffee

Screenshots

Screenshots from the demo app with the Bootstrap theme (that is the only available theme, but there is a lot of SASS variables to make it look like Material, or other theme if you wish to. If you create a new theme, please submit a PR).

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

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

Default Slickgrid Example

Filter and Sort (clientside with DataView)

Slickgrid Server Side

Editors and/or onCellClick

Editors

Pinned (aka frozen) Columns/Rows

Slickgrid Server Side

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

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

Slickgrid Server Side