feat: show documentation field for templated elements

related to camunda/camunda-modeler#4037
bpmn-io · Jan 16, 2024 · 80321e3 · 80321e3
1 parent 58a2dd5
commit 80321e3
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 3 deletions.
diff --git a/src/cloud-element-templates/ElementTemplatesPropertiesProvider.js b/src/cloud-element-templates/ElementTemplatesPropertiesProvider.js
@@ -17,6 +17,7 @@ const LOWER_PRIORITY = 300;
 
 const ALWAYS_DISPLAYED_GROUPS = [
   'general',
+  'documentation',
   'multiInstance'
 ];
 

diff --git a/test/spec/cloud-element-templates/ElementTemplatesPropertiesProvider.spec.js b/test/spec/cloud-element-templates/ElementTemplatesPropertiesProvider.spec.js
@@ -199,7 +199,7 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
     }));
 
 
-    it('should show only general group, and template-related entries when entriesVisible is unset',
+    it('should show only general and documentation group, and template-related entries when entriesVisible is unset',
       inject(async function(elementRegistry, selection) {
 
         // given
@@ -213,13 +213,14 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
         // then
         expectOnlyGroups(container, [
           'general',
+          'documentation',
           'ElementTemplates__Template'
         ]);
       })
     );
 
 
-    it('should show only general group, and template-related entries when entriesVisible=false',
+    it('should show only general and documentation group, and template-related entries when entriesVisible=false',
       inject(async function(elementRegistry, selection) {
 
         // given
@@ -233,13 +234,14 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
         // then
         expectOnlyGroups(container, [
           'general',
+          'documentation',
           'ElementTemplates__Template'
         ]);
       })
     );
 
 
-    it('should show only general group, and template group when template is unknown',
+    it('should show only general and documentation group, and template group when template is unknown',
       inject(async function(elementRegistry, selection) {
 
         // given
@@ -253,6 +255,7 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
         // then
         expectOnlyGroups(container, [
           'general',
+          'documentation',
           'ElementTemplates__Template'
         ]);
       })
@@ -737,7 +740,32 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
         expect(group).to.exist;
       })
     );
+
+  });
+
+
+  describe('documentation', function() {
+
+    it('should display documentation section', inject(
+      async function(elementRegistry, selection, modeling, bpmnFactory) {
+
+        // given
+        const element = elementRegistry.get('Task_1');
+
+        // when
+        await act(() => {
+          selection.select(element);
+        });
+
+        // then
+        const group = domQuery('[data-group-id="group-documentation"]', container);
+
+        expect(group).to.exist;
+      })
+    );
+
   });
+
 });