@bpmn-io/element-template-icon-renderer

A bpmn-js extension to render element template icons.

Use Extension

Install via npm:

npm install @bpmn-io/element-template-icon-renderer

Use in your bpmn-js powered editor:

import ElementTemplateIconRenderer from '@bpmn-io/element-template-icon-renderer';

const viewer = new BpmnViewer({
  additionalModules: [
    ...,
    ElementTemplateIconRenderer
  ]
});

Optionally you may configure where you read your icons from:

import ElementTemplateIconRenderer from '@bpmn-io/element-template-icon-renderer';

const viewer = new BpmnViewer({
  additionalModules: [
    ...,
    ElementTemplateIconRenderer
  ],
  elementTemplateIconRenderer: {
    iconProperty: 'foo:icon' // read from <bpmn:task foo:icon="..." />
  }
});

In case you want to model with the element template icons, make sure you include the respective moddle extension to create the icon, i.e. zeebe-bpmn-moddle:

import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe.json';

const modeler = new BpmnModeler({
  additionalModules: [
    ...,
    ElementTemplateIconRenderer
  ],
  moddleExtensions: {
    zeebe: zeebeModdle
  }
});

Run locally

To run the renderer example, execute:

npm start

Resources

• Issues
• Changelog

Changelog

All notable changes to @bpmn-io/element-template-icon-renderer are documented here. We use semantic versioning for releases.

Unreleased

_Note: Yet to be released changes appear here._

1.0.0

Re-release of v0.6.0.

0.6.0

• FEAT: render icons for all activities (#20, #22)

0.5.2

• FIX: pass attributes (#19)

0.5.1

• FIX: get handler for intermediate catch and throw events (#16)

0.5.0

• FEAT: support custom icons on all events (#6)
• DEPS: update dependencies

0.4.0

• FEAT: generalize utility (allow to choose icon property) (#8)
• FEAT: support icons on blank start events (#12)
• CHORE: rename to @bpmn-io/element-template-icon-renderer (#10)

Breaking Changes

• Renamed to @bpmn-io/element-template-icon-renderer

0.3.0

• DEPS: support bpmn-js@10
• DEPS: bump utility dependencies
• CHORE: make bpmn-js and diagram-js peer dependencies

0.2.0

• FEAT: enforce 18x18 icon size (#5)

0.1.2

• FIX: move modelerTemplateIcon to property (#3)

0.1.1

• FIX: add correct project URL

0.1.0

Initial version.