Fix LegendWidget update logic for multiple legends case (#889)

CartoDB · Jul 22, 2024 · 48a293a · 48a293a
1 parent a8c90ef
commit 48a293a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Not released
 
+- fix LegendWidget update logic for multiple legends case [#889](https://github.com/CartoDB/carto-react/pull/889)
 - onStateChange callback for all widgets [#886](https://github.com/CartoDB/carto-react/pull/886)
 
 ## 3.0.0

diff --git a/packages/react-redux/src/slices/cartoSlice.js b/packages/react-redux/src/slices/cartoSlice.js
@@ -81,14 +81,15 @@ export const createCartoSlice = (initialState) => {
         const layer = state.layers[action.payload.id];
         if (layer) {
           const newLayer = { ...layer, ...action.payload.layerAttributes };
+          const hasLegendUpdate = layer.legend && newLayer.legend;
+          // Merge legend object if it's not an array (for the case of multiple legend objects per layer)
+          if (hasLegendUpdate && !Array.isArray(newLayer.legend)) {
+            newLayer.legend = { ...layer.legend, ...newLayer.legend };
+          }
 
           // TODO: Study if we should use a deepmerge fn
           state.layers[action.payload.id] = {
-            ...newLayer,
-            ...(layer.legend &&
-              newLayer.legend && {
-                legend: { ...layer.legend, ...newLayer.legend }
-              })
+            ...newLayer
           };
         }
       },

diff --git a/packages/react-widgets/src/widgets/LegendWidget.js b/packages/react-widgets/src/widgets/LegendWidget.js
@@ -1,4 +1,4 @@
-import React, { useState } from 'react';
+import React, { useMemo, useState } from 'react';
 import { updateLayer } from '@carto/react-redux/';
 import { LegendWidgetUI } from '@carto/react-ui';
 import { useDispatch, useSelector } from 'react-redux';
@@ -17,12 +17,13 @@ import { useMediaQuery } from '@mui/material';
  */
 function LegendWidget({ customLegendTypes, initialCollapsed, layerOrder = [], title }) {
   const dispatch = useDispatch();
-  const layers = useSelector((state) =>
+  const reduxLayers = useSelector((state) => state.carto.layers);
+  const layers = useMemo(() => {
     sortLayers(
-      Object.values(state.carto.layers).filter((layer) => !!layer.legend),
+      Object.values(reduxLayers).filter((layer) => !!layer.legend),
       layerOrder
-    ).filter((l) => !!l.legend)
-  );
+    ).filter((l) => !!l.legend);
+  }, [reduxLayers, layerOrder]);
 
   const [collapsed, setCollapsed] = useState(initialCollapsed);
   const isMobile = useMediaQuery((theme) => theme.breakpoints.down('sm'));