camunda-modeler-plugin-helpers

Helper functions for bundling your Camunda Modeler client plugins


Keywords
camunda, modeler, plugin, camunda-modeler
License
MIT
Install
npm install camunda-modeler-plugin-helpers@5.0.0-alpha.1

Documentation

As of version 3.0.0 this library exposes ES modules. Use an ES module aware bundler such as Webpack or Rollup to bundle it for the browser.

Camunda Modeler Plugin Helpers 🔌

Compatible with Camunda Modeler version 2.2

Helper functions for bundling your Camunda Modeler client plugins.

How to use

bpmn-js

Register plugin to be passed as additional module:

import {
  registerBpmnJSPlugin
} from 'camunda-modeler-plugin-helpers';

const BpmnJSModule = {
  __init__: [ 'myService' ],
  myService: [ 'type', ... ]
};

registerBpmnJSPlugin(BpmnJSModule);

Register a custom moddle extension:

import {
  registerBpmnJSModdleExtension
} from 'camunda-modeler-plugin-helpers';

var moddleDescriptor = {
  name: 'my descriptor',
  uri: 'http://example.my.company.localhost/schema/my-descriptor/1.0',
  prefix: 'mydesc',

  ...
};

registerBpmnJSModdleExtension(moddleDescriptor);

License

MIT