@itwin/itwinui-react 3.17.4 → 3.18.0

package/esm/core/StatusMessage/StatusMessage.js

@@ -35,3 +35,5 @@ export const StatusMessage = React.forwardRef((props, ref) => {
     React.createElement(Box, contentProps, children),
   );
 });
+if ('development' === process.env.NODE_ENV)
+  StatusMessage.displayName = 'StatusMessage';

package/esm/core/Stepper/Stepper.js

@@ -89,3 +89,4 @@ export const Stepper = React.forwardRef((props, ref) => {
       ),
   );
 });
+if ('development' === process.env.NODE_ENV) Stepper.displayName = 'Stepper';

package/esm/core/Stepper/WorkflowDiagram.js

@@ -30,3 +30,5 @@ export const WorkflowDiagram = React.forwardRef((props, ref) => {
     ),
   );
 });
+if ('development' === process.env.NODE_ENV)
+  WorkflowDiagram.displayName = 'WorkflowDiagram';

package/esm/core/Surface/Surface.js

@@ -39,6 +39,8 @@ let SurfaceHeader = React.forwardRef((props, ref) => {
     children,
   );
 });
+if ('development' === process.env.NODE_ENV)
+  SurfaceHeader.displayName = 'Surface.Header';
 let SurfaceBody = React.forwardRef((props, ref) => {
   let { children, className, isPadded = false, ...rest } = props;
   let { setHasLayout } = useSafeContext(SurfaceContext);
@@ -56,6 +58,8 @@ let SurfaceBody = React.forwardRef((props, ref) => {
     children,
   );
 });
+if ('development' === process.env.NODE_ENV)
+  SurfaceBody.displayName = 'Surface.Body';
 export const Surface = Object.assign(
   React.forwardRef((props, ref) => {
     let {
@@ -97,4 +101,7 @@ export const Surface = Object.assign(
     Body: SurfaceBody,
   },
 );
+if ('development' === process.env.NODE_ENV) Surface.displayName = 'Surface';
 let SurfaceContext = React.createContext(void 0);
+if ('development' === process.env.NODE_ENV)
+  SurfaceContext.displayName = 'SurfaceContext';

package/esm/core/Table/ColumnHeader.js

@@ -100,26 +100,26 @@ export const ColumnHeader = React.forwardRef((props, forwardedRef) => {
     React.createElement(
       React.Fragment,
       null,
-      React.createElement(
-        ShadowRoot,
-        null,
-        'string' == typeof column.Header
-          ? React.createElement(
+      'string' == typeof column.Header
+        ? React.createElement(
+            ShadowRoot,
+            null,
+            React.createElement(
               LineClamp,
               null,
               React.createElement('slot', null),
-            )
-          : React.createElement('slot', null),
-        React.createElement('slot', {
-          name: 'actions',
-        }),
-        React.createElement('slot', {
-          name: 'resizers',
-        }),
-        React.createElement('slot', {
-          name: 'shadows',
-        }),
-      ),
+            ),
+            React.createElement('slot', {
+              name: 'actions',
+            }),
+            React.createElement('slot', {
+              name: 'resizers',
+            }),
+            React.createElement('slot', {
+              name: 'shadows',
+            }),
+          )
+        : null,
       column.render('Header'),
       (showFilterButton(column) || showSortButton(column)) &&
         React.createElement(

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

@@ -44,7 +44,7 @@ export type TablePaginatorRendererProps = {
  * Table props.
  * columns and data must be memoized.
  */
-export type TableProps<T extends Record<string, unknown> = Record<string, unknown>> = Omit<TableOptions<T>, 'disableSortBy'> & {
+export type TableProps<T extends Record<string, unknown> = Record<string, unknown>> = Omit<TableOptions<T>, 'disableSortBy'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'role' | 'onSelect'> & {
     /**
      * Flag whether data is loading.
      * @default false
@@ -203,6 +203,13 @@ export type TableProps<T extends Record<string, unknown> = Record<string, unknow
      * Passes custom props to Table body.
      */
     bodyProps?: React.ComponentProps<'div'>;
+    /**
+     * Passes props to the `role="table"` element within the wrapper.
+     *
+     * If `tableProps` or `role` is passed to `Table`, all ARIA attributes passed to `Table` will be passed to the wrapper.
+     * Else, all ARIA attributes will be passed to the inner element with `role="table"`.
+     */
+    tableProps?: React.ComponentProps<'div'>;
     /**
      * Passes custom props to empty table.
      */
@@ -231,9 +238,28 @@ export type TableProps<T extends Record<string, unknown> = Record<string, unknow
      * />
      */
     scrollToRow?: (rows: Row<T>[], data: T[]) => number;
+    /**
+     * Caption for the table.
+     *
+     * Although optional for backward compatibility, it is **recommended** to use it for accessibility purposes.
+     *
+     * @default "Table"
+     */
+    caption?: string;
+    /**
+     * If `tableProps` or `role` is passed to `Table`, all ARIA attributes passed to `Table` will be passed to the wrapper.
+     * Else, all ARIA attributes will be passed to the inner element with `role="table"`.
+     */
+    role?: React.AriaRole;
 } & Omit<CommonProps, 'title'>;
 /**
  * Table based on [react-table](https://react-table.tanstack.com/docs/api/overview).
+ *
+ * **Note**: If `tableProps` or `role` is passed to `Table`, all ARIA attributes passed to `Table` will be passed to the wrapper.
+ * Else, all ARIA attributes will be passed to the inner element with `role="table"`.
+ *
+ * ---
+ *
  * @example
  * const columns = React.useMemo(() => [
  *   {

package/esm/core/Table/Table.js

@@ -49,6 +49,7 @@ import {
 import { SELECTION_CELL_ID } from './columns/index.js';
 import { ColumnHeader } from './ColumnHeader.js';
 import { TableExpandableContentMemoized } from './TableExpandableContentMemoized.js';
+import { VisuallyHidden } from '../VisuallyHidden/VisuallyHidden.js';
 let singleRowSelectedAction = 'singleRowSelected';
 let shiftRowSelectedAction = 'shiftRowSelected';
 export const tableResizeStartAction = 'tableResizeStart';
@@ -105,10 +106,44 @@ export const Table = (props) => {
     headerWrapperProps,
     headerProps,
     bodyProps,
+    tableProps,
     emptyTableContentProps,
     getRowId,
-    ...rest
+    caption = 'Table',
+    role,
+    ..._rest
   } = props;
+  let { ariaRestAttributes, nonAriaRestAttributes } = React.useMemo(
+    () =>
+      Object.entries(_rest).reduce(
+        (result, [key, value]) => {
+          if (key.startsWith('aria-')) result.ariaRestAttributes[key] = value;
+          else result.nonAriaRestAttributes[key] = value;
+          return result;
+        },
+        {
+          ariaRestAttributes: {},
+          nonAriaRestAttributes: {},
+        },
+      ),
+    [_rest],
+  );
+  let { outerAriaRestAttributes, innerAriaRestAttributes } =
+    React.useMemo(() => {
+      if (tableProps || role)
+        return {
+          outerAriaRestAttributes: {
+            ...ariaRestAttributes,
+          },
+          innerAriaRestAttributes: {},
+        };
+      return {
+        outerAriaRestAttributes: {},
+        innerAriaRestAttributes: {
+          ...ariaRestAttributes,
+        },
+      };
+    }, [ariaRestAttributes, role, tableProps]);
   useGlobals();
   let ownerDocument = React.useRef(void 0);
   let defaultColumn = React.useMemo(
@@ -320,16 +355,21 @@ export const Table = (props) => {
   } = instance;
   let headerGroups = _headerGroups;
   let logWarning = useWarningLogger();
-  if (1 === columns.length && 'columns' in columns[0])
+  if (1 === columns.length && 'columns' in columns[0]) {
     headerGroups = _headerGroups.slice(1);
-  let ariaDataAttributes = Object.entries(rest).reduce(
-    (result, [key, value]) => {
-      if (key.startsWith('data-') || key.startsWith('aria-'))
-        result[key] = value;
-      return result;
-    },
-    {},
-  );
+    if ('development' === process.env.NODE_ENV)
+      logWarning(
+        "Table's `columns` prop should not have a top-level `Header` or sub-columns. They are only allowed to be passed for backwards compatibility.\n See https://github.com/iTwin/iTwinUI/wiki/iTwinUI-react-v2-migration-guide#breaking-changes",
+      );
+  }
+  if (
+    'development' === process.env.NODE_ENV &&
+    subComponent &&
+    data.some((item) => !!item.subRows?.length)
+  )
+    logWarning(
+      'Passing both `subComponent` and `data` with `subRows` is not supported. There are features designed for `subRows` that are not compatible with `subComponent` and vice versa.',
+    );
   let areFiltersSet =
     allColumns.some(
       (column) => null != column.filterValue && '' !== column.filterValue,
@@ -344,7 +384,7 @@ export const Table = (props) => {
         !isDisabled &&
         selectRowOnClick &&
         !event.isDefaultPrevented()
-      ) {
+      )
         if ('multi' === selectionMode && event.shiftKey)
           dispatch({
             type: shiftRowSelectedAction,
@@ -358,7 +398,6 @@ export const Table = (props) => {
             type: singleRowSelectedAction,
             id: row.id,
           });
-      }
     },
     [
       isRowDisabled,
@@ -559,6 +598,7 @@ export const Table = (props) => {
   React.useEffect(() => {
     updateStickyState();
   }, []);
+  let captionId = React.useId();
   return React.createElement(
     TableInstanceContext.Provider,
     {
@@ -582,10 +622,46 @@ export const Table = (props) => {
             ...style,
           },
         }),
+        role: role,
+        'aria-labelledby': captionId,
         onScroll: () => updateStickyState(),
         'data-iui-size': 'default' === density ? void 0 : density,
-        ...ariaDataAttributes,
+        ...outerAriaRestAttributes,
+        ...nonAriaRestAttributes,
       },
+      React.createElement(
+        ShadowRoot,
+        null,
+        React.createElement(
+          'div',
+          {
+            role: 'table',
+            ...innerAriaRestAttributes,
+            ...tableProps,
+          },
+          React.createElement('slot', {
+            name: 'caption',
+          }),
+          React.createElement('slot', {
+            name: 'iui-table-header-wrapper',
+          }),
+          React.createElement('slot', {
+            name: 'iui-table-body',
+          }),
+        ),
+        React.createElement('slot', {
+          name: 'iui-table-body-extra',
+        }),
+        React.createElement('slot', null),
+      ),
+      React.createElement(
+        VisuallyHidden,
+        {
+          slot: 'caption',
+          id: captionId,
+        },
+        caption,
+      ),
       headerGroups.map((headerGroup) => {
         headerGroup.headers = headerGroup.headers.filter(
           (header) =>
@@ -598,6 +674,7 @@ export const Table = (props) => {
         return React.createElement(
           Box,
           {
+            slot: 'iui-table-header-wrapper',
             as: 'div',
             key: headerGroupProps.key,
             ...headerWrapperProps,
@@ -650,6 +727,7 @@ export const Table = (props) => {
       React.createElement(
         Box,
         {
+          slot: 'iui-table-body',
           as: 'div',
           ...bodyProps,
           ...getTableBodyProps({
@@ -661,13 +739,13 @@ export const Table = (props) => {
               bodyProps?.className,
             ),
           }),
-          'aria-multiselectable':
-            (isSelectable && 'multi' === selectionMode) || void 0,
+          role: void 0,
         },
         React.createElement(
           ShadowRoot,
           {
             css: virtualizerCss,
+            flush: false,
           },
           enableVirtualization && 0 !== data.length
             ? React.createElement(
@@ -694,59 +772,49 @@ export const Table = (props) => {
                   )
               : page.map((_, index) => getPreparedRow(index)),
           ),
-        isLoading &&
-          0 === data.length &&
+      ),
+      isLoading &&
+        0 === data.length &&
+        React.createElement(
+          TableBodyExtraWrapper,
+          null,
           React.createElement(
-            Box,
-            {
-              as: 'div',
-              ...emptyTableContentProps,
-              className: cx(
-                'iui-table-empty',
-                emptyTableContentProps?.className,
-              ),
-            },
+            TableEmptyWrapper,
+            emptyTableContentProps,
             React.createElement(ProgressRadial, {
               indeterminate: true,
             }),
           ),
-        !isLoading &&
-          0 === data.length &&
-          !areFiltersSet &&
+        ),
+      !isLoading &&
+        0 === data.length &&
+        !areFiltersSet &&
+        React.createElement(
+          TableBodyExtraWrapper,
+          null,
           React.createElement(
-            Box,
-            {
-              as: 'div',
-              ...emptyTableContentProps,
-              className: cx(
-                'iui-table-empty',
-                emptyTableContentProps?.className,
-              ),
-            },
+            TableEmptyWrapper,
+            emptyTableContentProps,
             React.createElement('div', null, emptyTableContent),
           ),
-        !isLoading &&
-          (0 === data.length || 0 === rows.length) &&
-          areFiltersSet &&
+        ),
+      !isLoading &&
+        (0 === data.length || 0 === rows.length) &&
+        areFiltersSet &&
+        React.createElement(
+          TableBodyExtraWrapper,
+          null,
           React.createElement(
-            Box,
-            {
-              as: 'div',
-              ...emptyTableContentProps,
-              className: cx(
-                'iui-table-empty',
-                emptyTableContentProps?.className,
-              ),
-            },
+            TableEmptyWrapper,
+            emptyTableContentProps,
             React.createElement('div', null, emptyFilteredTableContent),
           ),
-      ),
+        ),
       isLoading &&
         0 !== data.length &&
         React.createElement(
-          Box,
+          TableBodyExtraWrapper,
           {
-            className: 'iui-table-body-extra',
             'data-iui-loading': 'true',
           },
           React.createElement(ProgressRadial, {
@@ -758,3 +826,31 @@ export const Table = (props) => {
     ),
   );
 };
+if ('development' === process.env.NODE_ENV) Table.displayName = 'Table';
+let TableBodyExtraWrapper = React.forwardRef((props, ref) => {
+  let { children, ...rest } = props;
+  return React.createElement(
+    Box,
+    {
+      as: 'div',
+      ref: ref,
+      slot: 'iui-table-body-extra',
+      ...rest,
+      className: cx('iui-table-body-extra', rest.className),
+    },
+    children,
+  );
+});
+let TableEmptyWrapper = React.forwardRef((props, ref) => {
+  let { children, ...rest } = props;
+  return React.createElement(
+    Box,
+    {
+      as: 'div',
+      ref: ref,
+      ...rest,
+      className: cx('iui-table-empty', rest.className),
+    },
+    children,
+  );
+});

package/esm/core/Table/TableCell.js

@@ -35,10 +35,12 @@ export const TableCell = (props) => {
   });
   let cellProps = {
     ...tableInstance,
-    cell,
-    row: cell.row,
-    value: cell.value,
-    column: cell.column,
+    ...{
+      cell,
+      row: cell.row,
+      value: cell.value,
+      column: cell.column,
+    },
   };
   let cellContent = React.createElement(
     React.Fragment,

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

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

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

@@ -1,9 +1,6 @@
 import { iuiId } from '../Table.js';
 let onSelectHandler = (newState, instance, onSelect, isRowDisabled) => {
-  if (!instance?.rows.length) {
-    onSelect?.([], newState);
-    return;
-  }
+  if (!instance?.rows.length) return void onSelect?.([], newState);
   let newSelectedRowIds = {};
   let handleRow = (row) => {
     if (isRowDisabled?.(row.original)) return false;

package/esm/core/Table/cells/DefaultCell.js

@@ -47,29 +47,31 @@ export const DefaultCell = (props) => {
       ShadowRoot,
       {
         key: `${cellElementKey}-shadow-root`,
+        flush: false,
+        css: css,
       },
       React.createElement('slot', {
         name: 'start',
-        key: `${cellElementKey}-shadow-root-start`,
       }),
-      clamp
-        ? React.createElement(
-            LineClamp,
-            {
-              key: `${cellElementKey}-shadow-root-slot`,
-            },
-            React.createElement('slot', null),
-          )
-        : React.createElement('slot', {
-            key: `${cellElementKey}-shadow-root-slot`,
-          }),
+      React.createElement(
+        'div',
+        {
+          className: '_iui-table-cell-main-content',
+          onClick: (e) => e.stopPropagation(),
+        },
+        clamp
+          ? React.createElement(
+              LineClamp,
+              null,
+              React.createElement('slot', null),
+            )
+          : React.createElement('slot', null),
+      ),
       React.createElement('slot', {
         name: 'end',
-        key: `${cellElementKey}-shadow-root-end`,
       }),
       React.createElement('slot', {
         name: 'shadows',
-        key: `${cellElementKey}-shadow-root-shadows`,
       }),
     ),
     startIcon &&
@@ -95,3 +97,18 @@ export const DefaultCell = (props) => {
       ),
   );
 };
+if ('development' === process.env.NODE_ENV)
+  DefaultCell.displayName = 'DefaultCell';
+let css = `
+._iui-table-cell-main-content {
+  position: relative;
+  isolation: isolate;
+}
+._iui-table-cell-main-content::before {
+  content: '';
+  display: block;
+  position: absolute;
+  inset: -6px;
+  z-index: -1;
+}
+`;

package/esm/core/Table/cells/EditableCell.js

@@ -72,3 +72,5 @@ export const EditableCell = (props) => {
     children,
   );
 };
+if ('development' === process.env.NODE_ENV)
+  EditableCell.displayName = 'EditableCell';

package/esm/core/Table/columns/expanderColumn.js

@@ -17,24 +17,23 @@ export const ExpanderColumn = (props = {}) => {
     cellClassName: 'iui-slot',
     Cell: (props) => {
       let { row } = props;
-      if (subComponent?.(row))
-        return React.createElement(
-          IconButton,
-          {
-            'aria-label': 'Toggle expandable content',
-            className: 'iui-table-row-expander',
-            styleType: 'borderless',
-            size: 'small',
-            onClick: (e) => {
-              e.stopPropagation();
-              row.toggleRowExpanded();
-            },
-            disabled: isDisabled?.(props.row.original),
-            'aria-expanded': row.isExpanded,
+      if (!subComponent?.(row)) return null;
+      return React.createElement(
+        IconButton,
+        {
+          'aria-label': 'Toggle expandable content',
+          className: 'iui-table-row-expander',
+          styleType: 'borderless',
+          size: 'small',
+          onClick: (e) => {
+            e.stopPropagation();
+            row.toggleRowExpanded();
           },
-          React.createElement(SvgChevronRight, null),
-        );
-      return null;
+          disabled: isDisabled?.(props.row.original),
+          'aria-expanded': row.isExpanded,
+        },
+        React.createElement(SvgChevronRight, null),
+      );
     },
     cellRenderer: (props) =>
       React.createElement(DefaultCell, {

package/esm/core/Table/columns/selectionColumn.js

@@ -32,6 +32,7 @@ export const SelectionColumn = (props = {}) => {
       );
       let indeterminate =
         !checked && Object.keys(state.selectedRowIds).length > 0;
+      let nextToggleState = !rows.some((row) => row.isSelected);
       return React.createElement(Checkbox, {
         ...getToggleAllRowsSelectedProps(),
         style: {},
@@ -39,8 +40,8 @@ export const SelectionColumn = (props = {}) => {
         checked: checked && !disabled,
         indeterminate: indeterminate,
         disabled: disabled,
-        onChange: () =>
-          toggleAllRowsSelected(!rows.some((row) => row.isSelected)),
+        'aria-label': `${nextToggleState ? 'Select' : 'Deselect'} all rows`,
+        onChange: () => toggleAllRowsSelected(nextToggleState),
       });
     },
     Cell: ({ row, selectSubRows = true }) =>
@@ -50,6 +51,7 @@ export const SelectionColumn = (props = {}) => {
         title: '',
         disabled: isDisabled?.(row.original),
         onClick: (e) => e.stopPropagation(),
+        'aria-label': `${row.isSelected ? 'Deselect' : 'Select'} row`,
         onChange: () => {
           if (
             row.subRows.length > 0 &&