Alfresco Core Component for Angular 2

Prerequisites

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

See it live: Login Quickstart

Install

Follow the 3 steps below:

1. Npm

   1npm install ng2-alfresco-login --save

2. Html

   Include these dependencies in your index.html page:

   1
   2<!-- Google Material Design Lite -->
   3<link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
   4<script src="node_modules/material-design-lite/material.min.js"></script>
   5<link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
   6
   7<!-- Load the Angular Material 2 stylesheet -->
   8<link href="node_modules/@angular/material/core/theming/prebuilt/deeppurple-amber.css" rel="stylesheet">
   9
   10<!-- Polyfill(s) for Safari (pre-10.x) -->
   11<script src="node_modules/intl/dist/Intl.min.js"></script>
   12<script src="node_modules/intl/locale-data/jsonp/en.js"></script>
   13
   14<!-- Polyfill(s) for older browsers -->
   15<script src="node_modules/core-js/client/shim.min.js"></script>
   16<script src="//cdnjs.cloudflare.com/ajax/libs/dom4/1.8.3/dom4.js"></script>
   17<script src="node_modules/element.scrollintoviewifneeded-polyfill/index.js"></script>
   18
   19<!-- Polyfill(s) for dialogs -->
   20<script src="node_modules/dialog-polyfill/dialog-polyfill.js"></script>
   21<link rel="stylesheet" type="text/css" href="node_modules/dialog-polyfill/dialog-polyfill.css" />
   22<style>._dialog_overlay { position: static !important; } </style>
   23
   24<!-- Modules  -->
   25<script src="node_modules/zone.js/dist/zone.js"></script>
   26<script src="node_modules/reflect-metadata/Reflect.js"></script>
   27<script src="node_modules/systemjs/dist/system.src.js"></script>

3. SystemJs

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

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

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

Basic usage

This component allow to authenticate to Alfresco One and Alfresco Activiti.

1<alfresco-login [providers]="'ALL'"></alfresco-login>

Usage example of this component :

main.ts

1import { NgModule, Component } from '@angular/core';
2import { BrowserModule } from '@angular/platform-browser';
3import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
4
5import { CoreModule, AlfrescoSettingsService, AlfrescoAuthenticationService } from 'ng2-alfresco-core';
6import { LoginModule } from 'ng2-alfresco-login';
7
8@Component({
9    selector: 'my-app',
10    template: `
11       <alfresco-login [providers]="'ALL'"
12                       [disableCsrf]="true"
13                       (onSuccess)="mySuccessMethod($event)"
14                       (onError)="myErrorMethod($event)">
15        </alfresco-login>`
16})
17export class AppComponent {
18
19    constructor(public auth: AlfrescoAuthenticationService,
20                private settingsService: AlfrescoSettingsService) {
21        settingsService.ecmHost = 'http://localhost:8080/';
22        settingsService.bpmHost = 'http://localhost:9999/';
23    }
24
25    mySuccessMethod($event) {
26        console.log('Success Login EventEmitt called with: ' + $event.value);
27    }
28
29    myErrorMethod($event) {
30        console.log('Error Login EventEmitt called with: ' + $event.value);
31    }
32}
33
34@NgModule({
35    imports: [
36        BrowserModule,
37        CoreModule.forRoot(),
38        LoginModule
39    ],
40    declarations: [ AppComponent ],
41    bootstrap:    [ AppComponent ]
42})
43export class AppModule { }
44
45platformBrowserDynamic().bootstrapModule(AppModule);

Properties

Name	Type	Default Value	Description
providers	string	ECM	Possible valid value are ECM, BPM or ALL. The default behaviour of this component will logged in only in the ECM . If you want log in in both system the correct value to use is ALL
disableCsrf	boolean	false	To prevent the CSRF Token from been submitted. Only for Activiti call
needHelpLink	string	''	It will change the url of the NEED HELP link in the footer
registerLink	string	''	It will change the url of the REGISTER link in the footer
logoImageUrl	string	Alfresco logo image	To change the logo image with a customised image
backgroundImageUrl	string	Alfresco background image	To change the background image with a customised image
fieldsValidation	{ [key: string]: any; }, extra?: { [key: string]: any; }		Use it to customise the validation rules of the login form
showRememberMe	boolean	false	Toggle Remember me checkbox visibility
showLoginActions	boolean	false	Toggle extra actions visibility (Need Help, Register, etc.)

