Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions src/table/__tests__/scrollable-wrapper.test.tsx
Original file line number Diff line number Diff line change
@@ -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<Element>();

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(
<Table<Item>
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();
});
14 changes: 6 additions & 8 deletions src/table/internal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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<number>(rect => rect.borderBoxWidth);
const wrapperMeasureRefObject = useRef(null);
const wrapperMeasureMergedRef = useMergeRefs(wrapperMeasureRef, wrapperMeasureRefObject);

const [tableWidth, tableMeasureRef] = useContainerQuery<number>(rect => rect.borderBoxWidth);
const wrapperMeasureRefObject = useRef<HTMLDivElement>(null);
const tableRefObject = useRef<HTMLTableElement>(null);
const isScrollable = useIsTableScrollable(wrapperMeasureRefObject, tableRefObject);

const secondaryWrapperRef = React.useRef<HTMLDivElement>(null);
const theadRef = useRef<HTMLTableRowElement>(null);
Expand Down Expand Up @@ -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,
Expand All @@ -493,7 +491,7 @@ const InternalTable = React.forwardRef(

const wrapperProps = getTableWrapperRoleProps({
tableRole,
isScrollable: !!(tableWidth && containerWidth && tableWidth > containerWidth),
isScrollable,
ariaLabel: ariaLabels?.tableLabel,
ariaLabelledby,
});
Expand Down Expand Up @@ -614,7 +612,7 @@ const InternalTable = React.forwardRef(
onScroll={handleScroll}
{...wrapperProps}
>
<div className={styles['wrapper-content-measure']} ref={wrapperMeasureMergedRef}></div>
<div className={styles['wrapper-content-measure']} ref={wrapperMeasureRefObject}></div>
{!!renderAriaLive && !!firstIndex && !loading && (
<InternalLiveRegion hidden={true} tagName="span">
<span>
Expand Down
38 changes: 38 additions & 0 deletions src/table/use-is-table-scrollable.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { RefObject, useRef, useState } from 'react';

import { useResizeObserver } from '@cloudscape-design/component-toolkit/internal';

/**
* Determines whether the table is wider than its container (i.e. it scrolls horizontally).
*
* Only the boolean is kept in state, so the table re-renders when it flips rather than on every
* width change. Resizing a column changes the table width on every pointer move, and keeping
* the raw widths in state would re-render the entire table body each time.
*/
export function useIsTableScrollable(containerRef: RefObject<HTMLElement>, tableRef: RefObject<HTMLElement>): boolean {
// Starts as `null` (not measured) so that the first measurement commits one render after mount, as
// `useContainerQuery` did. Parts of the table rely on that render, e.g. attributes from `useDOMAttribute`.
const [isScrollable, setIsScrollable] = useState<boolean | null>(null);
const containerWidthRef = useRef(0);
const tableWidthRef = useRef(0);

const update = () => {
const containerWidth = containerWidthRef.current;
const tableWidth = tableWidthRef.current;
setIsScrollable(!!(tableWidth && containerWidth && tableWidth > containerWidth));
};

useResizeObserver(containerRef, entry => {
containerWidthRef.current = entry.borderBoxWidth;
update();
});

useResizeObserver(tableRef, entry => {
tableWidthRef.current = entry.borderBoxWidth;
update();
});

return !!isScrollable;
}
Loading