Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

bpmn-js-create-append-anything

bpmn-io17.1kMIT0.6.0

CI

bpmn-io

readme

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

changelog

Changelog

All notable changes to bpmn-js-create-append-anything are documented here. We use semantic versioning for releases.

Unreleased

_Note: Yet to be released changes appear here._

0.6.0

  • FEAT: add ad-hoc subprocess entry (#47)

0.5.2

  • FIX: correct expanded subprocess icon (#33)

0.5.1

  • FIX: use rule to decide whether to show context pad entry for appending (#27)

0.5.0

  • FEAT: update labels to be sentence case (#17)
  • CHORE: update dependencies

0.4.0

  • FEAT: move "Call Activity" to "Sub Processes" group in options menu (#14)

0.3.0

  • FEAT: base BPMN element entry removes element template instead of unlinking it (#11)

Breaking Changes

  • UnlinkTemplatesModule has been renamed to RemoveTemplatesModule. If importing the module directly, update your import accordingly.

0.2.1

  • FIX: apply icon hover colors (#10)

0.2.0

  • FEAT: load palette and context pad icons as html (#7)

0.1.0

Initial release