README.md
# Ember-ag-grid
[![Build Status](https://travis-ci.org/supersabillon/ember-ag-grid.svg?branch=master)](https://travis-ci.org/supersabillon/ember-ag-grid)
[![Ember Observer Score](http://emberobserver.com/badges/ember-ag-grid.svg)](http://emberobserver.com/addons/ember-ag-grid)
[![Code Climate](https://codeclimate.com/github/supersabillon/ember-ag-grid/badges/gpa.svg)](https://codeclimate.com/github/supersabillon/ember-ag-grid)
[![npm version](https://badge.fury.io/js/ember-ag-grid.svg)](https://badge.fury.io/js/ember-ag-grid)
Just a simple component to use [ag-grid](https://github.com/ceolter/ag-grid/).
## Installation
```
ember install ember-ag-grid
```
## Usage
*app/templates/components/grid-example.hbs*
```handlebars
{{ ag-grid gridOptions=gridOptions }}
```
*app/components/grid-example.js*
```javascript
gridOptions: {
columnDefs: [
{ headerName: "Product", field: "name" },
{ headerName: 'Units', field: 'units' },
{ headerName: 'Sales', field: 'sales' },
{ headerName: 'Profit', field: 'profit' }
],
rowData: [
{
name: 'Chips',
units: '223',
sales: '$54,335',
profit: '$545,454'
},
.
.
.
{
name: 'Towels',
units: '965',
sales: '$1,900',
profit: '$800'
}]
}
```
This addon supports the same options as the [ag-grid](https://github.com/ceolter/ag-grid/) library. These options are documented here: [https://www.ag-grid.com/documentation-main/documentation.php](https://www.ag-grid.com/documentation-main/documentation.php). Open up an issue if you find an option that does not work with this addon.
## Options
| name | default | description |
| --- | --- | --- |
| width | "100%" | Sets width of grid |
| height | "400px" | Sets height of grid |
| theme | "ag-fresh" | Themes provided by ag-Grid: ag-fresh, ag-blue, ag-dark, ag-bootstrap and ag-material |
Example:
```handlebars
{{ ag-grid gridOptions=gridOptions height="500px" width="800px" theme="ag-blue" }}
```
You could create a new theme and pass in the class name your theme uses:
```css
.newTheme .ag-root {
font-family: "Open Sans", sans-serif, Helvetica, Arial;
}
.newTheme .ag-cell {
padding: 8px;
}
```
```handlebars
{{ ag-grid gridOptions=gridOptions theme="newTheme" }}
```
## ag-Grid-Enterprise
To use [ag-Grid Enterprise](https://github.com/ceolter/ag-grid-enterprise) features set the following options:
*config/environment.js*
```javascript
var ENV = {
agGrid: {
useEnterprise: true,
licenseKey: 'YOUR_LICENSE_KEY'
}
}
```
## Changelog
## version 0.4.0
* Upgraded to ag-Grid 9.0.0 and ag-Grid-Enterprise 9.0.1 ([ag-Grid's changelog](https://www.ag-grid.com/change-log/changeLogIndex.php))
## version 0.3.1
* [BUGFIX] Fix error of gridOptions api not available on willDestroyElement hook
* [BUGFIX] Ensure super call is bounded
## version 0.3.0
* Upgraded to ag-Grid 8.0.1 and ag-Grid-Enterprise 8.0.1 ([ag-Grid's changelog](https://www.ag-grid.com/change-log/changeLogIndex.php))
### version 0.2.0
* Upgraded to ag-Grid 5.3.0 and ag-Grid-Enterprise 5.3.0 ([ag-Grid's changelog](https://www.ag-grid.com/change-log/changeLogIndex.php))
* Breaking change: Default height is now 400px. ([Read this issue](https://github.com/ceolter/ag-grid/issues/878))
## Running
* `ember server`
* Visit your app at http://localhost:4200.
## Running Tests
* `npm test` (Runs `ember try:testall` to test your addon against multiple Ember versions)
* `ember test`
* `ember test --server`