aurelia-slickgrid

Aurelia-Slickgrid

Documentation

📕 Documentation website powered by GitBook.

Installation

Refer to the Docs - Quick Start and/or clone the Aurelia-Slickgrid Demos repository. Please review the Documentation website 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 aurelia-slickgrid

Install any optional Slickgrid-Universal dependencies, for example Excel Export

npm install @slickgrid-universal/excel-export

Demo page

Aurelia-Slickgrid works with all Bootstrap versions, you can see a demo of each one below. There are also extra styling themes for not just Bootstrap but also Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the Docs - SVG Icons

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

License

MIT License

Basic Grid

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

export class Example {
  columnDefinitions: Column[] = [];
  gridOptions: GridOption;
  dataset: any[] = [];

  constructor() {
    this.columnDefinitions = [
      { id: 'firstName', name: 'First Name', field: 'firstName'},
      { id: 'lastName', name: 'Last Name', field: 'lastName'},
      { id: 'age', name: 'Age', field: 'age' }
    ];
  }

  attached() {
    this.dataset = [
      { id: 1, firstName: 'John', lastName: 'Doe', age: 20 },
      { id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }
    ];
    this.gridOptions = { /*...*/ }; // optional grid options
  }
}

<aurelia-slickgrid
  grid-id="grid2"
  column-definitions.bind="columnDefinitions"
  grid-options.bind="gridOptions"
  dataset.bind="dataset">
</aurelia-slickgrid>