Camunda Modeler Plugin Helpers :electric_plug:


Helper functions and core utility exports for bundling your Camunda Modeler client plugins.

> [!WARNING]
> This library re-exposes core utilities that you want to use as you develop plug-ins for the Camunda Modeler.
> If a plug-in uses any of the utilities, i.e. React, then it must consume them via the respective helper export. Use our webpack plug-in to accomplish that automatically, or use a source mod / configure your plug-in bundler accordingly.

Usage

Install the plug-in:

``
npm install camunda-modeler-plugin-helpers
`

Use any of the exposed utilities.

API

$3

Register plugin to be passed as additional module:

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

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

registerBpmnJSPlugin(BpmnJSModule);
`

Register a custom moddle extension:

`javascript
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);
`

UI Components

`javascript
import Fill from 'camunda-modeler-plugin-helpers/components/Fill.js';

function MyReactExtension() {
return
};
`

Higher-Order Function Helpers

createTab - helper function to create Tab components to be used with the TabProvider via the Comp#createCachedState method.

Properties Panel

`js
import { useService } from 'camunda-modeler-plugin-helpers/vendor/bpmn-js-properties-panel';
import { useState } from 'camunda-modeler-plugin-helpers/vendor/@bpmn-io/properties-panel/preact/hooks';
`

Packages

$3

> [!NOTE]
> Should be used in place of react imports.

`javascript
import React, { useEffect } from 'camunda-modeler-plugin-helpers/vendor/react.js';
`

$3

> [!NOTE]
> This feature requires Camunda Modeler 5.38+.
> Should be used in place of @carbon/react imports.

`javascript
import { Button, Theme, TextInput } from 'camunda-modeler-plugin-helpers/vendor/@carbon/react';
import { Add } from 'camunda-modeler-plugin-helpers/vendor/@carbon/icons-react';;
``

Additional Resources

* camunda-modeler-webpack-plugin - Bundle your libraries for use within the Camunda Modeler

License

MIT