Events

Name	Description
onSuccess	The event is emitted when the login is done
onError	The event is emitted when the login fails
executeSubmit	The event is emitted when the form is submitted

Change footer content

You can replace the entire content in the footer of the login component with your custom content.

1<alfresco-login ...>
2    <login-footer><template>My custom HTML for the footer</template></login-footer>
3</alfresco-login>`

Change header content

You can replace the entire content in the header of the login component with your custom content.

1<alfresco-login ...>
2    <login-header><template>My custom HTML for the header</template></login-header>
3</alfresco-login>`

Extra content

You can put additional html content between alfresco-login tags to get it rendered as part of the login dialog. This becomes handy in case you need extending it with custom input fields handled by your application or parent component:

1<alfresco-login ...>
2    <div>
3        <div>You extra content</div>
4    </div>
5</alfresco-login>

Here's an example of custom content:

Custom logo and background

It is possible changing logo and background images to custom values.

1<alfresco-login 
2    [backgroundImageUrl]="'http://images.freeimages.com/images/previews/638/wood-wall-for-background-1634466.jpg'"
3    [logoImageUrl]="'http://images.freeimages.com/images/previews/eac/honeybee-with-a-house-1633609.jpg'">
4</alfresco-login>

Should give you something like the following:

Alternatively you can bind to your component properties and provide values dynamically if needed:

1<alfresco-login
2    [backgroundImageUrl]="myCustomBackground"
3    [logoImageUrl]="myCustomLogo">
4</alfresco-login>

Customize Validation rules

If needed it is possible customise the validation rules of the login form. You can add/modify the default rules of the login form.

MyCustomLogin.component.html

1<alfresco-login 
2    [fieldsValidation]="customValidation"
3    #alfrescologin>
4</alfresco-login>

MyCustomLogin.component.ts

1
2export class MyCustomLogin {
3    customValidation: any;
4
5    constructor(public router: Router) {
6        this.customValidation = {
7            username: ['', Validators.compose([Validators.required, Validators.minLength(8), Validators.maxLength(10)])],
8            password: ['', Validators.required]
9        };
10    }
11
12    ngOnInit() {
13        this.alfrescologin.addCustomValidationError('username', 'minlength', 'Username must be at least 8 characters.');
14        this.alfrescologin.addCustomValidationError('username', 'maxlength', 'Username must not be longer than 11 characters.');
15    }
16}

Controlling form submit execution behaviour

If absolutely needed it is possible taking full control over form submit execution by means of executeSubmit event. This event is fired on form submit.

You can prevent default behaviour by calling event.preventDefault(). This allows for example having custom form validation scenarios and/or additional validation summary presentation.

Alternatively you may want just running additional code without suppressing default one.

MyCustomLogin.component.html

1<alfresco-login 
2    (executeSubmit)="validateForm($event)" 
3    #alfrescologin>
4</alfresco-login>

MyCustomLogin.component.ts

1export class MyCustomLogin {
2
3    validateForm(event: any) {
4        let values = event.values;
5        
6        // check if the username is in the blacklist
7        if (values.controls['username'].value === 'invalidUsername') {
8            this.alfrescologin.addCustomFormError('username', 'the
9            username is in blacklist');
10            event.preventDefault();
11        }
12    }
13    
14}

Please note that if event.preventDefault() is not called then default behaviour will also be executed after your custom code.

Build from sources

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

1npm install
2npm run build

Build the files and keep watching for changes

1npm run build:w

Running unit tests

1npm test

Running unit tests in browser

1npm test-browser

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

Code coverage

1npm run coverage

Demo

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

1cd demo
2npm install
3npm 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