angular-table-utils

Angular2 data table utils

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Jul 20, 2017Mar 24, 2017Minified + gzip package size for angular-table-utils in KB

Readme

angular table utils

Build Status codecov npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

https://jbmarchetti.github.io/angular-table-utils/demo/

Table of contents

About

Installation

Install through npm:

npm install --save angular-table-utils

Then include in your apps module:

import { Component, NgModule } from '@angular/core';
import { AngularTableUtilsModule } from 'angular-table-utils';

@NgModule({
  imports: [
    AngularTableUtilsModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/angular-table-utils/bundles/angular-table-utils.umd.js"></script>
<script>
    // everything is exported angularTableUtils namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://jbmarchetti.github.io/angular-table-utils/docs/

Development

Prepare your environment

  • Install Node.js and NPM (should come with)
  • Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
    npm run release
    

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.