Skip to content

bpmn-io/bpmn-js-create-append-anything

Repository files navigation

bpmn-js-create-append-anything

CI

This module extends bpmn-js with a create and append anything modeling experience.

screenshot

Features

  • Create any BPMN element from the palette
  • Append any BPMN element from the context pad
  • Fully keyboard navigatable (N and A 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