mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
129 lines
3.4 KiB
Markdown
129 lines
3.4 KiB
Markdown
# Alfresco Angular2 Components core
|
|
|
|
<p>
|
|
<a title='Build Status Travis' href="https://travis-ci.org/Alfresco/alfresco-ng2-components">
|
|
<img src='https://travis-ci.org/Alfresco/alfresco-ng2-components.svg?branch=master' alt='travis
|
|
Status' />
|
|
</a>
|
|
<a title='Build Status AppVeyor' href="https://ci.appveyor.com/project/alfresco/alfresco-ng2-components">
|
|
<img src='https://ci.appveyor.com/api/projects/status/github/Alfresco/alfresco-ng2-components' alt='travis
|
|
Status' />
|
|
</a>
|
|
<a href='https://codecov.io/gh/Alfresco/alfresco-ng2-components'>
|
|
<img src='https://img.shields.io/codecov/c/github/Alfresco/alfresco-ng2-components/master.svg?maxAge=2592000' alt='Coverage Status' />
|
|
</a>
|
|
<a href='https://www.npmjs.com/package/ng2-alfresco-core'>
|
|
<img src='https://img.shields.io/npm/dt/ng2-alfresco-core.svg' alt='npm downloads' />
|
|
</a>
|
|
<a href='https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE'>
|
|
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
|
|
</a>
|
|
<a href='https://www.alfresco.com/'>
|
|
<img src='https://img.shields.io/badge/style-component-green.svg?label=alfresco' alt='alfresco component' />
|
|
</a>
|
|
<a href='https://angular.io/'>
|
|
<img src='https://img.shields.io/badge/style-2-red.svg?label=angular' alt='angular 2' />
|
|
</a>
|
|
<a href='https://www.typescriptlang.org/docs/tutorial.html'>
|
|
<img src='https://img.shields.io/badge/style-lang-blue.svg?label=typescript' alt='typescript' />
|
|
</a>
|
|
<a href='https://www.alfresco.com/'>
|
|
<img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
|
|
</a>
|
|
</p>
|
|
|
|
Core library for other ng2-alfresco components.
|
|
This should be added as a dependency for any project using the components.
|
|
|
|
### Node
|
|
To correctly use this component check that on your machine is running Node version 5.0.0 or higher.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
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
|
|
<my-component [context-menu]="menuItems"></my-component>
|
|
<context-menu-holder></context-menu-holder>
|
|
```
|
|
|
|
```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:
|
|
|
|
```sh
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
### Build the files and keep watching for changes
|
|
|
|
```sh
|
|
$ npm run build:w
|
|
```
|
|
|
|
### Running unit tests
|
|
|
|
```sh
|
|
npm test
|
|
```
|
|
|
|
### Running unit tests in browser
|
|
|
|
```sh
|
|
npm test-browser
|
|
```
|
|
|
|
This task rebuilds all the code, runs tslint, license checks and other quality check tools
|
|
before performing unit testing.
|
|
|
|
### Code coverage
|
|
|
|
```sh
|
|
npm run coverage
|
|
``` |