From d26a66f9df3e007fab7b5679fc2b16e3531aaca4 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Mon, 20 Jun 2016 14:52:18 +0100 Subject: [PATCH] Update 'core' readme --- ng2-components/ng2-alfresco-core/README.md | 67 ++++++++++++++++--- .../src/components/document-list.ts | 21 ------ 2 files changed, 57 insertions(+), 31 deletions(-) diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md index bf81b602d9..3c7ddd44fa 100644 --- a/ng2-components/ng2-alfresco-core/README.md +++ b/ng2-components/ng2-alfresco-core/README.md @@ -1,4 +1,5 @@ -### Alfresco Angular2 Components core +# Alfresco Angular2 Components core +

license @@ -13,35 +14,81 @@ This should be added as a dependency for any project using the components. ## Install - ```sh npm set registry http://devproducts.alfresco.me:4873 npm install --save ng2-alfresco-core ``` +## Main components and services + +### Components + +- Context Menu directive + +#### Context Menu directive + +_See **Demo Shell** or **DocumentList** implementation for more details and use cases._ + +```html + + +``` + +```ts +@Component({ + selector: 'my-component +}) +export class MyComponent implements OnInit { + + menuItems: any[]; + + constructor() { + this.menuItems = [ + { title: 'Item 1', subject: new Subject() }, + { title: 'Item 2', subject: new Subject() }, + { title: 'Item 3', subject: new Subject() } + ]; + } + + ngOnInit() { + this.menuItems.forEach(l => l.subject.subscribe(item => this.commandCallback(item))); + } + + commandCallback(item) { + alert(`Executing ${item.title} command.`); + } + +} +``` + +### Services + +- Authentication Service +- Translation Service +- Context Menu Service ## Build from sources -Alternatively you can build component from sources with the following commands: +Alternatively you can build component from sources with the following commands: ```sh npm install npm run build ``` -##Build the files and keep watching for changes +### Build the files and keep watching for changes - ```sh - $ npm run build:w - ``` +```sh +$ npm run build:w +``` -## Running unit tests +### Running unit tests ```sh npm test ``` -## Running unit tests in browser +### Running unit tests in browser ```sh npm test-browser @@ -50,7 +97,7 @@ npm test-browser This task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing. -## Code coverage +### Code coverage ```sh npm run coverage diff --git a/ng2-components/ng2-alfresco-documentlist/src/components/document-list.ts b/ng2-components/ng2-alfresco-documentlist/src/components/document-list.ts index 61e8164458..fbba7a814e 100644 --- a/ng2-components/ng2-alfresco-documentlist/src/components/document-list.ts +++ b/ng2-components/ng2-alfresco-documentlist/src/components/document-list.ts @@ -119,29 +119,8 @@ export class DocumentList implements OnInit, AfterViewChecked, AfterContentInit, contextActionHandler: Subject = new Subject(); - testActions: any[]; - constructor( private _alfrescoService: AlfrescoService) { - - this.testActions = [ - { - title: 'Item 1', - subject: new Subject() - }, - { - title: 'Item 2', - subject: new Subject() - }, - { - title: 'Item 3', - subject: new Subject() - }, - { - title: 'Item 4', - subject: new Subject() - } - ]; } getContextActions(node: MinimalNodeEntity) {