@reader-bench/common

Installation

To install this library, run:

$ npm install @reader-bench/common --save

Consuming your library

Once you have published your library to npm, you can import your library in any Angular application by running:

$ npm install @reader-bench/common

and then from your Angular AppModule:

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import your library
import { ReaderBenchCommonModule } from '@reader-bench/common';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,

    // Specify your library as an import
    ReaderBenchCommonModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Once your library is imported, you can use its components, directives and pipes in your Angular application:

<!-- You can now use your library component in app.component.html -->
<h1>
  {{title}}
</h1>
<two-mode-graph [graph]="myGraph"></two-mode-graph>

Where myGraph is the your object containing the nodeList and edgeList.

Development

To generate all *.js, *.d.ts and *.metadata.json files:

$ npm run build

To lint all *.ts files:

$ npm run lint

To distribute the dist folder to npmjs:

$ npm publish dist --access public

Known issues

The current library does not work with D3.js v4.0 or higher.

License

MIT © Ionut Cristian Paraschiv