diff --git a/src/table/__tests__/scrollable-wrapper.test.tsx b/src/table/__tests__/scrollable-wrapper.test.tsx new file mode 100644 index 0000000000..bf985fb5d5 --- /dev/null +++ b/src/table/__tests__/scrollable-wrapper.test.tsx @@ -0,0 +1,108 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 +import React from 'react'; +import { act, render, screen } from '@testing-library/react'; + +import Table from '../../../lib/components/table'; +import createWrapper from '../../../lib/components/test-utils/dom'; + +import tableStyles from '../../../lib/components/table/styles.css.js'; + +interface Item { + id: number; +} + +// Records observed elements so tests can emulate size changes of specific elements. +class FakeResizeObserver { + static instances: FakeResizeObserver[] = []; + private elements = new Set(); + + constructor(private callback: ResizeObserverCallback) { + FakeResizeObserver.instances.push(this); + } + + observe(element: Element) { + this.elements.add(element); + } + + unobserve(element: Element) { + this.elements.delete(element); + } + + disconnect() { + this.elements.clear(); + } + + static resize(element: Element, inlineSize: number) { + const size = [{ inlineSize, blockSize: 0 }]; + const entry = { target: element, contentBoxSize: size, borderBoxSize: size } as unknown as ResizeObserverEntry; + act(() => { + for (const observer of FakeResizeObserver.instances) { + if (observer.elements.has(element)) { + observer.callback([entry], observer as unknown as ResizeObserver); + } + } + }); + } +} + +const originalResizeObserver = window.ResizeObserver; + +beforeEach(() => { + FakeResizeObserver.instances = []; + window.ResizeObserver = FakeResizeObserver as unknown as typeof ResizeObserver; +}); + +afterEach(() => { + window.ResizeObserver = originalResizeObserver; +}); + +function renderTable() { + const cell = jest.fn((item: Item) => item.id); + const { container } = render( + + resizableColumns={true} + columnDefinitions={[{ id: 'id', header: 'Id', cell, width: 150 }]} + items={[{ id: 1 }, { id: 2 }, { id: 3 }]} + ariaLabels={{ tableLabel: 'Items' }} + /> + ); + const wrapper = createWrapper(container).findTable()!; + const measure = wrapper.findByClassName(tableStyles['wrapper-content-measure'])!.getElement(); + const table = wrapper.find('table')!.getElement(); + return { + cell, + resizeContainer: (width: number) => FakeResizeObserver.resize(measure, width), + resizeTable: (width: number) => FakeResizeObserver.resize(table, width), + }; +} + +const findScrollableRegion = () => screen.queryByRole('region', { name: 'Items' }); + +test('makes the table wrapper a focusable region only when the table is wider than its container', () => { + const { resizeContainer, resizeTable } = renderTable(); + resizeContainer(400); + resizeTable(400); + expect(findScrollableRegion()).toBeNull(); + + resizeTable(500); + expect(findScrollableRegion()).toHaveAttribute('tabindex', '0'); + + resizeContainer(600); + expect(findScrollableRegion()).toBeNull(); +}); + +test('does not re-render body cells when the table width changes without changing scrollability', () => { + const { cell, resizeContainer, resizeTable } = renderTable(); + resizeContainer(400); + resizeTable(500); + expect(findScrollableRegion()).not.toBeNull(); + + const renderCount = cell.mock.calls.length; + // Resizing a column changes the table width on every pointer move. + for (let width = 501; width <= 520; width++) { + resizeTable(width); + } + expect(cell).toHaveBeenCalledTimes(renderCount); + expect(findScrollableRegion()).not.toBeNull(); +}); diff --git a/src/table/internal.tsx b/src/table/internal.tsx index 5ffbd12d35..bce21712ec 100644 --- a/src/table/internal.tsx +++ b/src/table/internal.tsx @@ -71,6 +71,7 @@ import ToolsHeader from './tools-header'; import { useAutoSkeletonRows } from './use-auto-skeleton-rows'; import { useCellEditing } from './use-cell-editing'; import { ColumnWidthDefinition, ColumnWidthsProvider, DEFAULT_COLUMN_WIDTH } from './use-column-widths'; +import { useIsTableScrollable } from './use-is-table-scrollable'; import { usePreventStickyClickScroll } from './use-prevent-sticky-click-scroll'; import { useRowEvents } from './use-row-events'; import useTableFocusNavigation from './use-table-focus-navigation'; @@ -194,12 +195,9 @@ const InternalTable = React.forwardRef( const { allRows } = useProgressiveLoadingProps({ getLoadingStatus, expandableRows }); const selectionType = expandableRows.hasGroupSelection ? ('group' as const) : externalSelectionType; - const [containerWidth, wrapperMeasureRef] = useContainerQuery(rect => rect.borderBoxWidth); - const wrapperMeasureRefObject = useRef(null); - const wrapperMeasureMergedRef = useMergeRefs(wrapperMeasureRef, wrapperMeasureRefObject); - - const [tableWidth, tableMeasureRef] = useContainerQuery(rect => rect.borderBoxWidth); + const wrapperMeasureRefObject = useRef(null); const tableRefObject = useRef(null); + const isScrollable = useIsTableScrollable(wrapperMeasureRefObject, tableRefObject); const secondaryWrapperRef = React.useRef(null); const theadRef = useRef(null); @@ -471,7 +469,7 @@ const InternalTable = React.forwardRef( const tableRootRef = useMergeRefs(__internalRootRef, tableRootRefObject); const wrapperRef = useMergeRefs(wrapperRefObject, stickyState.refs.wrapper); - const tableRef = useMergeRefs(tableMeasureRef, tableRefObject, stickyState.refs.table); + const tableRef = useMergeRefs(tableRefObject, stickyState.refs.table); const autoSkeletonRows = useAutoSkeletonRows({ enabled: !!loading && skeleton?.totalRows === 'auto', maxRows: skeleton?.maxAutoRows, @@ -493,7 +491,7 @@ const InternalTable = React.forwardRef( const wrapperProps = getTableWrapperRoleProps({ tableRole, - isScrollable: !!(tableWidth && containerWidth && tableWidth > containerWidth), + isScrollable, ariaLabel: ariaLabels?.tableLabel, ariaLabelledby, }); @@ -614,7 +612,7 @@ const InternalTable = React.forwardRef( onScroll={handleScroll} {...wrapperProps} > -
+
{!!renderAriaLive && !!firstIndex && !loading && (