bpmn-js-create-append-anything
v0.5.2
Published
[![CI](https://github.com/bpmn-io/bpmn-js-create-append-anything/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/bpmn-js-create-append-anything/actions/workflows/CI.yml)
Downloads
13,460
Maintainers
Keywords
Readme
bpmn-js-create-append-anything
This module extends bpmn-js with a create and append anything modeling experience.
Features
- Create any BPMN element from the palette
- Append any BPMN element from the context pad
- Fully keyboard navigatable (
N
andA
to open the menus) - Integration with element templates through dedicated extension
- Create or append templated elements
- Apply template through the replace menu
Installation
Install via npm:
npm install bpmn-js-create-append-anything
Usage
Use as an extension for bpmn-js:
import {
CreateAppendAnythingModule
} from 'bpmn-js-create-append-anything';
const modeler = new BpmnModeler({
additionalModules: [
...,
CreateAppendAnythingModule,
CreateAppendElementTemplatesModule
]
});
If desired, integrate with element templates:
import {
CreateAppendAnythingModule,
CreateAppendElementTemplatesModule
} from 'bpmn-js-create-append-anything';
const modeler = new BpmnModeler({
additionalModules: [
...,
CreateAppendAnythingModule,
CreateAppendElementTemplatesModule
]
});
This relies on elementTemplates
to be provided via an external module, i.e. bpmn-js-element-templates.
Run locally
To get the development setup make sure to have NodeJS installed. As soon as you are set up, clone the project and execute
# install dependencies
npm install
# start a bpmn-js instance with the extension
npm start
# for regular BPMN elements only
npm run start:bpmn
License
MIT