Skip to content
This repository

UI Grid: an Angular Data Grid

README.md

ng-grid : An Angular DataGrid

Build Status

Note: We are no longer accepting feature based pull requests based on the 2.* branch. All active feature development is happening in the 3.0 branch. PRs there are encouraged and will be celebrated with virtual high fives all around. If you are serious about helping 3.0 become a success, join the discussion at https://gitter.im/angular-ui/ng-grid

Contributors:

ng-grid Team:

License: MIT

Dependencies: jQuery & angular.js. (JqueryUi draggable for non-HTML5 compliant browsers to use awesome Drag-N-Drop aggregate feature. However, you can still groupby without draggability)


About

ng-grid Originally built on knockout we wanted to port it to angular.

version 2.0.9

nuGet

Questions, Comments, Complaints? feel free to email us at nggridteam@gmail.com


Roadmap

We are going to be adding more features here as we head to a 3.0 release, including:

  • Anything else the rest of the community wants to contribute that isn't a terrible idea. :)

The bare bones:

<script type="text/javascript" src="angular.js"></script>
<script type="text/javascript" src="ng-grid.js"></script>
<script>
    angular.module('myApp',['ngGrid', ... {other includes}]);
</script>
<link rel="stylesheet" type="text/css" href="../ng-grid.css" /> 
<body ng-app="myApp">
    <div ng-grid="myOptions"></div>
</body>
// Define your own controller somewhere..
function MyCtrl($scope) {
    $scope.myData = [{name: "Moroni", age: 50},
                     {name: "Teancum", age: 43},
                     {name: "Jacob", age: 27},
                     {name: "Nephi", age: 29},
                     {name: "Enos", age: 34}];
    $scope.myOptions = { data: 'myData' };
    // you can also specify data as: $scope.myOptions = { data: $scope.myData }. 
    // However, updates to the underlying data will not be reflected in the grid
};

Want More?

Check out the Getting Started and other Docs

Examples

Examples

Testing

The testing setup is based on the angular-seed project.

Make sure to set your CHROME_BIN environment variable to the full path to chrome.exe (not just its directory).

Grunt tasks

There are a few grunt tasks for running tests:

# Run unit tests
> grunt karma:unit
# Or use this alias:
> grunt test

# Run end-to-end tests (make sure to first start a web server as specified below)
> grunt karma:e2e

# Run midway tests
> grunt karma:midway

End-to-end tests

The e2e tests need a webserver to run. A simple one from the angular-seed project is included:

> ./scripts/web-server.js

Automated testing and building

Running this task will automatically rebuild build/ng-grid.debug.js when source files change, and run unit tests when build/ng-grid.debug.js or unit test files change. Youc an use this for testing during development.

# Run this in its own window
> grunt testwatch

Integration testing

There is a task for CI testing with PhantomJS

  1. Make sure the PHANTOMJS_BIN environment variable is set properly
  2. PhantomJS with the singleRun option doesn't appear to function properly in Windows. The tests will run but PhantomJS will not automatically close.
  3. This task first builds the debug version of the source files and does not clean them up. If you run it you will have uncommitted changes in your working directory that you probably want to lose. git checkout build to lose them.

    grunt test-ci

Selecting browsers

All the test tasks accept a --browsers command line option that will be passed to karma.

# Automatically re-run tests in both Chrome and FF.
grunt testwatch --browsers=Chrome,Firefox
Something went wrong with that request. Please try again.