@bpmn-io/properties-panel 3.20.1 → 3.22.0

package/dist/index.esm.js

@@ -3048,6 +3048,28 @@ function HeaderButton(props) {
   });
 }
 
+/**
+ * @typedef { {
+ *   [key: string]: string;
+ * } } TranslateReplacements
+ */
+
+/**
+ * A simple translation stub to be used for multi-language support.
+ * Can be easily replaced with a more sophisticated solution.
+ *
+ * @param {string} template to interpolate
+ * @param {TranslateReplacements} [replacements] a map with substitutes
+ *
+ * @return {string} the translated string
+ */
+function translateFallback(template, replacements) {
+  replacements = replacements || {};
+  return template.replace(/{([^}]+)}/g, function (_, key) {
+    return replacements[key] || '{' + key + '}';
+  });
+}
+
 function CollapsibleEntry(props) {
   const {
     element,
@@ -3055,7 +3077,8 @@ function CollapsibleEntry(props) {
     id,
     label,
     open: shouldOpen,
-    remove
+    remove,
+    translate = translateFallback
   } = props;
   const [open, setOpen] = useState(shouldOpen);
   const toggleOpen = () => setOpen(!open);
@@ -3071,9 +3094,7 @@ function CollapsibleEntry(props) {
       }
     }, [onShow, setOpen])
   };
