From 44ccfa7fb969c97d73261fc62d8acb18169c2685 Mon Sep 17 00:00:00 2001
From: Romain Lenzotti <rom.lenzotti@gmail.com>
Date: Fri, 22 Mar 2024 13:43:56 +0100
Subject: [PATCH] feat(react-formio): add possibility to give custom choices
 function to column property

---
 packages/config/package.json                  |  6 +--
 packages/react-formio-container/package.json  |  3 +-
 .../components/defaultCells.component.tsx     | 15 ++++--
 .../selectColumnFilter.component.spec.tsx     | 21 ++++++++
 .../filters/selectColumnFilter.component.tsx  | 50 ++++++++++++++-----
 .../table/hooks/useCustomTable.hook.tsx       | 32 +++++++++++-
 .../src/components/table/table.component.tsx  |  1 +
 .../table/utils/mapFormToColumns.tsx          |  9 ++--
 packages/redux-utils/package.json             |  3 +-
 packages/storybook/package.json               |  3 +-
 packages/tailwind-formio/package.json         |  6 +--
 packages/tailwind/package.json                |  4 +-
 12 files changed, 116 insertions(+), 37 deletions(-)

diff --git a/packages/config/package.json b/packages/config/package.json
index e0e29fe6..f07bfd0f 100644
--- a/packages/config/package.json
+++ b/packages/config/package.json
@@ -17,7 +17,5 @@
   "devDependencies": {
     "@tsed/tailwind": "2.2.3",
     "@tsed/yarn-workspaces": "1.19.3"
-  },
-  "dependencies": {},
-  "peerDependencies": {}
-}
\ No newline at end of file
+  }
+}
diff --git a/packages/react-formio-container/package.json b/packages/react-formio-container/package.json
index f51c6979..08f399aa 100644
--- a/packages/react-formio-container/package.json
+++ b/packages/react-formio-container/package.json
@@ -89,6 +89,5 @@
     "tooltip.js": {
       "optional": false
     }
-  },
-  "dependencies": {}
+  }
 }
diff --git a/packages/react-formio/src/components/table/components/defaultCells.component.tsx b/packages/react-formio/src/components/table/components/defaultCells.component.tsx
index a505e1e7..5091e2c6 100644
--- a/packages/react-formio/src/components/table/components/defaultCells.component.tsx
+++ b/packages/react-formio/src/components/table/components/defaultCells.component.tsx
@@ -1,18 +1,27 @@
 import React from "react";
 import { Row } from "react-table";
 
