Skip to content

hakimio/ng-chartist

 
 

Repository files navigation

Angular Chartist

Greenkeeper badge npm version CircleCI

Demo

https://willsoto.github.io/ng-chartist/demo/

Table of contents

About

Chartist component for Angular 2

Installation

Install through npm:

npm install @angular/core ng-chartist chartist --save

Additionally typings for the chartist library need to be installed:

  • For TSC <= 1.8:
npm install -g typings --save
typings install -g dt~chartist --save
  • For TSC = 2.0+ typings can be installed through npm directly:
npm install @types/chartist --save-dev

Then use it in your app like so:

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

import { ChartistModule } from 'ng-chartist';

import { MyAppComponent } from './my-app';

@NgModule({
  imports: [ChartistModule],
  bootstrap: [MyAppComponent]
})
export class AppModule {}

Add chart styles to your app:

  • using .angular-cli.json:
"styles": [
  "scss/style.scss",
  "../node_modules/chartist/dist/chartist.css"
],
  • or in the index.html file with:
<link rel="stylesheet" href="//cdn.jsdelivr.net/chartist.js/latest/chartist.min.css">

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

Usage without a module bundler

<script src="node_modules/ng-chartist/dist/ng-chartist.js"></script>
<script>
    // everything is exported ngChartist namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here

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 8080 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

Apache-2.0

Packages

No packages published

Languages

  • TypeScript 64.0%
  • JavaScript 36.0%