@procore/data-table 14.13.0 → 14.14.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 14.14.0
+
+### Minor Changes
+
+- f15455d4a3: Add Expand/Collapse state persistence
+
+### Patch Changes
+
+- 1375fc5db2: Fix removeEventListener when unmounting GenericHeader
+- f41092bb36: `Pill` no longer converts text to uppercase by default. Customization must be done manually using `pillOptions`
+- cb8844fbdd: Fix issue with selected rows on ClientSide after Searching
+
 ## 14.13.0
 
 ### Minor Changes

package/dist/legacy/index.cjs

@@ -53436,7 +53436,7 @@ var Renderer9 = ({
   if (isGroup || rowPinned && columnDefinition.aggFunc) {
     return /* @__PURE__ */ React76__default.default.createElement(coreReact.Typography, { ...typographyProps, weight: "semibold" }, label);
   }
-  return /* @__PURE__ */ React76__default.default.createElement(coreReact.Pill, { color: getColor(value), className: cx10("pill-cell") }, label == null ? void 0 : label.toUpperCase());
+  return /* @__PURE__ */ React76__default.default.createElement(coreReact.Pill, { color: getColor(value), className: cx10("pill-cell") }, label);
 };
 var PillCellRenderer = withDataTableRenderer(Renderer9, "select");
 var Editor5 = React76__default.default.forwardRef(
@@ -53473,7 +53473,7 @@ var Editor5 = React76__default.default.forwardRef(
     function getLabel3(item) {
       var _a2;
       const unformattedLabel = ((_a2 = columnDefinition.getStringFormattedValue) == null ? void 0 : _a2.call(columnDefinition, item)) || "";
-      return unformattedLabel.toUpperCase();
+      return unformattedLabel;
     }
     return /* @__PURE__ */ React76__default.default.createElement(
       coreReact.PillSelect,
@@ -56625,9 +56625,10 @@ var GenericHeaderRenderer = (props) => {
     props.api.addEventListener("columnRowGroupChanged", updateExpandedState);
     return () => {
       props.column.removeEventListener("sortChanged", onSortChanged);
-      props.api.removeEventListener(
+      removeEventListenerFromGrid(
         "columnRowGroupChanged",
-        updateExpandedState
+        updateExpandedState,
+        props.api
       );
     };
   }, [props.column]);
@@ -57722,6 +57723,7 @@ var InternalTableContext = React76__default.default.createContext({
   getRowHeight: () => () => rowSize.md,
   grandTotalsLabelInnerRenderer: void 0,
   gridApi: void 0,
+  localStoragePersistenceKey: void 0,
   onBulkEditUpdate: () => Promise.resolve(),
   onServerSideDataRequest: void 0,
   onTableConfigChange: () => {
@@ -57738,6 +57740,7 @@ var InternalTableContext = React76__default.default.createContext({
   setRowHeight: () => {
   },
   showExpandCollapseAllToggle: false,
+  expandCollapseStateRef: null,
   tableRef: null,
   getColumnDefinition: () => void 0,
   setSelectedGroupIndex: () => {
@@ -78185,6 +78188,63 @@ var buildDetailRowsConfig_ = (detailRowConfig, {
   };
 };
 
+// src/utils/expandRows.ts
+var getGroupRowState = (gridApi, groupDefaultExpanded = 0) => {
+  const expandedRoutes = [];
+  const collapsedRoutes = [];
+  if (gridApi) {
+    gridApi.forEachNode((node) => {
+      const route = node.getRoute();
+      if (route) {
+        const routePath = route.join(",");
+        const defaultExpandLevel = groupDefaultExpanded === -1 ? Infinity : groupDefaultExpanded;
+        if (node.level > defaultExpandLevel - 1) {
+          if (node.expanded) {
+            expandedRoutes.push(routePath);
+          }
+        } else if (!node.expanded) {
+          collapsedRoutes.push(routePath);
+        }
+      }
+    });
+  }
+  return { expandedRoutes, collapsedRoutes };
+};
+var setExpandCollapseRow = (gridApi, tableConfig, groupDefaultExpanded = 0) => {
+  var _a, _b;
+  const expandedRoutes = ((_a = tableConfig.groupRowState) == null ? void 0 : _a.expandedRoutes) ?? [];
+  const collapsedRoutes = ((_b = tableConfig.groupRowState) == null ? void 0 : _b.collapsedRoutes) ?? [];
+  gridApi.forEachNode((node) => {
+    const route = node.getRoute();
+    if (route) {
+      const routePath = route.join(",");
+      const defaultExpandLevel = groupDefaultExpanded === -1 ? Infinity : groupDefaultExpanded;
+      if (node.level > defaultExpandLevel - 1) {
+        if (expandedRoutes.includes(routePath)) {
+          node.setExpanded(true);
+        }
+      } else if (collapsedRoutes.includes(routePath)) {
+        node.setExpanded(false);
+      }
+    }
+  });
+};
+var isRowOpenedByDefault = (node, tableConfig, groupDefaultExpanded = 0) => {
+  var _a, _b;
+  const expandedRoutes = ((_a = tableConfig == null ? void 0 : tableConfig.groupRowState) == null ? void 0 : _a.expandedRoutes) ?? [];
+  const collapsedRoutes = ((_b = tableConfig == null ? void 0 : tableConfig.groupRowState) == null ? void 0 : _b.collapsedRoutes) ?? [];
+  const route = node.getRoute();
+  if (!route) {
+    return false;
+  }
+  const routePath = route.join(",");
+  const defaultExpandLevel = groupDefaultExpanded === -1 ? Infinity : groupDefaultExpanded;
+  if (node.level > defaultExpandLevel - 1) {
+    return expandedRoutes.includes(routePath);
+  } else
+    return !collapsedRoutes.includes(routePath);
+};
+
 // src/utils/getRootRowNode.ts
 function getRootRowNode(rowNode) {
   return rowNode.level > 0 && rowNode.parent ? getRootRowNode(rowNode.parent) : rowNode;
@@ -80707,6 +80767,7 @@ var useTableApi = ({
   columnApi,
   columnDefinitions,
   gridApi,
+  groupDefaultExpanded,
   setLoadingStatus,
   wrapperRef
 }) => {
@@ -80900,10 +80961,33 @@ var useTableApi = ({
   const setSearchValue = React76__default.default.useCallback(
     (value) => {
       gridApi == null ? void 0 : gridApi.setQuickFilter(value);
+      gridApi == null ? void 0 : gridApi.forEachNodeAfterFilterAndSort((node) => {
+        if (node.id) {
+          const currentNode = rowSelectionRef == null ? void 0 : rowSelectionRef.current.affectedRows[node.id];
+          if (currentNode && currentNode.selectedState === rowSelectionState.selected) {
+            node.setSelected(true, false, "checkboxSelected");
+          }
+        }
+      });
       resetPagination();
+      gridApi == null ? void 0 : gridApi.redrawRows();
     },
-    [gridApi]
+    [gridApi, rowSelectionRef.current]
   );
+  React76__default.default.useEffect(() => {
+    function handleRowSelection(event) {
+      if (event.node.displayed && event.node.id) {
+        rowSelectionRef.current.affectedRows[event.node.id] = {
+          node: event.node,
+          selectedState: event.node.isSelected() ? rowSelectionState.selected : rowSelectionState.unselected
+        };
+      }
+    }
+    (gridApi == null ? void 0 : gridApi.addEventListener) && gridApi.addEventListener("rowSelected", handleRowSelection);
+    return () => {
+      removeEventListenerFromGrid("rowSelected", handleRowSelection, gridApi);
+    };
+  }, [gridApi]);
   const setLoading = React76__default.default.useCallback((loading, message = "") => {
     setLoadingStatus({
       loading,
@@ -80965,6 +81049,7 @@ var useTableApi = ({
           adjustRowDragIcon(gridApi, columnApi);
         });
       }
+      setExpandCollapseRow(gridApi, config, groupDefaultExpanded);
     },
     [columnApi, gridApi, internalSetRowHeight, filterStorage.setSelectedFilters]
   );
@@ -81058,7 +81143,8 @@ var useTableApi = ({
       columnApi,
       rowHeight,
       filterStorage,
-      rowSelectionRef
+      rowSelectionRef,
+      groupDefaultExpanded
     }),
     [columnApi, gridApi, rowHeight, filterStorage]
   );
@@ -81332,7 +81418,6 @@ function buildPartialTableApi({
     focusField && (gridApi == null ? void 0 : gridApi.setFocusedCell(rowIndex, focusField));
   };
   return {
-    getVisibleRowNodes,
     applyTransaction,
     applyServerSideTransaction,
     collapseAll,
@@ -81347,6 +81432,7 @@ function buildPartialTableApi({
     getSelectedRows: getSelectedRows2,
     getServerSideSelectionState,
     getTableConfiguration,
+    getVisibleRowNodes,
     refreshCells,
     setPinnedBottomRowData,
     setRowData,
@@ -81464,6 +81550,12 @@ var DataTable = ({
   const [rowHeight, setRowHeight] = React76__default.default.useState(
     (initialTableConfig == null ? void 0 : initialTableConfig.rowHeight) || rowSize.md
   );
+  const expandCollapseStateRef = React76__default.default.useRef(
+    (initialTableConfig == null ? void 0 : initialTableConfig.groupRowState) || {
+      expandedRoutes: [],
+      collapsedRoutes: []
+    }
+  );
   const rowHeightRef = React76__default.default.useRef(
     (initialTableConfig == null ? void 0 : initialTableConfig.rowHeight) || rowSize.md
   );
@@ -81511,12 +81603,14 @@ var DataTable = ({
       if (localStoragePersistenceKey) {
         webSdkStorage.storage.local.setItem(localStoragePersistenceKey, {
           ...config,
+          groupRowState: expandCollapseStateRef.current,
           rowHeight: rowHeightRef.current,
           serverFilters: filterStorage.filtersState
         });
       }
       onTableConfigChange == null ? void 0 : onTableConfigChange({
         ...config,
+        groupRowState: expandCollapseStateRef.current,
         rowHeight: rowHeightRef.current,
         serverFilters: filterStorage.filtersState
       });
@@ -81627,6 +81721,7 @@ var DataTable = ({
         onServerSideDataRequest,
         onTableConfigChange: internalOnTableConfigChange,
         rowSelectionRef,
+        expandCollapseStateRef,
         rowHeight,
         searchStorage,
         selectedGroupIndex,
@@ -81687,7 +81782,7 @@ function getServerSideDatasource(onServerSideDataRequestCallbackRef, onEmptyResp
 }
 var minimumColumnWidth = 140;
 var Table = (props) => {
-  var _a, _b;
+  var _a, _b, _c;
   const { suppressColumnVirtualisation = true, rowActionsConfig = {} } = props;
   const I18n = coreReact.useI18nContext();
   const internalTableContext = useInternalTableContext();
@@ -81729,8 +81824,10 @@ var Table = (props) => {
     columnDefinitions: internalTableContext.columnDefinitions,
     gridApi,
     setLoadingStatus,
-    wrapperRef
+    wrapperRef,
+    groupDefaultExpanded: props.groupDefaultExpanded
   });
+  const initialTableConfig = internalTableContext.initialTableConfig;
   React76__default.default.useImperativeHandle(internalTableContext.tableRef, () => tableApi, [
     tableApi
   ]);
@@ -82044,8 +82141,8 @@ var Table = (props) => {
   );
   const onColumnGroupOpened = React76__default.default.useCallback(
     (event) => {
-      var _a2, _b2, _c;
-      (_c = internalTableContext.analytics) == null ? void 0 : _c.client.addEvent(
+      var _a2, _b2, _c2;
+      (_c2 = internalTableContext.analytics) == null ? void 0 : _c2.client.addEvent(
         "design_system.data_table.column.expand_toggled",
         {
           client: internalTableContext.analytics.clientName,
@@ -82062,14 +82159,14 @@ var Table = (props) => {
   );
   const onColumnPinned = React76__default.default.useCallback(
     (event) => {
-      var _a2, _b2, _c, _d;
+      var _a2, _b2, _c2, _d;
       (_d = internalTableContext.analytics) == null ? void 0 : _d.client.addEvent(
         "design_system.data_table.column.pinned",
         {
           client: internalTableContext.analytics.clientName,
           column: (_a2 = event.column) == null ? void 0 : _a2.getColId(),
           side: (_b2 = event.column) == null ? void 0 : _b2.getPinned(),
-          position: (_c = columnApi == null ? void 0 : columnApi.getColumns()) == null ? void 0 : _c.findIndex(
+          position: (_c2 = columnApi == null ? void 0 : columnApi.getColumns()) == null ? void 0 : _c2.findIndex(
             (col) => {
               var _a3;
               return col.getId() === ((_a3 = event.column) == null ? void 0 : _a3.getColId());
@@ -82168,7 +82265,7 @@ var Table = (props) => {
   const onDragStopped = React76__default.default.useCallback(
     // eslint-disable-next-line complexity
     (event) => {
-      var _a2, _b2, _c;
+      var _a2, _b2, _c2;
       if (event.target.className.includes("ag-header-cell")) {
         internalTableContext.onTableConfigChange();
       }
@@ -82186,7 +82283,7 @@ var Table = (props) => {
           const firstVisibleColumnIndex = allColumns.findIndex(
             (col) => col.isVisible()
           );
-          if (moveColumnEvent.toIndex === firstVisibleColumnIndex || ((_c = moveColumnEvent.column) == null ? void 0 : _c.getColDef().rowDrag)) {
+          if (moveColumnEvent.toIndex === firstVisibleColumnIndex || ((_c2 = moveColumnEvent.column) == null ? void 0 : _c2.getColDef().rowDrag)) {
             adjustRowDragIcon(event.api, event.columnApi);
           }
         }
@@ -82265,27 +82362,55 @@ var Table = (props) => {
       (_a2 = document.getElementsByClassName("ag-body-viewport")[0]) == null ? void 0 : _a2.clientWidth
     );
   }, [setViewportWidth]);
+  const isClientSideGroupOpenByDefault = React76__default.default.useCallback(
+    (params) => {
+      const node = params.rowNode;
+      if (!node) {
+        return false;
+      }
+      return isRowOpenedByDefault(
+        node,
+        initialTableConfig,
+        props.groupsAlwaysExpanded ? -1 : props.groupDefaultExpanded
+      );
+    },
+    [initialTableConfig, props.groupDefaultExpanded]
+  );
+  const isServerSideGroupOpenByDefault = React76__default.default.useCallback(
+    (params) => {
+      const node = params.rowNode;
+      if (!node) {
+        return false;
+      }
+      return isRowOpenedByDefault(
+        node,
+        initialTableConfig,
+        props.groupsAlwaysExpanded ? -1 : props.groupDefaultExpanded
+      );
+    },
+    [initialTableConfig, props.groupDefaultExpanded]
+  );
   const onGridReady = (params) => {
-    var _a2, _b2, _c;
+    var _a2, _b2, _c2;
     internalTableContext.setGridApi(params.api);
     internalTableContext.setColumnApi(params.columnApi);
     setViewportWidth(
       (_a2 = document.getElementsByClassName("ag-body-viewport")[0]) == null ? void 0 : _a2.clientWidth
     );
-    (_c = (_b2 = props.UNSAFE_internalAGGridOverrides) == null ? void 0 : _b2.onGridReady) == null ? void 0 : _c.call(_b2, params);
+    (_c2 = (_b2 = props.UNSAFE_internalAGGridOverrides) == null ? void 0 : _b2.onGridReady) == null ? void 0 : _c2.call(_b2, params);
   };
   const postProcessPopup = (params) => {
     params.ePopup.style.top = `${HEADER_HEIGHT}px`;
   };
   const internalOnRowSelected = (event) => {
-    var _a2, _b2, _c;
+    var _a2, _b2, _c2;
     (_a2 = props.onRowSelected) == null ? void 0 : _a2.call(props, event);
     if (props.siblingGroupsRowSelectionDisabled) {
       const rootRowNode = getRootRowNode(event.node);
       if (!event.node.isSelected() && internalTableContext.selectedGroupIndex !== null && (rootRowNode == null ? void 0 : rootRowNode.id) === internalTableContext.selectedGroupIndex && event.api.getSelectedNodes().length === 0) {
         (_b2 = internalTableContext == null ? void 0 : internalTableContext.setSelectedGroupIndex) == null ? void 0 : _b2.call(internalTableContext, null);
       } else {
-        (_c = internalTableContext == null ? void 0 : internalTableContext.setSelectedGroupIndex) == null ? void 0 : _c.call(internalTableContext, (prevState) => {
+        (_c2 = internalTableContext == null ? void 0 : internalTableContext.setSelectedGroupIndex) == null ? void 0 : _c2.call(internalTableContext, (prevState) => {
           return prevState ?? (rootRowNode == null ? void 0 : rootRowNode.id) ?? null;
         });
       }
@@ -82294,13 +82419,26 @@ var Table = (props) => {
   const internalRowGroupOpened = React76__default.default.useCallback(
     (event) => {
       var _a2;
+      if (internalTableContext.expandCollapseStateRef) {
+        internalTableContext.expandCollapseStateRef.current = getGroupRowState(
+          gridApi,
+          props.groupDefaultExpanded
+        );
+      }
+      internalTableContext.onTableConfigChange();
       (_a2 = props.onRowGroupOpened) == null ? void 0 : _a2.call(props, {
         expanded: event.expanded,
         node: serializeNode(event.node),
         rowIndex: event.rowIndex
       });
     },
-    [props.onRowGroupOpened]
+    [
+      props.onRowGroupOpened,
+      internalTableContext.onTableConfigChange,
+      tableApi == null ? void 0 : tableApi.getTableConfiguration(),
+      (_c = internalTableContext.expandCollapseStateRef) == null ? void 0 : _c.current,
+      gridApi
+    ]
   );
   const getGroupRowAgg = React76__default.default.useCallback(
     (params) => {
@@ -82453,6 +82591,8 @@ var Table = (props) => {
             alwaysAggregateAtRootLevel: !onSSDR,
             autoGroupColumnDef: decoratedAutoGroupColDef,
             cacheBlockSize: props.paginationPageSize || defaultPaginationPageSize,
+            isGroupOpenByDefault: isClientSideGroupOpenByDefault,
+            isServerSideGroupOpenByDefault,
             defaultColDef,
             enableGroupEdit: internalTableContext.enableGroupEditAndValidation,
             enableCellTextSelection: internalTableContext.enableCellTextSelection,

package/dist/legacy/index.d.cts

@@ -792,6 +792,10 @@ interface DataTableConfig {
     } | undefined;
     rowHeight?: RowSize;
     serverFilters?: IServerFilter[];
+    groupRowState?: {
+        expandedRoutes: string[];
+        collapsedRoutes: string[];
+    };
 }
 interface HTMLStringExportConfig {
     header?: React.FunctionComponent;
@@ -1308,6 +1312,7 @@ interface InternalTableContext {
     onBulkEditUpdate: DataTableProps['onBulkEditUpdate'];
     onServerSideDataRequest?: DataTableProps['onServerSideDataRequest'];
     updateServerSideDataSource: (params: UpdateServerSideDataSourceParams) => void;
+    localStoragePersistenceKey?: string;
     onTableConfigChange: () => void;
     rowHeight: RowSize;
     rowSelectionRef?: React__default.MutableRefObject<RowSelectionRef>;
@@ -1317,6 +1322,10 @@ interface InternalTableContext {
     setGridApi: (gridApi: GridApi) => void;
     setRowHeight: (rowHeight: RowSize, createTrackEvent?: boolean, triggerTableConfigChange?: boolean) => void;
     showExpandCollapseAllToggle: boolean;
+    expandCollapseStateRef: React__default.MutableRefObject<{
+        expandedRoutes: string[];
+        collapsedRoutes: string[];
+    }> | null;
     tableRef: React__default.RefObject<TableApi> | null;
     getColumnDefinition: (field: string) => ColumnDefinition | undefined;
     totalRowCount: number;

package/dist/legacy/index.d.ts

@@ -792,6 +792,10 @@ interface DataTableConfig {
     } | undefined;
     rowHeight?: RowSize;
     serverFilters?: IServerFilter[];
+    groupRowState?: {
+        expandedRoutes: string[];
+        collapsedRoutes: string[];
+    };
 }
 interface HTMLStringExportConfig {
     header?: React.FunctionComponent;
@@ -1308,6 +1312,7 @@ interface InternalTableContext {
     onBulkEditUpdate: DataTableProps['onBulkEditUpdate'];
     onServerSideDataRequest?: DataTableProps['onServerSideDataRequest'];
     updateServerSideDataSource: (params: UpdateServerSideDataSourceParams) => void;
+    localStoragePersistenceKey?: string;
     onTableConfigChange: () => void;
     rowHeight: RowSize;
     rowSelectionRef?: React__default.MutableRefObject<RowSelectionRef>;
@@ -1317,6 +1322,10 @@ interface InternalTableContext {
     setGridApi: (gridApi: GridApi) => void;
     setRowHeight: (rowHeight: RowSize, createTrackEvent?: boolean, triggerTableConfigChange?: boolean) => void;
     showExpandCollapseAllToggle: boolean;
+    expandCollapseStateRef: React__default.MutableRefObject<{
+        expandedRoutes: string[];
+        collapsedRoutes: string[];
+    }> | null;
     tableRef: React__default.RefObject<TableApi> | null;
     getColumnDefinition: (field: string) => ColumnDefinition | undefined;
     totalRowCount: number;