@navikt/ds-react 8.10.2 → 8.10.4

package/src/data/table/helpers/selection/SelectionSubtreeHelper.ts

@@ -0,0 +1,162 @@
+type SelectionKey = string | number;
+
+type SelectionStats = {
+  selectableCount: number;
+  selectedCount: number;
+};
+
+type SelectionSubtreeHelperArgs = {
+  childRowIdsById?: Map<SelectionKey, SelectionKey[]>;
+  disabledKeysSet: Set<SelectionKey>;
+  selectedKeysSet: Set<SelectionKey>;
+};
+
+/**
+ * Helper class for managing selection state in a tree structure.
+ * - It provides methods to get selectable keys in a subtree
+ * - Compute selection statistics for a subtree
+ * - Determine if a subtree is fully selected.
+ *
+ * Results of selection statistics are cached to optimize performance for repeated calls on the same subtree.
+ */
+class SelectionSubtreeHelper {
+  private childRowIdsById: Map<SelectionKey, SelectionKey[]>;
+  private disabledKeysSet: Set<SelectionKey>;
+  private selectedKeysSet: Set<SelectionKey>;
+  private selectionStatsCache = new Map<SelectionKey, SelectionStats>();
+
+  constructor({
+    childRowIdsById,
+    disabledKeysSet,
+    selectedKeysSet,
+  }: SelectionSubtreeHelperArgs) {
+    this.childRowIdsById = childRowIdsById ?? new Map();
+    this.disabledKeysSet = disabledKeysSet;
+    this.selectedKeysSet = selectedKeysSet;
+  }
+
+  getSelectableKeys(rootIds: SelectionKey[]): SelectionKey[] {
+    const visitedKeys = new Set<SelectionKey>();
+    const selectableKeys: SelectionKey[] = [];
+    const stack = [...rootIds].reverse();
+
+    while (stack.length > 0) {
+      const key = stack.pop();
+
+      if (key == null || visitedKeys.has(key)) {
+        continue;
+      }
+
+      visitedKeys.add(key);
+
+      if (!this.disabledKeysSet.has(key)) {
+        selectableKeys.push(key);
+      }
+
+      const childRowIds = this.childRowIdsById.get(key) ?? [];
+
+      for (
+        let childIndex = childRowIds.length - 1;
+        childIndex >= 0;
+        childIndex--
+      ) {
+        stack.push(childRowIds[childIndex]);
+      }
+    }
+
+    return selectableKeys;
+  }
+
+  /**
+   * Returns the number of selectable and selected rows in the subtree of the given root ID.
+   * Results are cached after the first computation to optimize repeated calls for the same root ID.
+   *
+   * The selectable count excludes disabled rows, and the selected count excludes disabled rows that are selected.
+   * The method is implemented iteratively to handle deep trees without hitting call stack limits.
+   *
+   * How it works:
+   * - Manually add root ID to stack to get processing going. Note that the ready-flag is `false`.
+   * - Pop stack until empty. For each entry:
+   * - - If entry is already cached, skip it.
+   * - - If entry is not ready, push it back as ready and push all its children as not ready.
+   * - - If entry is ready, compute its stats based on its own state and the stats of its children, then cache the result.
+   * - Since we add all the children to the stack after pushing element with ready: true, while "popping" the stack we will always encounter the children before their parent is ready, ensuring that the stats for all children are computed and cached before computing the stats for their parent.
+   * - Finally, return the cached stats for the root ID.
+   */
+  getSelectionStats(rootId: SelectionKey): SelectionStats {
+    const cachedStats = this.selectionStatsCache.get(rootId);
+
+    if (cachedStats) {
+      return cachedStats;
+    }
+
+    /* Compute subtree totals iteratively so deep trees do not depend on call stack depth. */
+    const stack: { key: SelectionKey; ready: boolean }[] = [
+      { key: rootId, ready: false },
+    ];
+
+    while (stack.length > 0) {
+      const entry = stack.pop();
+
+      if (!entry) {
+        continue;
+      }
+
+      if (this.selectionStatsCache.has(entry.key)) {
+        continue;
+      }
+
+      if (entry.ready) {
+        let selectableCount = this.disabledKeysSet.has(entry.key) ? 0 : 1;
+        let selectedCount =
+          !this.disabledKeysSet.has(entry.key) &&
+          this.selectedKeysSet.has(entry.key)
+            ? 1
+            : 0;
+
+        for (const childKey of this.childRowIdsById.get(entry.key) ?? []) {
+          const childStats = this.selectionStatsCache.get(childKey);
+
+          if (!childStats) {
+            continue;
+          }
+
+          selectableCount += childStats.selectableCount;
+          selectedCount += childStats.selectedCount;
+        }
+
+        this.selectionStatsCache.set(entry.key, {
+          selectableCount,
+          selectedCount,
+        });
+        continue;
+      }
+
+      stack.push({ key: entry.key, ready: true });
+
+      for (const childKey of this.childRowIdsById.get(entry.key) ?? []) {
+        if (!this.selectionStatsCache.has(childKey)) {
+          stack.push({ key: childKey, ready: false });
+        }
+      }
+    }
+
+    return (
+      this.selectionStatsCache.get(rootId) ?? {
+        selectableCount: 0,
+        selectedCount: 0,
+      }
+    );
+  }
+
+  isFullySelected(rootId: SelectionKey): boolean {
+    const stats = this.getSelectionStats(rootId);
+
+    return (
+      stats.selectableCount > 0 && stats.selectedCount === stats.selectableCount
+    );
+  }
+}
+
+export { SelectionSubtreeHelper };
+export type { SelectionKey, SelectionStats, SelectionSubtreeHelperArgs };