+import type { ExtendedCell } from "../hooks/useCustomTable.hook";
+
 export function DefaultCells<Data extends object = {}>({ row }: { row: Row<Data> }) {
   return (
     <>
-      {row.cells.map((cell, i) => {
-        const { hidden, colspan } = cell.column as any;
+      {row.cells.map((cell: ExtendedCell<Data>, i) => {
+        const { hidden, colspan } = cell.column;
 
         if (hidden) {
           return null;
         }
 
         return (
-          <td colSpan={colspan} {...cell.getCellProps()} key={`tableInstance.page.cells.${cell.value || "value"}.${i}`}>
+          <td
+            colSpan={colspan}
+            {...cell.getCellProps({
+              className: cell.column.className,
+              style: cell.column.style
+            })}
+            key={`tableInstance.page.cells.${cell.value || "value"}.${i}`}
+          >
             {cell.render("Cell") as any}
           </td>
         );
diff --git a/packages/react-formio/src/components/table/filters/selectColumnFilter.component.spec.tsx b/packages/react-formio/src/components/table/filters/selectColumnFilter.component.spec.tsx
index a82999fb..ef98be12 100644
--- a/packages/react-formio/src/components/table/filters/selectColumnFilter.component.spec.tsx
+++ b/packages/react-formio/src/components/table/filters/selectColumnFilter.component.spec.tsx
@@ -45,4 +45,25 @@ describe("SelectColumnFilter", () => {
     expect(screen.queryByText("select-choice-1")).toBeNull();
     expect(screen.getByText("fake-choice")).toBeDefined();
   });
+
+  it("should display select with custom choices (function)", async () => {
+    const mockSetFilter = jest.fn();
+    const props = {
+      name: "data.id",
+      setFilter: mockSetFilter,
+      column: {
+        id: "id",
+        preFilteredRows: [{ values: { id: "select-choice-1" } }, { values: { id: "select-choice-2" } }],
+        choices: () => [{ label: "fake-choice", value: "fake-choice" }]
+      }
+    };
+
+    render(
+      // @ts-ignore
+      <SelectColumnFilter {...props} />
+    );
+
+    expect(screen.queryByText("select-choice-1")).toBeNull();
+    expect(screen.getByText("fake-choice")).toBeDefined();
+  });
 });
diff --git a/packages/react-formio/src/components/table/filters/selectColumnFilter.component.tsx b/packages/react-formio/src/components/table/filters/selectColumnFilter.component.tsx
index 948196cd..ee7c4afe 100644
--- a/packages/react-formio/src/components/table/filters/selectColumnFilter.component.tsx
+++ b/packages/react-formio/src/components/table/filters/selectColumnFilter.component.tsx
@@ -3,24 +3,50 @@ import { FilterProps } from "react-table";
 
 import { Select } from "../../select/select.component";
 
-export function SelectColumnFilter<D extends Record<string, unknown> = {}>({ column }: FilterProps<D>) {
-  const { id, preFilteredRows, filterValue, setFilter } = column;
+export function useSelectColumnFilter<D extends Record<string, unknown> = {}>(props: FilterProps<D>) {
+  const { column } = props;
+  const { id, preFilteredRows } = column;
   const { choices: customChoices } = column as any;
+  const { filterValue, setFilter } = column;
 
-  const choices =
-    customChoices ||
-    [...new Set(preFilteredRows.map((row) => row.values[id]))].filter((value) => value).map((value) => ({ label: value, value }));
+  const choices = (() => {
+    if (customChoices) {
+      if (typeof customChoices === "function") {
+        return customChoices(props);
+      }
+      return customChoices;
+    }
+
+    return [...new Set(preFilteredRows.map((row) => row.values[id]))]
+      .filter((value) => value)
+      .map((value) => ({
+        label: value,
+        value
+      }));
+  })();
+
+  const onChange = (_: string, value: any) => {
+    setFilter(value || undefined);
+  };
+
+  return {
+    value: filterValue,
+    onChange,
+    choices: [{ value: "", label: "All" }].concat(choices)
+  };
+}
+
+export function SelectColumnFilter<D extends Record<string, unknown> = {}>(props: FilterProps<D>) {
+  const { value, choices, onChange } = useSelectColumnFilter(props);
 
   return (
     <Select
-      key={`filter-${column.id}`}
-      name={`filter-${column.id}`}
+      key={`filter-${props.column.id}`}
+      name={`filter-${props.column.id}`}
       size={"sm"}
-      value={filterValue}
-      choices={[{ value: "", label: "All" }].concat(choices)}
-      onChange={(name, value) => {
-        setFilter(value || undefined);
-      }}
+      value={value}
+      choices={choices}
+      onChange={onChange}
     />
   );
 }
diff --git a/packages/react-formio/src/components/table/hooks/useCustomTable.hook.tsx b/packages/react-formio/src/components/table/hooks/useCustomTable.hook.tsx
index 2b6ee616..83156af3 100644
--- a/packages/react-formio/src/components/table/hooks/useCustomTable.hook.tsx
+++ b/packages/react-formio/src/components/table/hooks/useCustomTable.hook.tsx
@@ -1,6 +1,18 @@
 import noop from "lodash/noop";
 import React, { PropsWithChildren, useEffect, useState } from "react";
-import { CellProps, FilterProps, Renderer, TableOptions, useFilters, useGroupBy, usePagination, useSortBy, useTable } from "react-table";
+import {
+  Cell,
+  CellProps,
+  Column,
+  FilterProps,
+  Renderer,
+  TableOptions,
+  useFilters,
+  useGroupBy,
+  usePagination,
+  useSortBy,
+  useTable
+} from "react-table";
 
 import { OnClickOperation, Operation, QueryOptions } from "../../../interfaces";
 import { Pagination as DefaultPagination } from "../../pagination/pagination.component";
@@ -11,7 +23,25 @@ import { DefaultColumnFilter } from "../filters/defaultColumnFilter.component";
 import { swapElements } from "../utils/swapElements";
 import { useOperations } from "./useOperations.hook";
 
+export interface ExtraColumnProps {
+  colspan?: number;
+  hidden?: boolean;
+  className?: string;
+  style?: React.CSSProperties;
+}
+
+export type ExtendedColumn<Data extends object = any> = Column<Data> & ExtraColumnProps;
+
+export type ExtendedCell<Data extends object = any> = Cell<Data, any> & {
+  column: ExtraColumnProps;
+};
+
 export interface TableProps<Data extends object = any> extends TableOptions<Data>, Partial<QueryOptions> {
+  /**
+   * extended columns interface
+   */
+  columns: ReadonlyArray<ExtendedColumn<Data>>;
+
   className?: string;
   /**
    * Call the listener when a filter / pagination  / sort change.
diff --git a/packages/react-formio/src/components/table/table.component.tsx b/packages/react-formio/src/components/table/table.component.tsx
index b108a51b..868f48f7 100644
--- a/packages/react-formio/src/components/table/table.component.tsx
+++ b/packages/react-formio/src/components/table/table.component.tsx
@@ -3,6 +3,7 @@ import React, { PropsWithChildren } from "react";
 
 import { DrapNDropContainer } from "./components/dragNDropContainer";
 import { TableProps, useCustomTable } from "./hooks/useCustomTable.hook";
+
 export function Table<Data extends object = any>(props: PropsWithChildren<TableProps<Data>>) {
   const {
     className,
diff --git a/packages/react-formio/src/components/table/utils/mapFormToColumns.tsx b/packages/react-formio/src/components/table/utils/mapFormToColumns.tsx
index 63c0abf8..f303cdcd 100644
--- a/packages/react-formio/src/components/table/utils/mapFormToColumns.tsx
+++ b/packages/react-formio/src/components/table/utils/mapFormToColumns.tsx
@@ -1,22 +1,23 @@
 import { Components, ExtendedComponentSchema } from "formiojs";
 import FormioUtils from "formiojs/utils";
 import React from "react";
-import { Column } from "react-table";
 
 import { FormSchema } from "../../../interfaces";
 import { DefaultCell } from "../components/defaultCell.component";
 import { SelectColumnFilter } from "../filters/selectColumnFilter.component";
+import { ExtendedColumn } from "../hooks/useCustomTable.hook";
 
-export function mapFormToColumns(form: FormSchema): Column[] {
-  const columns: Column[] = [];
+export function mapFormToColumns(form: FormSchema): ExtendedColumn[] {
+  const columns: ExtendedColumn[] = [];
 
   FormioUtils.eachComponent(form.components, (component: ExtendedComponentSchema) => {
     if (component.tableView && component.key) {
       const cmp: any = Components.create(component, {}, null, true);
 
-      const column: Column = {
+      const column: ExtendedColumn = {
         Header: component.label || component.title || component.key,
         accessor: `data.${component.key}`,
+        className: "text-center",
         Cell: (props: any) => <DefaultCell {...props} render={(value: any) => cmp.asString(value)} />
       };
 
diff --git a/packages/redux-utils/package.json b/packages/redux-utils/package.json
index 04ef7a38..d323fe9b 100644
--- a/packages/redux-utils/package.json
+++ b/packages/redux-utils/package.json
@@ -21,6 +21,5 @@
   "peerDependencies": {
     "react": "^18.2.0",
     "redux": "^4.0.5"
-  },
-  "dependencies": {}
+  }
 }
diff --git a/packages/storybook/package.json b/packages/storybook/package.json
index 47139c06..4aaa6da8 100644
--- a/packages/storybook/package.json
+++ b/packages/storybook/package.json
@@ -47,6 +47,5 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
-  },
-  "peerDependencies": {}
+  }
 }
diff --git a/packages/tailwind-formio/package.json b/packages/tailwind-formio/package.json
index 849ffe0a..e61ce9ba 100644
--- a/packages/tailwind-formio/package.json
+++ b/packages/tailwind-formio/package.json
@@ -34,7 +34,5 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
-  },
-  "dependencies": {},
-  "peerDependencies": {}
-}
\ No newline at end of file
+  }
+}
diff --git a/packages/tailwind/package.json b/packages/tailwind/package.json
index 2a030846..e199e952 100644
--- a/packages/tailwind/package.json
+++ b/packages/tailwind/package.json
@@ -33,7 +33,5 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
-  },
-  "dependencies": {},
-  "peerDependencies": {}
+  }
 }