@itwin/itwinui-react 3.11.3 → 3.12.1

package/esm/core/Table/TableRowMemoized.js

@@ -1,86 +1,150 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 import cx from 'classnames';
-import { Box, useIntersection, useMergedRefs, WithCSSTransition, } from '../../utils/index.js';
+import {
+  Box,
+  useIntersection,
+  useMergedRefs,
+  WithCSSTransition,
+} from '../../utils/index.js';
 import { TableCell } from './TableCell.js';
-/**
- * Memoization is needed to avoid unnecessary re-renders of all rows when additional data is added when lazy-loading.
- * Using `isLast` here instead of passing data length to avoid re-renders of all rows when more data is added. Now only the last row re-renders.
- * Although state is not used it is needed for `React.memo` to check state that changes row state e.g. selection.
- * When adding new features check whether it changes state that affects row. If it does then add equality check to `React.memo`.
- */
 export const TableRow = (props) => {
-    const { row, rowProps, isLast, onRowInViewport, onBottomReached, intersectionMargin, onClick, subComponent, isDisabled, tableHasSubRows, tableInstance, expanderCell, scrollContainerRef, tableRowRef, density, } = props;
-    const onIntersect = React.useCallback(() => {
-        onRowInViewport.current?.(row.original);
-        isLast && onBottomReached.current?.();
-    }, [isLast, onBottomReached, onRowInViewport, row.original]);
-    const intersectionRoot = React.useMemo(() => {
-        const isTableScrollable = (scrollContainerRef?.scrollHeight ?? 0) >
-            (scrollContainerRef?.offsetHeight ?? 0);
-        // If table body is scrollable, make it the intersection root
-        if (isTableScrollable) {
-            return scrollContainerRef;
-        }
-        // Otherwise, make the viewport the intersection root
-        return undefined;
-    }, [scrollContainerRef]);
-    const intersectionRef = useIntersection(onIntersect, {
-        rootMargin: `${intersectionMargin}px`,
-        root: intersectionRoot,
-    });
-    const userRowProps = rowProps?.(row) ?? {};
-    const { status, isLoading, ...restUserRowProps } = userRowProps;
-    const mergedProps = {
-        ...row.getRowProps({ style: { flex: `0 0 auto`, minWidth: '100%' } }),
-        ...restUserRowProps,
-        ...{
-            className: cx('iui-table-row', {
-                'iui-table-row-expanded': row.isExpanded && subComponent,
-                'iui-loading': isLoading,
-            }, userRowProps?.className),
-            'aria-selected': row.isSelected || undefined,
-            'aria-disabled': isDisabled || undefined,
-            'data-iui-status': status,
+  const {
+    row,
+    rowProps,
+    isLast,
+    onRowInViewport,
+    onBottomReached,
+    intersectionMargin,
+    onClick,
+    subComponent,
+    isDisabled,
+    tableHasSubRows,
+    tableInstance,
+    expanderCell,
+    scrollContainerRef,
+    tableRowRef,
+    density,
+  } = props;
+  const onIntersect = React.useCallback(() => {
+    onRowInViewport.current?.(row.original);
+    isLast && onBottomReached.current?.();
+  }, [isLast, onBottomReached, onRowInViewport, row.original]);
+  const intersectionRoot = React.useMemo(() => {
+    const isTableScrollable =
+      (scrollContainerRef?.scrollHeight ?? 0) >
+      (scrollContainerRef?.offsetHeight ?? 0);
+    if (isTableScrollable) {
+      return scrollContainerRef;
+    }
+    return undefined;
+  }, [scrollContainerRef]);
+  const intersectionRef = useIntersection(onIntersect, {
+    rootMargin: `${intersectionMargin}px`,
+    root: intersectionRoot,
+  });
+  const userRowProps = rowProps?.(row) ?? {};
+  const { status, isLoading, ...restUserRowProps } = userRowProps;
+  const mergedProps = {
+    ...row.getRowProps({
+      style: {
+        flex: `0 0 auto`,
+        minWidth: '100%',
+      },
+    }),
+    ...restUserRowProps,
+    ...{
+      className: cx(
+        'iui-table-row',
+        {
+          'iui-table-row-expanded': row.isExpanded && subComponent,
+          'iui-loading': isLoading,
+        },
+        userRowProps?.className,
+      ),
+      'aria-selected': row.isSelected || undefined,
+      'aria-disabled': isDisabled || undefined,
+      'data-iui-status': status,
+    },
+  };
+  const refs = useMergedRefs(intersectionRef, mergedProps.ref, tableRowRef);
+  return React.createElement(
+    React.Fragment,
+    null,
+    React.createElement(
+      Box,
+      {
+        ...mergedProps,
+        ref: refs,
+        onClick: (event) => {
+          mergedProps?.onClick?.(event);
+          onClick?.(event, row);
         },
-    };
-    const refs = useMergedRefs(intersectionRef, mergedProps.ref, tableRowRef);
-    return (React.createElement(React.Fragment, null,
-        React.createElement(Box, { ...mergedProps, ref: refs, onClick: (event) => {
-                mergedProps?.onClick?.(event);
-                onClick?.(event, row);
-            } }, row.cells.map((cell, index) => {
-            return (React.createElement(TableCell, { key: cell.getCellProps().key, cell: cell, cellIndex: index, isDisabled: isDisabled, tableHasSubRows: tableHasSubRows, tableInstance: tableInstance, expanderCell: expanderCell, density: density }));
-        })),
-        subComponent && (React.createElement(WithCSSTransition, { in: row.isExpanded },
-            React.createElement(Box, { className: cx('iui-table-row', 'iui-table-expanded-content'), "aria-disabled": isDisabled }, subComponent(row))))));
+      },
+      row.cells.map((cell, index) => {
+        return React.createElement(TableCell, {
+          key: cell.getCellProps().key,
+          cell: cell,
+          cellIndex: index,
+          isDisabled: isDisabled,
+          tableHasSubRows: tableHasSubRows,
+          tableInstance: tableInstance,
+          expanderCell: expanderCell,
+          density: density,
+        });
+      }),
+    ),
+    subComponent &&
+      React.createElement(
+        WithCSSTransition,
+        {
+          in: row.isExpanded,
+        },
+        React.createElement(
+          Box,
+          {
+            className: cx('iui-table-row', 'iui-table-expanded-content'),
+            'aria-disabled': isDisabled,
+          },
+          subComponent(row),
+        ),
+      ),
+  );
 };
 const hasAnySelectedSubRow = (row, selectedRowIds) => {
-    if (selectedRowIds?.[row.id]) {
-        return true;
-    }
-    return row.subRows.some((subRow) => hasAnySelectedSubRow(subRow, selectedRowIds));
+  if (selectedRowIds?.[row.id]) {
+    return true;
+  }
+  return row.subRows.some((subRow) =>
+    hasAnySelectedSubRow(subRow, selectedRowIds),
+  );
 };
-export const TableRowMemoized = React.memo(TableRow, (prevProp, nextProp) => prevProp.isLast === nextProp.isLast &&
+export const TableRowMemoized = React.memo(
+  TableRow,
+  (prevProp, nextProp) =>
+    prevProp.isLast === nextProp.isLast &&
     prevProp.state.hiddenColumns?.length ===
-        nextProp.state.hiddenColumns?.length &&
-    !!prevProp.state.hiddenColumns?.every((column, index) => nextProp.state.hiddenColumns?.[index] === column) &&
+      nextProp.state.hiddenColumns?.length &&
+    !!prevProp.state.hiddenColumns?.every(
+      (column, index) => nextProp.state.hiddenColumns?.[index] === column,
+    ) &&
     prevProp.onRowInViewport === nextProp.onRowInViewport &&
     prevProp.onBottomReached === nextProp.onBottomReached &&
     prevProp.onClick === nextProp.onClick &&
     prevProp.row.original === nextProp.row.original &&
     prevProp.state.selectedRowIds?.[prevProp.row.id] ===
-        nextProp.state.selectedRowIds?.[nextProp.row.id] &&
-    // Check if sub-rows selection has changed and whether to show indeterminate state or not
-    prevProp.row.subRows.some((subRow) => hasAnySelectedSubRow(subRow, prevProp.state.selectedRowIds)) ===
-        nextProp.row.subRows.some((subRow) => hasAnySelectedSubRow(subRow, nextProp.state.selectedRowIds)) &&
+      nextProp.state.selectedRowIds?.[nextProp.row.id] &&
+    prevProp.row.subRows.some((subRow) =>
+      hasAnySelectedSubRow(subRow, prevProp.state.selectedRowIds),
+    ) ===
+      nextProp.row.subRows.some((subRow) =>
+        hasAnySelectedSubRow(subRow, nextProp.state.selectedRowIds),
+      ) &&
     prevProp.state.expanded?.[prevProp.row.id] ===
-        nextProp.state.expanded?.[nextProp.row.id] &&
+      nextProp.state.expanded?.[nextProp.row.id] &&
     prevProp.subComponent === nextProp.subComponent &&
-    prevProp.row.cells.every((cell, index) => nextProp.row.cells[index].column === cell.column) &&
+    prevProp.row.cells.every(
+      (cell, index) => nextProp.row.cells[index].column === cell.column,
+    ) &&
     prevProp.isDisabled === nextProp.isDisabled &&
     prevProp.rowProps === nextProp.rowProps &&
     prevProp.expanderCell === nextProp.expanderCell &&
@@ -90,7 +154,8 @@ export const TableRowMemoized = React.memo(TableRow, (prevProp, nextProp) => pre
     !nextProp.state.columnResizing.isResizingColumn &&
     prevProp.state.isTableResizing === nextProp.state.isTableResizing &&
     prevProp.state.sticky.isScrolledToLeft ===
-        nextProp.state.sticky.isScrolledToLeft &&
+      nextProp.state.sticky.isScrolledToLeft &&
     prevProp.state.sticky.isScrolledToRight ===
-        nextProp.state.sticky.isScrolledToRight &&
-    prevProp.density === nextProp.density);
+      nextProp.state.sticky.isScrolledToRight &&
+    prevProp.density === nextProp.density,
+);

package/esm/core/Table/actionHandlers/expandHandler.d.ts

@@ -1,2 +1,2 @@
 import type { TableInstance, TableState } from '../../../react-table/react-table.js';
-export declare const onExpandHandler: <T extends Record<string, unknown>>(newState: TableState<T>, instance?: TableInstance<T> | undefined, onExpand?: ((expandedData: T[] | undefined, tableState?: TableState<T> | undefined) => void) | undefined) => void;
+export declare const onExpandHandler: <T extends Record<string, unknown>>(newState: TableState<T>, instance?: TableInstance<T>, onExpand?: (expandedData: T[] | undefined, tableState?: TableState<T>) => void) => void;

package/esm/core/Table/actionHandlers/expandHandler.js

@@ -1,13 +1,13 @@
 export const onExpandHandler = (newState, instance, onExpand) => {
-    if (!instance?.preFilteredFlatRows.length) {
-        onExpand?.([], newState);
-        return;
+  if (!instance?.preFilteredFlatRows.length) {
+    onExpand?.([], newState);
+    return;
+  }
+  const expandedData = [];
+  instance.preFilteredFlatRows.forEach((row) => {
+    if (newState.expanded[row.id]) {
+      expandedData.push(row.original);
     }
-    const expandedData = [];
-    instance.preFilteredFlatRows.forEach((row) => {
-        if (newState.expanded[row.id]) {
-            expandedData.push(row.original);
-        }
-    });
-    onExpand?.(expandedData, newState);
+  });
+  onExpand?.(expandedData, newState);
 };

package/esm/core/Table/actionHandlers/filterHandler.d.ts

@@ -1,3 +1,3 @@
 import type { ActionType, TableInstance, TableState } from '../../../react-table/react-table.js';
 import type { TableFilterValue } from '../filters/index.js';
-export declare const onFilterHandler: <T extends Record<string, unknown>>(newState: TableState<T>, action: ActionType, previousState: TableState<T>, currentFilter: TableFilterValue<T>[], instance?: TableInstance<T> | undefined) => TableFilterValue<T>[];
+export declare const onFilterHandler: <T extends Record<string, unknown>>(newState: TableState<T>, action: ActionType, previousState: TableState<T>, currentFilter: TableFilterValue<T>[], instance?: TableInstance<T>) => TableFilterValue<T>[];

package/esm/core/Table/actionHandlers/filterHandler.js

@@ -1,16 +1,24 @@
-export const onFilterHandler = (newState, action, previousState, currentFilter, instance) => {
-    const previousFilter = previousState.filters.find((f) => f.id === action.columnId);
-    if (previousFilter?.value != action.filterValue) {
-        const filters = newState.filters.map((f) => {
-            const column = instance?.allColumns.find((c) => c.id === f.id);
-            return {
-                id: f.id,
-                value: f.value,
-                fieldType: column?.fieldType ?? 'text',
-                filterType: column?.filter ?? 'text',
-            };
-        });
-        return filters;
-    }
-    return currentFilter;
+export const onFilterHandler = (
+  newState,
+  action,
+  previousState,
+  currentFilter,
+  instance,
+) => {
+  const previousFilter = previousState.filters.find(
+    (f) => f.id === action.columnId,
+  );
+  if (previousFilter?.value != action.filterValue) {
+    const filters = newState.filters.map((f) => {
+      const column = instance?.allColumns.find((c) => c.id === f.id);
+      return {
+        id: f.id,
+        value: f.value,
+        fieldType: column?.fieldType ?? 'text',
+        filterType: column?.filter ?? 'text',
+      };
+    });
+    return filters;
+  }
+  return currentFilter;
 };

package/esm/core/Table/actionHandlers/index.js

@@ -1,8 +1,8 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 export { onExpandHandler } from './expandHandler.js';
 export { onFilterHandler } from './filterHandler.js';
-export { onToggleHandler, onSingleSelectHandler, onShiftSelectHandler, } from './selectHandler.js';
+export {
+  onToggleHandler,
+  onSingleSelectHandler,
+  onShiftSelectHandler,
+} from './selectHandler.js';
 export { onTableResizeStart, onTableResizeEnd } from './resizeHandler.js';

package/esm/core/Table/actionHandlers/resizeHandler.d.ts

@@ -3,20 +3,20 @@ export declare const onTableResizeStart: <T extends Record<string, unknown>>(sta
     isTableResizing: boolean;
     hiddenColumns?: import("../../../react-table/react-table.js").IdType<T>[] | undefined;
     columnResizing: {
-        startX?: number | undefined;
-        columnWidth?: number | undefined;
-        nextColumnWidth?: number | undefined;
-        headerIdWidths?: [string, number][] | undefined;
-        nextHeaderIdWidths?: [string, number][] | undefined;
+        startX?: number;
+        columnWidth?: number;
+        nextColumnWidth?: number;
+        headerIdWidths?: Array<[string, number]>;
+        nextHeaderIdWidths?: Array<[string, number]>;
         columnWidths: Record<string, number>;
-        isResizingColumn?: string | undefined;
+        isResizingColumn?: string;
     };
     columnReorderStartIndex: number;
     sticky: {
-        isScrolledToRight?: boolean | undefined;
-        isScrolledToLeft?: boolean | undefined;
+        isScrolledToRight?: boolean;
+        isScrolledToLeft?: boolean;
     };
-    lastSelectedRowId?: string | undefined;
+    lastSelectedRowId?: string;
     columnOrder: import("../../../react-table/react-table.js").IdType<T>[];
     expanded: Record<import("../../../react-table/react-table.js").IdType<T>, boolean>;
     filters: import("../../../react-table/react-table.js").Filters<T>;
@@ -34,20 +34,20 @@ export declare const onTableResizeEnd: <T extends Record<string, unknown>>(state
     isTableResizing: boolean;
     columnResizing: {
         columnWidths: any;
-        startX?: number | undefined;
-        columnWidth?: number | undefined;
-        nextColumnWidth?: number | undefined;
-        headerIdWidths?: [string, number][] | undefined;
-        nextHeaderIdWidths?: [string, number][] | undefined;
-        isResizingColumn?: string | undefined;
+        startX?: number;
+        columnWidth?: number;
+        nextColumnWidth?: number;
+        headerIdWidths?: Array<[string, number]>;
+        nextHeaderIdWidths?: Array<[string, number]>;
+        isResizingColumn?: string;
     };
     hiddenColumns?: import("../../../react-table/react-table.js").IdType<T>[] | undefined;
     columnReorderStartIndex: number;
     sticky: {
-        isScrolledToRight?: boolean | undefined;
-        isScrolledToLeft?: boolean | undefined;
+        isScrolledToRight?: boolean;
+        isScrolledToLeft?: boolean;
     };
-    lastSelectedRowId?: string | undefined;
+    lastSelectedRowId?: string;
     columnOrder: import("../../../react-table/react-table.js").IdType<T>[];
     expanded: Record<import("../../../react-table/react-table.js").IdType<T>, boolean>;
     filters: import("../../../react-table/react-table.js").Filters<T>;

package/esm/core/Table/actionHandlers/resizeHandler.js

@@ -1,15 +1,18 @@
 export const onTableResizeStart = (state) => {
-    return { ...state, isTableResizing: true };
+  return {
+    ...state,
+    isTableResizing: true,
+  };
 };
 export const onTableResizeEnd = (state, action) => {
-    return {
-        ...state,
-        isTableResizing: false,
-        columnResizing: {
-            ...state.columnResizing,
-            columnWidths: {
-                ...action.columnWidths,
-            },
-        },
-    };
+  return {
+    ...state,
+    isTableResizing: false,
+    columnResizing: {
+      ...state.columnResizing,
+      columnWidths: {
+        ...action.columnWidths,
+      },
+    },
+  };
 };

package/esm/core/Table/actionHandlers/selectHandler.d.ts

@@ -2,28 +2,28 @@ import type { ActionType, TableInstance, TableState, IdType } from '../../../rea
 /**
  * Handles selection when toggling a row (Ctrl click or checkbox click)
  */
-export declare const onToggleHandler: <T extends Record<string, unknown>>(newState: TableState<T>, action: ActionType, instance?: TableInstance<T> | undefined, onSelect?: ((selectedData: T[] | undefined, tableState?: TableState<T> | undefined) => void) | undefined, isRowDisabled?: ((rowData: T) => boolean) | undefined) => void;
+export declare const onToggleHandler: <T extends Record<string, unknown>>(newState: TableState<T>, action: ActionType, instance?: TableInstance<T>, onSelect?: (selectedData: T[] | undefined, tableState?: TableState<T>) => void, isRowDisabled?: (rowData: T) => boolean) => void;
 /**
  * Handles selection when clicked on a row.
  */
-export declare const onSingleSelectHandler: <T extends Record<string, unknown>>(state: TableState<T>, action: ActionType, instance?: TableInstance<T> | undefined, onSelect?: ((selectedData: T[] | undefined, tableState?: TableState<T> | undefined) => void) | undefined, isRowDisabled?: ((rowData: T) => boolean) | undefined) => {
+export declare const onSingleSelectHandler: <T extends Record<string, unknown>>(state: TableState<T>, action: ActionType, instance?: TableInstance<T>, onSelect?: (selectedData: T[] | undefined, tableState?: TableState<T>) => void, isRowDisabled?: (rowData: T) => boolean) => {
     lastSelectedRowId: any;
     selectedRowIds: Record<string, boolean>;
     hiddenColumns?: IdType<T>[] | undefined;
     columnResizing: {
-        startX?: number | undefined;
-        columnWidth?: number | undefined;
-        nextColumnWidth?: number | undefined;
-        headerIdWidths?: [string, number][] | undefined;
-        nextHeaderIdWidths?: [string, number][] | undefined;
+        startX?: number;
+        columnWidth?: number;
+        nextColumnWidth?: number;
+        headerIdWidths?: Array<[string, number]>;
+        nextHeaderIdWidths?: Array<[string, number]>;
         columnWidths: Record<string, number>;
-        isResizingColumn?: string | undefined;
+        isResizingColumn?: string;
     };
-    isTableResizing?: boolean | undefined;
+    isTableResizing?: boolean;
     columnReorderStartIndex: number;
     sticky: {
-        isScrolledToRight?: boolean | undefined;
-        isScrolledToLeft?: boolean | undefined;
+        isScrolledToRight?: boolean;
+        isScrolledToLeft?: boolean;
     };
     columnOrder: IdType<T>[];
     expanded: Record<IdType<T>, boolean>;
@@ -40,4 +40,4 @@ export declare const onSingleSelectHandler: <T extends Record<string, unknown>>(
 /**
  * Handles selection when clicked on a row while shift key is pressed.
  */
-export declare const onShiftSelectHandler: <T extends Record<string, unknown>>(state: TableState<T>, action: ActionType, instance?: TableInstance<T> | undefined, onSelect?: ((selectedData: T[] | undefined, tableState?: TableState<T> | undefined) => void) | undefined, isRowDisabled?: ((rowData: T) => boolean) | undefined) => TableState<T>;
+export declare const onShiftSelectHandler: <T extends Record<string, unknown>>(state: TableState<T>, action: ActionType, instance?: TableInstance<T>, onSelect?: (selectedData: T[] | undefined, tableState?: TableState<T>) => void, isRowDisabled?: (rowData: T) => boolean) => TableState<T>;