ag-Grid Aurelia Component

This project contains the Aurelia Component for use with ag-Grid.

This repository is now deprecated. Please refer to the new mono-repo location here: https://github.com/ag-grid/ag-grid, with this specific Framework Project living here: ag-grid-aurelia.

Version 18.0.0 will be the last version in this repository. All future versions will be in the repository above.

Usage

Please refer to www.ag-grid.com for full documentation on ag-Grid and Aurelia integration. Also take a look a the provided examples at https://github.com/ag-grid/ag-grid-aurelia-example.

Frameworks Supported

Framework specific Getting Started guides: Angular 1 | Angular 2 | Aurelia Javascript | React | TypeScript VueJS | Web Components

In your main entry.

aurelia.use
    .standardConfiguration()
    .plugin('ag-grid-aurelia');

In your view model

import {GridOptions} from 'ag-grid';
export class MyGridPage {

    public gridOptions:GridOptions;

    constructor() {
        this.gridOptions = <GridOptions>{};
        this.gridOptions.rowData = [{id: 1, name: 'Shane'}, {id: 2, name: 'Sean'}];
    }

    public onGridReady(){
        console.log('Grid is ready!!');
        console.log('1st col field = ' + this.gridOptions.columnDefs[0].field);
    }

    public onIdClicked(row){
        console.log('id clicked ' + row.id);
    }
}

In your view template. Here we are adding columns using markup. ColumnDefs can be added from your view model if you wish.

<template>
    <div style="width: 100%; height: 350px;">
      <ag-grid-aurelia grid-options.bind="gridOptions" class="ag-material"
                       row-height.bind="48"
                       grid-ready.call="onGridReady()">
        <ag-grid-column header-name="My Group Column">
          <ag-grid-column header-name="Id" field="id">
              <ag-cell-template>
                <button md-button class="btn accent"  click.delegate="params.context.onIdClicked(params.data)">${params.value}</button>
              </ag-cell-template>
          </ag-grid-column>
          <ag-grid-column header-name="Name" field="name" >
          </ag-grid-column>
        </ag-grid-column>

      </ag-grid-aurelia>
    </div>

</template>

Building

To build:

• npm install

• npm install gulp -g

• npm install aurelia-framework

• npm install ag-grid

• (or: npm install [email protected] && npm install [email protected])

• npm run build