lib-ng-employee-picker Angular Library

TODO Add a brief description of the components/services in the library.

References

• How to build a library for Angular apps
• Angular 6 Library

Quick Start

• Install the library:

  npm install --save @sec-spec/lib-ng-employee-picker

• Add imports to app.module.ts:

import { EmployeePickerModule } from '@sec-spec/lib-ng-employee-picker';
...
imports: [
  ...
  EmployeePickerModule,
  ...
]

• Add component into html:

<sis-employee-picker label="Hiring Manager"
  pickerType="full"
  (selectedEmployeeChange)="someFunction()"
>
</sis-employee-picker>

Label can be whatever you want the 'label' to be (eg. Hiring Manager, Recruiter etc) Picker has two (2) modes: full, compact

• Mode full: Shows label and typeahead/dropdown. Typeahead/dropdown is 60px tall.
• Mode compact: Does not show label. Still shows typeahead/dropdown. Typeahead/dropdown is shorter 40px.

Adding to the library

• Use the command below to generate a new component. Replace COMPONENT with the name of the component.

  ng generate component COMPONENT --project=lib-ng-employee-picker

• Add the component or service to the public API file projects/lib-ng-employee-picker/src/public_api.ts.

• Build the project:

  ./build.sh

• Test it. See the Testing section below.

• Publish the changes to npm:

  NOTE: Before publishing to npm, you have to update the version number in package.json. Follow the guidelines at semver.org.

  ./build.sh publish

Testing

The wrapper project is where you can test the library components and services.

• Add the component or service to src/app/app.module.ts.
• Import components/services in src/app/app.component.ts.
• Add components to src/app/app.component.html.
  • Run the application: ng serve
• Add unit tests to src/app.component.spec.ts.
  • Run tests: ng test

General Angular Documentation

This project was generated with Angular CLI version 6.0.0.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.