node package manager

ng2-alfresco-userinfo

Alfresco User Info Component for Angular 2

travis
    Status travis
    Status Coverage Status npm downloads license alfresco component angular 2 typescript node version

Prerequisites

Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration prerequisites.

Install

Follow the 3 steps below:

  1. Npm

    npm install ng2-alfresco-userinfo --save
  2. Html

    Include these dependencies in your index.html page:

     
      <!-- Google Material Design Lite -->
      <link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
      <script src="node_modules/material-design-lite/material.min.js"></script> 
      <link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
     
      <!-- Load the Angular Material 2 stylesheet -->
      <link href="node_modules/@angular/material/core/theming/prebuilt/deeppurple-amber.css" rel="stylesheet">
     
      <!-- Polyfill(s) for Safari (pre-10.x) -->
      <script src="node_modules/intl/dist/Intl.min.js"></script> 
      <script src="node_modules/intl/locale-data/jsonp/en.js"></script> 
     
      <!-- Polyfill(s) for older browsers -->
      <script src="node_modules/core-js/client/shim.min.js"></script> 
      <script src="//cdnjs.cloudflare.com/ajax/libs/dom4/1.8.3/dom4.js"></script> 
      <script src="node_modules/element.scrollintoviewifneeded-polyfill/index.js"></script> 
     
      <!-- Polyfill(s) for dialogs -->
      <script src="node_modules/dialog-polyfill/dialog-polyfill.js"></script> 
      <link rel="stylesheet" type="text/css" href="node_modules/dialog-polyfill/dialog-polyfill.css" />
      <style>._dialog_overlay { position: static !important; } </style> 
     
      <!-- Modules  -->
      <script src="node_modules/zone.js/dist/zone.js"></script> 
      <script src="node_modules/reflect-metadata/Reflect.js"></script> 
      <script src="node_modules/systemjs/dist/system.src.js"></script> 
     
  3. SystemJs

    Add the following components to your systemjs.config.js file:

    • ng2-translate
    • alfresco-js-api
    • ng2-alfresco-core
    • ng2-alfresco-userinfo

    Please refer to the following example file: systemjs.config.js . .

Basic usage

<ng2-alfresco-userinfo></ng2-alfresco-userinfo>

Properties

Name Type Default Description
ecmBackgroundImage string ng2-alfresco-userinfo/src/img/orangeBanner.gif Custom path for the background banner image for ECM users
bpmBackgroundImage string ng2-alfresco-userinfo/src/img/blueBanner.gif Custom path for the background banner image for BPM users
menuOpenType string right Custom choice for opening menu bottom : right or left
fallBackThumbnailImage string ng2-alfresco-userinfo/src/img/anonymous.gif Fallback image for profile when thubnail is missing

This will show a round icon with user and on click some user information are showed. If user is logged in with ECM and BPM the ECM image will be showed.

Build from sources

Alternatively you can build component from sources with the following commands:

npm install
npm run build

Build the files and keep watching for changes

$ npm run build:w

Running unit tests

npm test

Running unit tests in browser

npm test-browser

This task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.

Code coverage

npm run coverage

Demo

If you want have a demo of how the component works, please check the demo folder :

cd demo
npm install
npm start

NPM scripts

Command Description
npm run build Build component
npm run test Run unit tests in the console
npm run test-browser Run unit tests in the browser
npm run coverage Run unit tests and display code coverage report

License

Apache Version 2.0