0.3.0 • Published 7 years ago

my-ngx-library v0.3.0

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

my-ngx-library - Angular library built with ❤ using ngx-library yeoman generator.

npm version Build Status Coverage Status dependency Status devDependency Status Greenkeeper Badge

Demo

View all the directives in action at https://sumitarora.github.io/my-ngx-library

Dependencies

  • Angular (requires Angular 2 or higher, tested with 2.0.0)

Installation

Install above dependencies via npm.

Now install my-ngx-library via:

npm install --save my-ngx-library

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for my-ngx-library:

map: {
  'my-ngx-library': 'node_modules/my-ngx-library/bundles/my-ngx-library.umd.js',
}

Once installed you need to import the main module:

import {MyNgModuleModule} from 'my-ngx-library';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice MyNgModuleModule.forRoot()):

import {MyNgModuleModule} from 'my-ngx-library';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [MyNgModuleModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import MyNgModuleModule:

import {MyNgModuleModule} from 'my-ngx-library';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [MyNgModuleModule, ...], 
})
export class OtherModule {
}

Usage

License

Copyright (c) 2017 Sumit Arora. Licensed under the MIT License (MIT)