Skip to content

Commit f408e68

Browse files
philippfrommenikku
authored andcommitted
fix(README): fix Camunda properties docs
Closes #1001
1 parent 67d1867 commit f408e68

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -76,26 +76,25 @@ propertiesPanel.attachTo('#other-properties');
7676
```
7777

7878

79-
### Use with Camunda properties
79+
### Edit Camunda Properties
8080

81-
In order to be able to edit [Camunda](https://camunda.com) related properties, use the [camunda platform properties provider](https://github.com/bpmn-io/bpmn-js-properties-panel/tree/master/src/provider/camunda-platform).
82-
In addition, you need to define the `camunda` namespace via [camunda-bpmn-moddle](https://github.com/camunda/camunda-bpmn-moddle).
81+
To edit [Camunda](https://camunda.com) properties, you have to use a [moddle extension](https://github.com/bpmn-io/moddle) so bpmn-js is can read and write Camunda properties and use a provider so these properties are shown in the properties panel.
82+
83+
For example, to edit [Camunda 8](https://camunda.com/platform/) properties, use the [Camunda 8 moddle extension](https://github.com/camunda/zeebe-bpmn-moddle) and the [Camunda 8 provider](https://github.com/bpmn-io/bpmn-js-properties-panel/tree/master/src/provider/zeebe). Additionally, you should use [behaviors specific to Camunda 8](https://github.com/camunda/camunda-bpmn-js-behaviors?tab=readme-ov-file#camunda-8) to ensure parts of the model that are specific to Camunda 8 are maintained correctly.
8384

8485
```javascript
8586
import BpmnModeler from 'bpmn-js/lib/Modeler';
8687
import {
8788
BpmnPropertiesPanelModule,
8889
BpmnPropertiesProviderModule,
89-
90-
// use Camunda Platform properties provider
91-
CamundaPlatformPropertiesProviderModule
90+
ZeebePropertiesProviderModule // Camunda 8 provider
9291
} from 'bpmn-js-properties-panel';
9392

94-
// use Camunda BPMN Moddle extension
95-
import CamundaExtensionModule from 'camunda-bpmn-moddle/lib';
93+
// Camunda 8 moddle extension
94+
import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe';
9695

97-
// use Camunda BPMN namespace
98-
import camundaModdleDescriptors from 'camunda-bpmn-moddle/resources/camunda';
96+
// Camunda 8 behaviors
97+
import ZeebeBehaviorsModule from 'camunda-bpmn-js-behaviors/lib/camunda-cloud';
9998

10099
const modeler = new BpmnModeler({
101100
container: '#canvas',
@@ -105,14 +104,13 @@ const modeler = new BpmnModeler({
105104
additionalModules: [
106105
BpmnPropertiesPanelModule,
107106
BpmnPropertiesProviderModule,
108-
CamundaPlatformPropertiesProviderModule,
109-
CamundaExtensionModule
107+
ZeebePropertiesProviderModule,
108+
ZeebeBehaviorsModule
110109
],
111110
moddleExtensions: {
112-
camunda: camundaModdleDescriptors
111+
zeebe: zeebeModdle
113112
}
114113
});
115-
...
116114
```
117115

118116
### API

0 commit comments

Comments
 (0)