mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
102 lines
2.6 KiB
Markdown
102 lines
2.6 KiB
Markdown
# <ng-2-activiti-processlist>
|
|
[![NPM version][npm-image]][npm-url]
|
|
[![Build Status][travis-image]][travis-url]
|
|
[![Dependency Status][daviddm-image]][daviddm-url]
|
|
[![Coverage percentage][coveralls-image]][coveralls-url]
|
|
[![Style guide][style-image]][style-url]
|
|
[![Alfresco component][alfrescocomponent-image]][alfrescocomponent-url]
|
|
|
|
## About ng-2-activiti-processlist
|
|
> Show available processes from the Activiti BPM suite
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install ng-2-activiti-processlist --save
|
|
```
|
|
|
|
## Example
|
|
|
|
```html
|
|
<ng-2-activiti-processlist></ng-2-activiti-processlist>
|
|
```
|
|
|
|
## Reference
|
|
|
|
Attribute | Options | Default | Description
|
|
--- | --- | --- | ---
|
|
`foo` | *string* | `bar` | Lorem ipsum dolor.
|
|
|
|
|
|
Method | Parameters | Returns | Description
|
|
--- | --- | --- | ---
|
|
`methodName()` | None. | void | Lorem ipsum dolor.
|
|
|
|
## Develop command list
|
|
|
|
|
|
* To test your component
|
|
|
|
```sh
|
|
$ npm run test
|
|
```
|
|
|
|
* To run the test in the browser
|
|
|
|
```sh
|
|
$ npm run test-browser
|
|
```
|
|
|
|
* To run the test coverage
|
|
|
|
```sh
|
|
$ npm run coverage
|
|
```
|
|
|
|
* To build the component
|
|
|
|
```sh
|
|
$ npm run build
|
|
```
|
|
|
|
* To build the component and keep watching the changes
|
|
|
|
```sh
|
|
$ npm run build:w
|
|
```
|
|
|
|
* To provide a live demo
|
|
|
|
```sh
|
|
$ cd demo
|
|
$ npm run start
|
|
```
|
|
|
|
* To clean npm_modules and typings folder
|
|
|
|
```sh
|
|
$ npm run clean
|
|
```
|
|
|
|
## History
|
|
|
|
For detailed changelog, check [Releases](https://github.com/Alfresco/ng-2-activiti-processlist/releases).
|
|
|
|
## Contributors
|
|
|
|
[Contributors](https://github.com/Alfresco/ng-2-activiti-processlist/graphs/contributors)
|
|
|
|
|
|
[npm-image]: https://badge.fury.io/js/ng-2-activiti-processlist.svg
|
|
[npm-url]: https://npmjs.org/package/ng-2-activiti-processlist
|
|
[travis-image]: https://travis-ci.org/Alfresco/ng-2-activiti-processlist.svg?branch=master
|
|
[travis-url]: https://travis-ci.org/Alfresco/ng-2-activiti-processlist
|
|
[daviddm-image]: https://david-dm.org/Alfresco/ng-2-activiti-processlist.svg?theme=shields.io
|
|
[daviddm-url]: https://david-dm.org/Alfresco/ng-2-activiti-processlist
|
|
[coveralls-image]: https://coveralls.io/repos/Alfresco/ng-2-activiti-processlist/badge.svg
|
|
[coveralls-url]: https://coveralls.io/r/Alfresco/ng-2-activiti-processlist
|
|
[style-url]: https://github.com/mgechev/angular2-style-guide
|
|
[style-image]: https://mgechev.github.io/angular2-style-guide/images/badge.svg
|
|
[alfrescocomponent-image]: https://img.shields.io/badge/Alfresco%20component-approved-green.svg
|
|
[alfrescocomponent-url]: https://www.alfresco.com
|