sutterhealth-ui-toolkit-widgets-debug
v0.1.8
Published
This proyect was created by a yeoman generator:
Downloads
6
Readme
sutterhealth-ui-toolkit-widgets
General Notes
This proyect was created by a yeoman generator:
Building the module
On the root folder:
$ npm run build
You can build the module each time you modify a file:
$ npm run build:watch
Publishing the module
You will need an npmjs account and have publish rights on the module.
Login to your npm account on your console:
$ npm login
Modify the file dist/package.json
, update the version number
If this module is private, change the name
property to sutterhealth@ui-toolkit-widgets
Publish the module:
$ npm publish dist
Consuming your library
Once you have published your library to npm, you can import your library in any Angular application by running:
$ npm install sutterhealth-ui-toolkit-widgets --save
Once your library is imported, you can use its components, directives and pipes in your Angular application
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
// Import your library
import { WidgetsModule } from 'sutterhealth-ui-toolkit-widgets';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
// Specify your library as an import
WidgetsModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
Development
To consume your library before you publish it to npm, you can follow the following steps:
Compile your library files:
$ npm run build
From the sutterhealth-ui-toolkit-widgets/dist
directory, create a symlink in the global node_modules directory to the dist directory of your library:
$ cd dist
$ npm link
In your Angular project root folder, link the global sutterhealth-ui-toolkit-widgets
directory to node_modules of your App directory:
From your App directory,
$ npm link sutterhealth-ui-toolkit-widgets
Now, your Angular project will use your local builds as node module.
To unlink the library simply remove the library:
$ npm uninstall sutterhealth-ui-toolkit-widgets
sutterhealth-ui-toolkit-widgets
Demographic Header:
The header takes demographicData, appConfig and userObject, example:
<sh-demographic-header [appConfig]="appConfig" [demographicData]="demographicData" [userObject]="userObject"></sh-demographic-header>
Lint your module
To lint all *.ts
files:
$ npm run lint