-
-  // todo(pinussilvestrus): translate once we have a translate mechanism for the core
-  const placeholderLabel = '<empty>';
+  const placeholderLabel = translate('<empty>');
   return jsxs("div", {
     "data-entry-id": id,
     class: classnames('bio-properties-panel-collapsible-entry', open ? 'open' : ''),
@@ -3086,14 +3107,14 @@ function CollapsibleEntry(props) {
         children: label || placeholderLabel
       }), jsx("button", {
         type: "button",
-        title: "Toggle list item",
+        title: translate('Toggle list item'),
         class: "bio-properties-panel-arrow  bio-properties-panel-collapsible-entry-arrow",
         children: jsx(ArrowIcon, {
           class: open ? 'bio-properties-panel-arrow-down' : 'bio-properties-panel-arrow-right'
         })
       }), remove ? jsx("button", {
         type: "button",
-        title: "Delete item",
+        title: translate('Delete item'),
         class: "bio-properties-panel-remove-entry",
         onClick: remove,
         children: jsx(DeleteIcon, {})
@@ -3121,7 +3142,8 @@ function CollapsibleEntry(props) {
 function ListItem(props) {
   const {
     autoFocusEntry,
-    autoOpen
+    autoOpen,
+    translate = translateFallback
   } = props;
 
   // focus specified entry on auto open
@@ -3143,7 +3165,8 @@ function ListItem(props) {
     class: "bio-properties-panel-list-item",
     children: jsx(CollapsibleEntry, {
       ...props,
-      open: autoOpen
+      open: autoOpen,
+      translate: translate
     })
   });
 }
@@ -3160,7 +3183,8 @@ function ListGroup(props) {
     id,
     items,
     label,
-    shouldOpen = true
+    shouldOpen = false,
+    translate = translateFallback
   } = props;
   useEffect(() => {
     if (props.shouldSort != undefined) {
@@ -3168,57 +3192,25 @@ function ListGroup(props) {
     }
   }, [props.shouldSort]);
   const groupRef = useRef(null);
-  const [open, setOpen] = useLayoutState(['groups', id, 'open'], false);
+  const [open, setOpen] = useLayoutState(['groups', id, 'open'], shouldOpen);
   const [sticky, setSticky] = useState(false);
   const onShow = useCallback(() => setOpen(true), [setOpen]);
   const [localItems, setLocalItems] = useState([]);
-  const [newlyAddedItemIds, setNewlyAddedItemIds] = useState([]);
 
   // Flag to mark that add button was clicked in the last render cycle
   const [addTriggered, setAddTriggered] = useState(false);
   const prevElement = usePrevious(element);
-  const elementChanged = element !== prevElement;
-  const shouldHandleEffects = !elementChanged && shouldOpen;
-
-  // (0) delay setting items
-  //
-  // We need to this to align the render cycles of items
-  // with the detection of newly added items.
-  // This is important, because the autoOpen property can
-  // only set per list item on its very first render.
-  useEffect(() => {
-    setLocalItems(items);
-  }, [items]);
+  const toggleOpen = useCallback(() => setOpen(!open), [open]);
+  const openItemIds = element === prevElement && open && addTriggered ? getNewItemIds(items, localItems) : [];
 
-  // (1) handle auto opening when items were added
+  // reset local state after items changed
   useEffect(() => {
-    // reset addTriggered flag
+    setLocalItems(items);
     setAddTriggered(false);
-    if (shouldHandleEffects && localItems) {
-      if (addTriggered) {
-        const previousItemIds = localItems.map(item => item.id);
-        const currentItemsIds = items.map(item => item.id);
-        const newItemIds = currentItemsIds.filter(itemId => !previousItemIds.includes(itemId));
-
-        // open if not open, configured and triggered by add button
-        //
-        // TODO(marstamm): remove once we refactor layout handling for listGroups.
-        // Ideally, opening should be handled as part of the `add` callback and
-        // not be a concern for the ListGroup component.
-        if (!open && shouldOpen && newItemIds.length > 0) {
-          toggleOpen();
-        }
-        setNewlyAddedItemIds(newItemIds);
-      } else {
-        // ignore newly added items that do not result from a triggered add
-        setNewlyAddedItemIds([]);
-      }
-    }
-  }, [items, open, shouldHandleEffects, addTriggered, localItems]);
+  }, [items]);
 
   // set css class when group is sticky to top
   useStickyIntersectionObserver(groupRef, 'div.bio-properties-panel-scroll-container', setSticky);
-  const toggleOpen = () => setOpen(!open);
   const hasItems = !!items.length;
   const propertiesPanelContext = {
     ...useContext(LayoutContext),
@@ -3226,6 +3218,7 @@ function ListGroup(props) {
   };
   const handleAddClick = e => {
     setAddTriggered(true);
+    setOpen(true);
     add(e);
   };
   const allErrors = useErrors();
@@ -3262,20 +3255,22 @@ function ListGroup(props) {
         class: "bio-properties-panel-group-header-buttons",
         children: [add ? jsxs("button", {
           type: "button",
-          title: "Create new list item",
+          title: translate('Create new list item'),
           class: "bio-properties-panel-group-header-button bio-properties-panel-add-entry",
           onClick: handleAddClick,
           children: [jsx(CreateIcon, {}), !hasItems ? jsx("span", {
             class: "bio-properties-panel-add-entry-label",
-            children: "Create"
+            children: translate('Create')
           }) : null]
         }) : null, hasItems ? jsx("div", {
-          title: `List contains ${items.length} item${items.length != 1 ? 's' : ''}`,
+          title: translate(`List contains {numOfItems} item${items.length != 1 ? 's' : ''}`, {
+            numOfItems: items.length
+          }),
           class: classnames('bio-properties-panel-list-badge', hasError ? 'bio-properties-panel-list-badge--error' : ''),
           children: items.length
         }) : null, hasItems ? jsx("button", {
           type: "button",
-          title: "Toggle section",
+          title: translate('Toggle section'),
           class: "bio-properties-panel-group-header-button bio-properties-panel-arrow",
           children: jsx(ArrowIcon, {
             class: open ? 'bio-properties-panel-arrow-down' : 'bio-properties-panel-arrow-right'
@@ -3286,7 +3281,7 @@ function ListGroup(props) {
       class: classnames('bio-properties-panel-list', open && hasItems ? 'open' : ''),
       children: jsx(LayoutContext.Provider, {
         value: propertiesPanelContext,
-        children: localItems.map((item, index) => {
+        children: items.map((item, index) => {
           if (!item) {
             return;
           }
@@ -3295,20 +3290,27 @@ function ListGroup(props) {
           } = item;
 
           // if item was added, open it
-          // Existing items will not be affected as autoOpen is only applied on first render
-          const autoOpen = newlyAddedItemIds.includes(item.id);
+          // existing items will not be affected as autoOpen
+          // is only applied on first render
+          const autoOpen = openItemIds.includes(item.id);
           return createElement(ListItem, {
             ...item,
             autoOpen: autoOpen,
             element: element,
             index: index,
-            key: id
+            key: id,
+            translate: translate
           });
         })
       })
     })]
   });
 }
+function getNewItemIds(newItems, oldItems) {
+  const newIds = newItems.map(item => item.id);
+  const oldIds = oldItems.map(item => item.id);
+  return newIds.filter(itemId => !oldIds.includes(itemId));
+}
 
 function Checkbox(props) {
   const {