refactor: remove title prop from document preview component schema

bpmn-io · Dec 10, 2024 · 0db4cb7 · 0db4cb7
1 parent 5b88f23
commit 0db4cb7
Show file tree

Hide file tree

Showing 11 changed files with 4 additions and 92 deletions.
diff --git a/packages/form-js-editor/src/features/properties-panel/Util.js b/packages/form-js-editor/src/features/properties-panel/Util.js
@@ -59,7 +59,7 @@ export function isProhibitedPath(path) {
   return path.split('.').some((segment) => prohibitedSegments.includes(segment));
 }
 
-export const LABELED_NON_INPUTS = ['button', 'group', 'dynamiclist', 'iframe', 'table'];
+export const LABELED_NON_INPUTS = ['button', 'group', 'dynamiclist', 'iframe', 'table', 'documentPreview'];
 
 export const INPUTS = [
   'checkbox',

diff --git a/packages/form-js-editor/src/features/properties-panel/entries/LabelEntry.js b/packages/form-js-editor/src/features/properties-panel/entries/LabelEntry.js
@@ -156,6 +156,7 @@ function getLabelText(type) {
     case 'table':
       return 'Table label';
     case 'iframe':
+    case 'documentPreview':
       return 'Title';
     default:
       return 'Field label';

diff --git a/packages/form-js-editor/src/features/properties-panel/entries/TitleEntry.js b/packages/form-js-editor/src/features/properties-panel/entries/TitleEntry.js
diff --git a/packages/form-js-editor/src/features/properties-panel/entries/index.js b/packages/form-js-editor/src/features/properties-panel/entries/index.js
@@ -42,7 +42,6 @@ export { StaticColumnsSourceEntry } from './StaticColumnsSourceEntry';
 export { VersionTagEntry } from './VersionTagEntry';
 export { AcceptEntry } from './AcceptEntry';
 export { MultipleEntry } from './MultipleEntry';
-export { TitleEntry } from './TitleEntry';
 export { DocumentsDataSourceEntry } from './DocumentsDataSource';
 export { EndpointKeyEntry } from './EndpointKey';
 export { MaxHeightEntry } from './MaxHeightEntry';
diff --git a/packages/form-js-editor/src/features/properties-panel/groups/GeneralGroup.js b/packages/form-js-editor/src/features/properties-panel/groups/GeneralGroup.js
@@ -26,7 +26,6 @@ import {
   VersionTagEntry,
   AcceptEntry,
   MultipleEntry,
-  TitleEntry,
   DocumentsDataSourceEntry,
   EndpointKeyEntry,
 } from '../entries';
@@ -36,7 +35,6 @@ export function GeneralGroup(field, editField, getService) {
     ...IdEntry({ field, editField }),
     ...VersionTagEntry({ field, editField }),
     ...LabelEntry({ field, editField }),
-    ...TitleEntry({ field, editField }),
     ...DescriptionEntry({ field, editField }),
     ...KeyEntry({ field, editField, getService }),
     ...PathEntry({ field, editField, getService }),

diff --git a/packages/form-js-viewer/test/spec/documentPreview.json b/packages/form-js-viewer/test/spec/documentPreview.json
@@ -1,7 +1,7 @@
 {
   "components": [
     {
-      "title": "Case {{case_id}} documents",
+      "label": "Case {{case_id}} documents",
       "type": "documentPreview",
       "id": "Field_0wy8tws",
       "dataSource": "=my_documents",

diff --git a/packages/form-json-schema/src/defs/component.json b/packages/form-json-schema/src/defs/component.json
@@ -273,11 +273,6 @@
       "description": "Allow multiple files to be selected.",
       "type": ["boolean", "string"]
     },
-    "title": {
-      "$id": "#/component/title",
-      "description": "The title displayed on top of the document preview component.",
-      "type": "string"
-    },
     "maxHeight": {
       "$id": "#/component/maxHeight",
       "description": "The maximum height of a document item in the document preview component.",

diff --git a/packages/form-json-schema/src/defs/rules/rules-allowed-properties.json b/packages/form-json-schema/src/defs/rules/rules-allowed-properties.json
@@ -465,7 +465,6 @@
       },
       "then": {
         "properties": {
-          "title": false,
           "endpointKey": false,
           "maxHeight": false
         }

diff --git a/packages/form-json-schema/test/fixtures/documentPreview.js b/packages/form-json-schema/test/fixtures/documentPreview.js
@@ -4,7 +4,7 @@ export const form = {
     {
       type: 'documentPreview',
       dataSource: '=someSource',
-      title: 'My documents',
+      label: 'My documents',
       endpointKey: '=someEndpointKey',
       maxHeight: 100,
     },

diff --git a/packages/form-json-schema/test/fixtures/title-not-allowed.js b/packages/form-json-schema/test/fixtures/title-not-allowed.js
diff --git a/packages/form-json-schema/test/spec/validation.spec.js b/packages/form-json-schema/test/spec/validation.spec.js
@@ -183,8 +183,6 @@ describe('validation', function () {
 
     testForm('documentPreview');
 
-    testForm('title-not-allowed');
-
     testForm('maxHeight-not-allowed');
 
     testForm('endpointKey-not-allowed');