README
Angular6 BPMN - BPMN
Warning
Library is under active development and may have breaking changes until stable 2.0.0 release or subsequent major versions after 2.0.0.
Getting started
bpmn
Step 1: Install NPM
npm install --save @dotgov/bpmn
Step 2: Import the component module
Consider that every DotGov Module including bpmn
must be imported next/in same context as DGSCoreModule
.
import { DGSCoreModule, DGSEnvironment } from '@dotgov/core';
import { BPMNModule } from '@dotgov/bpmn';
import { FormBuilderModule } from '@dotgov/formbuilder';
const dgsEnvironment: DGSEnvironment = {
debug: environment.debug,
apiUrl: environment.apiUrl,
defaultLanguage: {
Name: 'English',
Code: 'en',
Icon: 'fa fa-globe',
},
languages: [{
Name: 'English',
Code: 'en',
Icon: 'fa fa-globe',
}],
lowerCaseTranslates: true,
};
@NgModule({
declarations: [AppComponent],
imports: [
DGSCoreModule.forRoot(dgsEnvironment),
BPMNModule.forRoot(dgsEnvironment),
FormBuilderModule.forRoot(dgsEnvironment),
],
bootstrap: [AppComponent]
})
export class AppModule {}
Step 3: Include assets
To load assets like themes and pdf viewer its ncessary to include assets. IF you're using the Angular CLI, you can add this to your angular-cli.json
.
Note: Path to bpmn
bundle must set relative to basepath
inside angular-cli.json
.
"apps": {
...any,
"assets": [
...any,
{
"glob": "**/*",
"input": "../node_modules/@dotgov/bpmn/assets/",
"output": "./assets/"
}
],
...any,
}
API
Inputs
Input | Type | Default | Required | Description |
---|---|---|---|---|
url | string |
- | yes | Target url to be working with ( key for modeler to work ). |
preview | boolean |
true |
no | Render as preview or editable way. |
Outputs
Output | Type | Description |
---|---|---|
(onSave) | event |
Fired when user try to save modeler. |
Contributors
Contributor Name | Contributor Page |
---|---|
Grigore Meleca | grigoreme |
Mihail Racila | mracila25 |
Development
Setup build path
Open ng-package.json
and setup dest
to location where you want your build to go. (example: ../myProject/node_modules/@dotgov/bpmn
)
Build
npm run build
For more information read docs/developer_guide.md
Release
Use CI/CD for that.
Or just run npm run old_school_release
, of course if you have permissions ;)