package/src/data/table/helpers/selection/getMultipleSelectProps.ts

@@ -1,11 +1,13 @@
 import type { CheckboxInputProps } from "../../../../form/checkbox/checkbox-input/CheckboxInput";
+import { SelectionSubtreeHelper } from "./SelectionSubtreeHelper";
 
 type GetMultipleSelectPropsArgs = {
   selectedKeysSet: Set<string | number>;
   selectedKeys: (string | number)[];
   setSelectedKeys: (keys: (string | number)[]) => void;
   disabledKeysSet: Set<string | number>;
-  allRowKeys: (string | number)[];
+  visibleRowIds: (string | number)[];
+  childRowIdsById?: Map<string | number, (string | number)[]>;
 };
 
 function getMultipleSelectProps({
@@ -13,34 +15,56 @@ function getMultipleSelectProps({
   selectedKeys,
   setSelectedKeys,
   disabledKeysSet,
-  allRowKeys,
+  visibleRowIds,
+  childRowIdsById,
 }: GetMultipleSelectPropsArgs) {
-  const allRowKeysSet = new Set(allRowKeys);
-  const selectableKeys = allRowKeys.filter((k) => !disabledKeysSet.has(k));
+  const subtreeHelper = new SelectionSubtreeHelper({
+    childRowIdsById,
+    disabledKeysSet,
+    selectedKeysSet,
+  });
 
-  const selectedSelectableCount = selectableKeys.filter((k) =>
+  // Header selection traverses the visible roots and skips already visited
+  // descendants, so expanded trees stay linear in the number of rows.
+  const headerSelectableKeys = subtreeHelper.getSelectableKeys(visibleRowIds);
+  const headerSelectableKeysSet = new Set(headerSelectableKeys);
+
+  const selectedSelectableCount = headerSelectableKeys.filter((k) =>
     selectedKeysSet.has(k),
   ).length;
 
   const allSelectableSelected =
-    selectableKeys.length > 0 &&
-    selectedSelectableCount === selectableKeys.length;
+    headerSelectableKeys.length > 0 &&
+    selectedSelectableCount === headerSelectableKeys.length;
 
   const indeterminate =
     selectedSelectableCount > 0 &&
-    selectedSelectableCount < selectableKeys.length;
+    selectedSelectableCount < headerSelectableKeys.length;
 
   const selectedKeysNotInView = selectedKeys.filter(
-    (k) => !allRowKeysSet.has(k),
+    (k) => !headerSelectableKeysSet.has(k),
   );
   const disabledSelected = selectedKeys.filter((k) => disabledKeysSet.has(k));
-  const preservedKeys = [...selectedKeysNotInView, ...disabledSelected];
+  const preservedKeys = [
+    ...new Set([...selectedKeysNotInView, ...disabledSelected]),
+  ];
+
+  const isGroupFullySelected = (key: string | number) => {
+    const groupStats = subtreeHelper.getSelectionStats(key);
+
+    return (
+      groupStats.selectableCount > 0 &&
+      groupStats.selectedCount === groupStats.selectableCount
+    );
+  };
 
   const handleToggleAll = () => {
     if (allSelectableSelected) {
       setSelectedKeys(preservedKeys);
     } else {
-      setSelectedKeys([...new Set([...preservedKeys, ...selectableKeys])]);
+      setSelectedKeys([
+        ...new Set([...preservedKeys, ...headerSelectableKeys]),
+      ]);
     }
   };
 
@@ -48,10 +72,16 @@ function getMultipleSelectProps({
     if (disabledKeysSet.has(key)) {
       return;
     }
-    if (selectedKeysSet.has(key)) {
-      setSelectedKeys(selectedKeys.filter((k) => k !== key));
+
+    const groupKeys = subtreeHelper.getSelectableKeys([key]);
+
+    if (isGroupFullySelected(key)) {
+      const groupKeysSet = new Set(groupKeys);
+      setSelectedKeys(
+        selectedKeys.filter((selectedKey) => !groupKeysSet.has(selectedKey)),
+      );
     } else {
-      setSelectedKeys([...selectedKeys, key]);
+      setSelectedKeys([...new Set([...selectedKeys, ...groupKeys])]);
     }
   };
 
@@ -60,13 +90,20 @@ function getMultipleSelectProps({
       onChange: handleToggleAll,
       checked: allSelectableSelected,
       indeterminate,
-      disabled: selectableKeys.length === 0,
-    }),
-    getRowCheckboxProps: (key: string | number): CheckboxInputProps => ({
-      onChange: () => handleToggleRow(key),
-      checked: selectedKeysSet.has(key),
-      disabled: disabledKeysSet.has(key),
+      disabled: headerSelectableKeys.length === 0,
     }),
+    getRowCheckboxProps: (key: string | number): CheckboxInputProps => {
+      const groupStats = subtreeHelper.getSelectionStats(key);
+
+      return {
+        onChange: () => handleToggleRow(key),
+        checked: isGroupFullySelected(key),
+        indeterminate:
+          groupStats.selectedCount > 0 &&
+          groupStats.selectedCount < groupStats.selectableCount,
+        disabled: disabledKeysSet.has(key),
+      };
+    },
     toggleSelection: handleToggleRow,
   };
 }

package/src/data/table/helpers/selection/selection.types.ts

@@ -10,6 +10,7 @@ type SelectionProps = {
    * When set to "single", only one row can be selected at a time (renders radio buttons).
    *
    * When set to "multiple", multiple rows can be selected (renders checkboxes).
+   * Nested rows use cascading selection, so selecting a parent toggles its descendants too.
    *
    * @default "none"
    */

package/src/data/table/helpers/table-keyboard.ts

@@ -16,8 +16,7 @@ type NavigationAction =
 
 /**
  * Maps keyboard events to navigation actions.
- * Supports arrow keys, Home/End (row navigation), Ctrl/Cmd+Home/End (table navigation),
- * and PageUp/PageDown (multi-row navigation).
+ * Supports arrow keys, Home/End (row navigation), Ctrl/Cmd+Home/End (table navigation).
  */
 function getNavigationAction(event: KeyboardEvent): NavigationAction | null {
   const key = event.key;

package/src/data/table/hooks/__tests__/useTableItems.test.ts

@@ -78,20 +78,39 @@ describe("useTableItems", () => {
       useTableItems({
         items: nestedRows,
         getRowId: (row) => row.id,
-        getSubRows,
-        defaultExpandedSubRowIds: ["a"],
+        subRows: {
+          getRows: getSubRows,
+          defaultExpandedRowIds: ["a"],
+        },
       }),
     );
 
     expect(getVisibleIds(result.current.items)).toEqual(["a", "a1", "a2", "b"]);
   });
 
+  test("collects direct child row ids even when nested rows are collapsed", () => {
+    const { result } = renderHook(() =>
+      useTableItems({
+        items: nestedRows,
+        getRowId: (row) => row.id,
+        subRows: { getRows: getSubRows },
+      }),
+    );
+
+    expect(result.current.childRowIdsById.get("a")).toEqual(["a1", "a2"]);
+    expect(result.current.childRowIdsById.get("a2")).toEqual(["a2a"]);
+    expect(result.current.childRowIdsById.get("b")).toEqual(["b1"]);
+  });
+
   test("uses the same fallback root id to reveal child rows when getRowId is omitted", () => {
     const { result } = renderHook(() =>
       useTableItems({
         items: fallbackRows,
-        getSubRows: (row) => row.subRows ?? [],
-        defaultExpandedSubRowIds: [0],
+        getRowId: (_, index) => index,
+        subRows: {
+          getRows: (row: any) => row.subRows ?? [],
+          defaultExpandedRowIds: [0],
+        },
       }),
     );
 
@@ -107,8 +126,10 @@ describe("useTableItems", () => {
         useTableItems({
           items: nestedRows,
           getRowId: (row) => row.id,
-          getSubRows,
-          expandedSubRowIds: expandedIds,
+          subRows: {
+            getRows: getSubRows,
+            expandedRowIds: expandedIds,
+          },
         }),
       {
         initialProps: { expandedIds: [] as (string | number)[] },