@itwin/itwinui-react 3.15.3 → 3.15.5

package/esm/core/Table/TablePaginator.js

@@ -8,12 +8,13 @@ import { MenuItem } from '../Menu/MenuItem.js';
 import {
   getBoundedValue,
   useGlobals,
-  useOverflow,
   useContainerWidth,
   SvgChevronLeft,
   SvgChevronRight,
   Box,
+  OverflowContainer,
 } from '../../utils/index.js';
+import { styles } from '../../styles.js';
 let defaultLocalization = {
   pageSizeLabel: (size) => `${size} per page`,
   rangeLabel: (startIndex, endIndex, totalRows, isLoading) =>
@@ -55,7 +56,7 @@ export const TablePaginator = (props) => {
   );
   let pageListRef = React.useRef(null);
   let [focusedIndex, setFocusedIndex] = React.useState(currentPage);
-  React.useEffect(() => {
+  React.useLayoutEffect(() => {
     setFocusedIndex(currentPage);
   }, [currentPage]);
   let needFocus = React.useRef(false);
@@ -64,7 +65,7 @@ export const TablePaginator = (props) => {
     if (isMounted.current && needFocus.current) {
       let buttonToFocus = Array.from(
         pageListRef.current?.querySelectorAll(
-          '.iui-table-paginator-page-button',
+          `.${styles['iui-table-paginator-page-button']}`,
         ) ?? [],
       ).find((el) => el.textContent?.trim() === (focusedIndex + 1).toString());
       buttonToFocus?.focus();
@@ -73,35 +74,7 @@ export const TablePaginator = (props) => {
     isMounted.current = true;
   }, [focusedIndex]);
   let buttonSize = 'default' != size ? 'small' : void 0;
-  let pageButton = React.useCallback(
-    (index, tabIndex = index === focusedIndex ? 0 : -1) =>
-      React.createElement(
-        Button,
-        {
-          key: index,
-          className: 'iui-table-paginator-page-button',
-          styleType: 'borderless',
-          size: buttonSize,
-          'data-iui-active': index === currentPage,
-          onClick: () => onPageChange(index),
-          'aria-current': index === currentPage,
-          'aria-label': localization.goToPageLabel(index + 1),
-          tabIndex: tabIndex,
-        },
-        index + 1,
-      ),
-    [focusedIndex, currentPage, localization, buttonSize, onPageChange],
-  );
   let totalPagesCount = Math.ceil(totalRowsCount / pageSize);
-  let pageList = React.useMemo(
-    () =>
-      new Array(totalPagesCount)
-        .fill(null)
-        .map((_, index) => pageButton(index)),
-    [pageButton, totalPagesCount],
-  );
-  let [overflowRef, visibleCount] = useOverflow(pageList);
-  let [paginatorResizeRef, paginatorWidth] = useContainerWidth();
   let onKeyDown = (event) => {
     if (event.altKey) return;
     let focusPage = (delta) => {
@@ -132,30 +105,10 @@ export const TablePaginator = (props) => {
         break;
     }
   };
-  let halfVisibleCount = Math.floor(visibleCount / 2);
-  let startPage = focusedIndex - halfVisibleCount;
-  let endPage = focusedIndex + halfVisibleCount + 1;
-  if (startPage < 0) {
-    endPage = Math.min(totalPagesCount, endPage + Math.abs(startPage));
-    startPage = 0;
-  }
-  if (endPage > totalPagesCount) {
-    startPage = Math.max(0, startPage - (endPage - totalPagesCount));
-    endPage = totalPagesCount;
-  }
-  let hasNoRows = 0 === totalPagesCount;
+  let [paginatorResizeRef, paginatorWidth] = useContainerWidth();
   let showPagesList = totalPagesCount > 1 || isLoading;
   let showPageSizeList = pageSizeList && !!onPageSizeChange && !!totalRowsCount;
-  let ellipsis = React.createElement(
-    Box,
-    {
-      as: 'span',
-      className: cx('iui-table-paginator-ellipsis', {
-        'iui-table-paginator-ellipsis-small': 'small' === size,
-      }),
-    },
-    '…',
-  );
+  let hasNoRows = 0 === totalPagesCount;
   let noRowsContent = React.createElement(
     React.Fragment,
     null,
@@ -196,10 +149,10 @@ export const TablePaginator = (props) => {
     ),
     showPagesList &&
       React.createElement(
-        Box,
+        OverflowContainer,
         {
           className: 'iui-center',
-          ref: overflowRef,
+          itemsCount: totalPagesCount,
         },
         React.createElement(
           IconButton,
@@ -220,40 +173,17 @@ export const TablePaginator = (props) => {
             onKeyDown: onKeyDown,
             ref: pageListRef,
           },
-          (() => {
-            if (hasNoRows) return noRowsContent;
-            if (1 === visibleCount) return pageButton(focusedIndex);
-            return React.createElement(
-              React.Fragment,
-              null,
-              0 !== startPage &&
-                React.createElement(
-                  React.Fragment,
-                  null,
-                  pageButton(0, 0),
-                  ellipsis,
-                ),
-              pageList.slice(startPage, endPage),
-              endPage !== totalPagesCount &&
-                !isLoading &&
-                React.createElement(
-                  React.Fragment,
-                  null,
-                  ellipsis,
-                  pageButton(totalPagesCount - 1, 0),
-                ),
-              isLoading &&
-                React.createElement(
-                  React.Fragment,
-                  null,
-                  ellipsis,
-                  React.createElement(ProgressRadial, {
-                    indeterminate: true,
-                    size: 'small',
-                  }),
-                ),
-            );
-          })(),
+          hasNoRows
+            ? noRowsContent
+            : React.createElement(TablePaginatorPageButtons, {
+                size: size,
+                focusedIndex: focusedIndex,
+                totalPagesCount: totalPagesCount,
+                onPageChange: onPageChange,
+                currentPage: currentPage,
+                localization: localization,
+                isLoading: isLoading,
+              }),
         ),
         React.createElement(
           IconButton,
@@ -318,3 +248,96 @@ export const TablePaginator = (props) => {
     ),
   );
 };
+let TablePaginatorPageButtons = (props) => {
+  let {
+    focusedIndex,
+    totalPagesCount,
+    onPageChange,
+    currentPage,
+    localization,
+    isLoading,
+    size,
+  } = props;
+  let { visibleCount } = OverflowContainer.useContext();
+  let buttonSize = 'default' != size ? 'small' : void 0;
+  let pageButton = React.useCallback(
+    (index, tabIndex = index === focusedIndex ? 0 : -1) =>
+      React.createElement(
+        Button,
+        {
+          key: index,
+          className: 'iui-table-paginator-page-button',
+          styleType: 'borderless',
+          size: buttonSize,
+          'data-iui-active': index === currentPage,
+          onClick: () => onPageChange(index),
+          'aria-current': index === currentPage,
+          'aria-label': localization.goToPageLabel?.(index + 1),
+          tabIndex: tabIndex,
+        },
+        index + 1,
+      ),
+    [focusedIndex, currentPage, localization, buttonSize, onPageChange],
+  );
+  let pageList = React.useMemo(
+    () =>
+      new Array(totalPagesCount)
+        .fill(null)
+        .map((_, index) => pageButton(index)),
+    [pageButton, totalPagesCount],
+  );
+  let halfVisibleCount = Math.floor(visibleCount / 2);
+  let startPage = focusedIndex - halfVisibleCount;
+  let endPage = focusedIndex + halfVisibleCount + 1;
+  if (startPage < 0) {
+    endPage = Math.min(totalPagesCount, endPage + Math.abs(startPage));
+    startPage = 0;
+  }
+  if (endPage > totalPagesCount) {
+    startPage = Math.max(0, startPage - (endPage - totalPagesCount));
+    endPage = totalPagesCount;
+  }
+  let ellipsis = React.createElement(
+    Box,
+    {
+      as: 'span',
+      className: cx('iui-table-paginator-ellipsis', {
+        'iui-table-paginator-ellipsis-small': 'small' === size,
+      }),
+    },
+    '…',
+  );
+  if (1 === visibleCount) return pageButton(focusedIndex);
+  let showStartEllipsis = startPage > 1;
+  let showEndEllipsis = endPage < totalPagesCount - 1;
+  return React.createElement(
+    React.Fragment,
+    null,
+    0 !== startPage &&
+      React.createElement(
+        React.Fragment,
+        null,
+        pageButton(0, 0),
+        showStartEllipsis ? ellipsis : null,
+      ),
+    pageList.slice(startPage, endPage),
+    endPage !== totalPagesCount &&
+      !isLoading &&
+      React.createElement(
+        React.Fragment,
+        null,
+        showEndEllipsis ? ellipsis : null,
+        pageButton(totalPagesCount - 1, 0),
+      ),
+    isLoading &&
+      React.createElement(
+        React.Fragment,
+        null,
+        ellipsis,
+        React.createElement(ProgressRadial, {
+          indeterminate: true,
+          size: 'small',
+        }),
+      ),
+  );
+};

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

@@ -2,14 +2,14 @@ import * as React from 'react';
 import { defaultColumn } from 'react-table';
 import cx from 'classnames';
 import { Box, LineClamp, ShadowRoot } from '../../../utils/index.js';
-import { TableColumnsContext } from '../utils.js';
+import { TableInstanceContext } from '../utils.js';
 export const DefaultCell = (props) => {
-  let instanceColumns = React.useContext(TableColumnsContext);
+  let instance = React.useContext(TableInstanceContext);
   let isCustomCell = React.useMemo(
     () =>
-      instanceColumns.find(({ id }) => props.cellProps.column.id === id)
+      instance?.columns.find(({ id }) => props.cellProps.column.id === id)
         ?.Cell !== defaultColumn.Cell,
-    [instanceColumns, props.cellProps.column.id],
+    [instance, props.cellProps.column.id],
   );
   let {
     cellElementProps: {

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

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import type { ColumnInstance } from '../../react-table/react-table.js';
+import type { ColumnInstance, TableInstance } from '../../react-table/react-table.js';
 export declare const getCellStyle: <T extends Record<string, unknown>>(column: ColumnInstance<T>, isTableResizing: boolean) => React.CSSProperties | undefined;
 export declare const getStickyStyle: <T extends Record<string, unknown>>(column: ColumnInstance<T>, columnList: ColumnInstance<T>[]) => React.CSSProperties;
 export declare const getSubRowStyle: ({ density, depth }: {
@@ -8,4 +8,4 @@ export declare const getSubRowStyle: ({ density, depth }: {
 }) => {
     paddingInlineStart: number;
 };
-export declare const TableColumnsContext: React.Context<ColumnInstance<{}>[]>;
+export declare const TableInstanceContext: React.Context<TableInstance<Record<string, unknown>> | undefined>;

package/esm/core/Table/utils.js

@@ -47,4 +47,4 @@ export const getSubRowStyle = ({ density = 'default', depth = 1 }) => {
     paddingInlineStart: cellPadding + depth * multiplier,
   };
 };
-export const TableColumnsContext = React.createContext([]);
+export const TableInstanceContext = React.createContext(void 0);

package/esm/styles.js

@@ -1,4 +1,4 @@
-const t = '3.15.3';
+const t = '3.15.5';
 const u = new Proxy(
   {},
   {

package/esm/utils/components/MiddleTextTruncation.js

@@ -1,20 +1,12 @@
 import * as React from 'react';
-import { useOverflow } from '../hooks/useOverflow.js';
+import { OverflowContainer } from './OverflowContainer.js';
 let ELLIPSIS_CHAR = '…';
 export const MiddleTextTruncation = (props) => {
-  let { text, endCharsCount = 6, textRenderer, style, ...rest } = props;
-  let [ref, visibleCount] = useOverflow(text);
-  let truncatedText = React.useMemo(() => {
-    if (visibleCount < text.length)
-      return `${text.substring(
-        0,
-        visibleCount - endCharsCount - ELLIPSIS_CHAR.length,
-      )}${ELLIPSIS_CHAR}${text.substring(text.length - endCharsCount)}`;
-    return text;
-  }, [endCharsCount, text, visibleCount]);
+  let { text, style, ...rest } = props;
   return React.createElement(
-    'span',
+    OverflowContainer,
     {
+      as: 'span',
       style: {
         display: 'flex',
         minWidth: 0,
@@ -22,9 +14,22 @@ export const MiddleTextTruncation = (props) => {
         whiteSpace: 'nowrap',
         ...style,
       },
-      ref: ref,
+      itemsCount: text.length,
       ...rest,
     },
-    textRenderer?.(truncatedText, text) ?? truncatedText,
+    React.createElement(MiddleTextTruncationContent, props),
   );
 };
+let MiddleTextTruncationContent = (props) => {
+  let { text, endCharsCount = 6, textRenderer } = props;
+  let { visibleCount } = OverflowContainer.useContext();
+  let truncatedText = React.useMemo(() => {
+    if (visibleCount < text.length)
+      return `${text.substring(
+        0,
+        visibleCount - endCharsCount - ELLIPSIS_CHAR.length,
+      )}${ELLIPSIS_CHAR}${text.substring(text.length - endCharsCount)}`;
+    return text;
+  }, [endCharsCount, text, visibleCount]);
+  return textRenderer?.(truncatedText, text) ?? truncatedText;
+};

package/esm/utils/components/OverflowContainer.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import type { PolymorphicForwardRefComponent } from '../props.js';
+type OverflowContainerProps = {
+    /**
+     * The orientation of the overflow in container.
+     * @default 'horizontal'
+     */
+    overflowOrientation?: 'horizontal' | 'vertical';
+    /**
+     * Count of the *original* items (i.e. when sufficient space is available).
+     */
+    itemsCount: number;
+};
+type OverflowContainerOverflowNodeProps = {
+    children: React.ReactNode;
+};
+/**
+ * Wrapper over `useOverflow`.
+ *
+ * - Use `OverflowContainer.useContext()` to get overflow related properties.
+ * - Wrap overflow content in `OverflowContainer.OverflowNode` to conditionally render it when overflowing.
+ */
+export declare const OverflowContainer: PolymorphicForwardRefComponent<"div", OverflowContainerProps> & {
+    /**
+     * Wrap overflow content in this component to conditionally render it when overflowing.
+     */
+    OverflowNode: (props: OverflowContainerOverflowNodeProps) => React.ReactNode;
+    /**
+     * Get overflow related properties of the nearest `OverflowContainer` ancestor.
+     */
+    useContext: typeof useOverflowContainerContext;
+};
+declare function useOverflowContainerContext(): {
+    visibleCount: number;
+    itemsCount: number;
+};
+export {};

package/esm/utils/components/OverflowContainer.js

@@ -0,0 +1,49 @@
+import React from 'react';
+import { useMergedRefs } from '../hooks/useMergedRefs.js';
+import { Box } from './Box.js';
+import { useOverflow } from '../hooks/useOverflow.js';
+import { useSafeContext } from '../hooks/useSafeContext.js';
+let OverflowContainerComponent = React.forwardRef((props, ref) => {
+  let { itemsCount, children, overflowOrientation, ...rest } = props;
+  let [containerRef, visibleCount] = useOverflow(
+    itemsCount,
+    false,
+    overflowOrientation,
+  );
+  let overflowContainerContextValue = React.useMemo(
+    () => ({
+      visibleCount,
+      itemsCount,
+    }),
+    [itemsCount, visibleCount],
+  );
+  return React.createElement(
+    OverflowContainerContext.Provider,
+    {
+      value: overflowContainerContextValue,
+    },
+    React.createElement(
+      Box,
+      {
+        ref: useMergedRefs(ref, containerRef),
+        ...rest,
+      },
+      children,
+    ),
+  );
+});
+let OverflowContainerOverflowNode = (props) => {
+  let { children } = props;
+  let { visibleCount, itemsCount } = useOverflowContainerContext();
+  let isOverflowing = visibleCount < itemsCount;
+  return isOverflowing ? children : null;
+};
+export const OverflowContainer = Object.assign(OverflowContainerComponent, {
+  OverflowNode: OverflowContainerOverflowNode,
+  useContext: useOverflowContainerContext,
+});
+let OverflowContainerContext = React.createContext(void 0);
+function useOverflowContainerContext() {
+  let overflowContainerContext = useSafeContext(OverflowContainerContext);
+  return overflowContainerContext;
+}

package/esm/utils/components/index.d.ts

@@ -12,3 +12,4 @@ export * from './Portal.js';
 export * from './ShadowRoot.js';
 export * from './LineClamp.js';
 export * from './FieldsetBase.js';
+export * from './OverflowContainer.js';

package/esm/utils/components/index.js

@@ -12,3 +12,4 @@ export * from './Portal.js';
 export * from './ShadowRoot.js';
 export * from './LineClamp.js';
 export * from './FieldsetBase.js';
+export * from './OverflowContainer.js';

package/esm/utils/hooks/useOverflow.d.ts

@@ -1,4 +1,3 @@
-import * as React from 'react';
 /**
  * Hook that observes the size of an element and returns the number of items
  * that should be visible based on the size of the container element.
@@ -6,7 +5,7 @@ import * as React from 'react';
  * The returned number should be used to render the element with fewer items.
  *
  * @private
- * @param items Items that this element contains.
+ * @param itemsCount Number of items that this element contains.
  * @param disabled Set to true to disconnect the observer.
  * @param dimension 'horizontal' (default) or 'vertical'
  * @returns [callback ref to set on container, stateful count of visible items]
@@ -21,4 +20,4 @@ import * as React from 'react';
  *   </div>
  * );
  */
-export declare const useOverflow: <T extends HTMLElement>(items: React.ReactNode[] | string, disabled?: boolean, orientation?: "horizontal" | "vertical") => readonly [(instance: T | null | undefined) => void, number];
+export declare const useOverflow: <T extends HTMLElement>(itemsCount: number, disabled?: boolean, orientation?: "horizontal" | "vertical") => readonly [(instance: T | null | undefined) => void, number];

package/esm/utils/hooks/useOverflow.js

@@ -4,13 +4,13 @@ import { useResizeObserver } from './useResizeObserver.js';
 import { useLayoutEffect } from './useIsomorphicLayoutEffect.js';
 let STARTING_MAX_ITEMS_COUNT = 20;
 export const useOverflow = (
-  items,
+  itemsCount,
   disabled = false,
   orientation = 'horizontal',
 ) => {
   let containerRef = React.useRef(null);
   let [visibleCount, setVisibleCount] = React.useState(() =>
-    disabled ? items.length : Math.min(items.length, STARTING_MAX_ITEMS_COUNT),
+    disabled ? itemsCount : Math.min(itemsCount, STARTING_MAX_ITEMS_COUNT),
   );
   let needsFullRerender = React.useRef(true);
   let [containerSize, setContainerSize] = React.useState(0);
@@ -23,12 +23,12 @@ export const useOverflow = (
   let [resizeRef, observer] = useResizeObserver(updateContainerSize);
   let resizeObserverRef = React.useRef(observer);
   useLayoutEffect(() => {
-    if (disabled) setVisibleCount(items.length);
+    if (disabled) setVisibleCount(itemsCount);
     else {
-      setVisibleCount(Math.min(items.length, STARTING_MAX_ITEMS_COUNT));
+      setVisibleCount(Math.min(itemsCount, STARTING_MAX_ITEMS_COUNT));
       needsFullRerender.current = true;
     }
-  }, [containerSize, disabled, items]);
+  }, [containerSize, disabled, itemsCount]);
   let mergedRefs = useMergedRefs(containerRef, resizeRef);
   useLayoutEffect(() => {
     if (!containerRef.current || disabled) {
@@ -48,14 +48,14 @@ export const useOverflow = (
         0,
       );
       let currentVisibleCount =
-        visibleCount || Math.min(items.length, STARTING_MAX_ITEMS_COUNT);
+        visibleCount || Math.min(itemsCount, STARTING_MAX_ITEMS_COUNT);
       let avgItemSize = childrenSize / currentVisibleCount;
       let visibleItems = Math.floor(availableSize / avgItemSize);
       if (!isNaN(visibleItems))
-        setVisibleCount(Math.min(items.length, 2 * visibleItems));
+        setVisibleCount(Math.min(itemsCount, 2 * visibleItems));
     }
     needsFullRerender.current = false;
-  }, [containerSize, visibleCount, disabled, items.length, orientation]);
+  }, [containerSize, visibleCount, disabled, itemsCount, orientation]);
   useLayoutEffect(() => {
     previousContainerSize.current = containerSize;
   }, [containerSize]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/itwinui-react",
-  "version": "3.15.3",
+  "version": "3.15.5",
   "author": "Bentley Systems",
   "license": "MIT",
   "type": "module",