Add a group by function as a prop to the ScenarioListOLD - Allowing o…

…utside users to specify a special group by function for dates
DHI · Jun 7, 2024 · a60637a · a60637a
1 parent 67b00aa
commit a60637a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/packages/react-components/src/Scenarios/ScenarioListOLD/ScenarioList.tsx b/packages/react-components/src/Scenarios/ScenarioListOLD/ScenarioList.tsx
@@ -25,6 +25,7 @@ const ScenarioListOLD = (props: ScenarioListOLDProps) => {
     nameField,
     timeZone,
     statusOverrideFunction,
+    groupByItemFunction,
   } = props;
   const [groupedScenarios, setGroupedScenarios] = useState<Dictionary<ScenarioOLD[]>>();
   const [selectedId, setSelectedId] = useState(selectedScenarioId);
@@ -42,9 +43,11 @@ const ScenarioListOLD = (props: ScenarioListOLDProps) => {
     setGroupedScenarios(
       showHour || showDate
         ? groupBy(scenarios, (scenario) => {
-            return scenario.dateTime && timeZone
-              ? format(utcToTz(scenario.dateTime, timeZone), 'yyyy-MM-dd')
-              : format(parseISO(scenario.dateTime), 'yyyy-MM-dd') || '';
+          return groupByItemFunction ?
+          groupByItemFunction(scenario, timeZone) : 
+          scenario.dateTime && timeZone
+            ? format(utcToTz(scenario.dateTime, timeZone), 'yyyy-MM-dd')
+            : format(parseISO(scenario.dateTime), 'yyyy-MM-dd') || '';
           })
         : groupBy(scenarios, (scenario) => scenario.dateTime),
     );

diff --git a/packages/react-components/src/Scenarios/ScenarioListOLD/types.ts b/packages/react-components/src/Scenarios/ScenarioListOLD/types.ts
@@ -65,6 +65,10 @@ interface ScenarioListOLDProps {
    * The function that returns the new status to override
    */
   statusOverrideFunction?: (scenario: Scenario) => StatusOverride;
+  /**
+   * The function that returns the item to be used for grouping by:
+   */
+  groupByItemFunction?: (scenario: Scenario, timeZone?: string) => string;
 }
 
 export default ScenarioListOLDProps;
diff --git a/packages/react-components/src/Scenarios/ScenariosOLD/Scenarios.tsx b/packages/react-components/src/Scenarios/ScenariosOLD/Scenarios.tsx
@@ -50,6 +50,7 @@ const ScenariosOLD = (props: ScenariosOLDProps) => {
     translations,
     timeZone,
     statusOverrideFunction,
+    groupByItemFunction,
   } = props;
 
   const [dialog, setDialog] = useState<GeneralDialogProps>();
@@ -419,6 +420,7 @@ const ScenariosOLD = (props: ScenariosOLDProps) => {
         status={status}
         timeZone={timeZone}
         statusOverrideFunction={statusOverrideFunction}
+        groupByItemFunction={groupByItemFunction}
       />
     );
   }

diff --git a/packages/react-components/src/Scenarios/ScenariosOLD/types.ts b/packages/react-components/src/Scenarios/ScenariosOLD/types.ts
@@ -153,6 +153,11 @@ interface ScenariosOLDProps {
    * The function that returns the new status to override
    */
   statusOverrideFunction?: (scenario: Scenario) => StatusOverride | {};
+
+  /**
+   * The function that returns the item to be used for grouping by:
+   */
+  groupByItemFunction?: (scenario: Scenario, timeZone?: string) => string;
 }
 
 interface dataFilterbyPropertyObj {