Skip to content
Merged
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
2 changes: 1 addition & 1 deletion src/DataGrid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ export function DataGrid<R, SR = unknown, K extends Key = Key>(props: DataGridPr
* states
*/
const { scrollTop, scrollLeft } = useScrollState(gridRef);
const [gridWidth, gridHeight] = useGridDimensions({ gridRef });
const [gridWidth, gridHeight] = useGridDimensions(gridRef);
const [columnWidthsInternal, setColumnWidthsInternal] = useState(
(): ColumnWidths => columnWidthsRaw ?? new Map()
);
Expand Down
2 changes: 1 addition & 1 deletion src/EditCell.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export default function EditCell<R, SR>({

// We need to prevent the `useLayoutEffect` from cleaning up between re-renders,
// as `onWindowCaptureMouseDown` might otherwise miss valid mousedown events.
// To that end we instead access the latest props via useLatestFunc.
// To that end we instead access the latest props via useEffectEvent.
const commitOnOutsideMouseDown = useEffectEvent(() => {
onClose(true, false);
});
Expand Down
98 changes: 72 additions & 26 deletions src/hooks/useGridDimensions.ts
Original file line number Diff line number Diff line change
@@ -1,39 +1,85 @@
import { useLayoutEffect, useState } from 'react';
import { flushSync } from 'react-dom';
import { useCallback, useLayoutEffect, useSyncExternalStore, type RefObject } from 'react';

export function useGridDimensions({
gridRef
}: {
gridRef: React.RefObject<HTMLDivElement | null>;
}) {
const [inlineSize, setInlineSize] = useState(1);
const [blockSize, setBlockSize] = useState(1);
const initialSize: ResizeObserverSize = {
inlineSize: 1,
blockSize: 1
};

useLayoutEffect(() => {
const { ResizeObserver } = window;
// use an unmanaged WeakMap so we preserve the cache even when
// the component partially unmounts via Suspense or Activity
const sizeMap = new WeakMap<RefObject<HTMLDivElement | null>, ResizeObserverSize>();
const targetToRefMap = new WeakMap<HTMLDivElement, RefObject<HTMLDivElement | null>>();
const subscribers = new Map<RefObject<HTMLDivElement | null>, () => void>();

// don't break in Node.js (SSR), jsdom, and environments that don't support ResizeObserver
const resizeObserver =
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
globalThis.ResizeObserver == null ? null : new ResizeObserver(resizeObserverCallback);

function resizeObserverCallback(entries: ResizeObserverEntry[]) {
for (const entry of entries) {
const target = entry.target as HTMLDivElement;

if (targetToRefMap.has(target)) {
const ref = targetToRefMap.get(target)!;
updateSize(ref, entry.contentBoxSize[0]);
}
}
}

function updateSize(ref: RefObject<HTMLDivElement | null>, size: ResizeObserverSize) {
if (sizeMap.has(ref)) {
const prevSize = sizeMap.get(ref)!;
if (prevSize.inlineSize === size.inlineSize && prevSize.blockSize === size.blockSize) {
return;
}
}

sizeMap.set(ref, size);
subscribers.get(ref)?.();
}

function getServerSnapshot(): ResizeObserverSize {
return initialSize;
}

// don't break in Node.js (SSR), jsdom, and browsers that don't support ResizeObserver
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (ResizeObserver == null) return;
export function useGridDimensions(gridRef: React.RefObject<HTMLDivElement | null>) {
const subscribe = useCallback(
(onStoreChange: () => void) => {
subscribers.set(gridRef, onStoreChange);

const { clientWidth, clientHeight } = gridRef.current!;
return () => {
subscribers.delete(gridRef);
};
},
[gridRef]
);

setInlineSize(clientWidth);
setBlockSize(clientHeight);
const getSnapshot = useCallback((): ResizeObserverSize => {
// ref.current is null during the initial render, when suspending, or in <Activity mode="hidden">.
// We use ref as key instead to access stable values regardless of rendering state.
return sizeMap.get(gridRef) ?? initialSize;
}, [gridRef]);

// We use `useSyncExternalStore` instead of `useState` to avoid tearing,
// which can lead to flashing scrollbars.
const { inlineSize, blockSize } = useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);

useLayoutEffect(() => {
const target = gridRef.current!;

const resizeObserver = new ResizeObserver((entries) => {
const size = entries[0].contentBoxSize[0];
targetToRefMap.set(target, gridRef);
resizeObserver?.observe(target);

// we use flushSync here to avoid flashing scrollbars
flushSync(() => {
setInlineSize(size.inlineSize);
setBlockSize(size.blockSize);
if (!sizeMap.has(gridRef)) {
updateSize(gridRef, {
inlineSize: target.clientWidth,
blockSize: target.clientHeight
});
});
resizeObserver.observe(gridRef.current!);
}

return () => {
resizeObserver.disconnect();
resizeObserver?.unobserve(target);
};
}, [gridRef]);

Expand Down
18 changes: 2 additions & 16 deletions test/failOnConsole.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
beforeEach(({ onTestFinished }) => {
vi.spyOn(console, 'warn').mockName('console.warn');

// use split mocks to not increase the calls count when ignoring undesired logs
const errorMock = vi.fn(console.error).mockName('console.error');
vi.spyOn(console, 'error').mockImplementation(function error(...params) {
// https://github.com/vitest-dev/vitest/blob/0685b6f027576589464fc6109ddc071ef0079f16/packages/browser/src/client/public/error-catcher.js#L34-L38
// https://github.com/vitest-dev/vitest/blob/0685b6f027576589464fc6109ddc071ef0079f16/test/browser/fixtures/unhandled-non-error/basic.test.ts
if (
Error.isError(params[0]) &&
params[0].message === 'ResizeObserver loop completed with undelivered notifications.'
) {
return;
}

return errorMock(...params);
});
vi.spyOn(console, 'error').mockName('console.error');

// Wait for the test and all `afterEach` hooks to complete to ensure all logs are caught
onTestFinished(({ expect, task, signal }) => {
Expand All @@ -29,7 +15,7 @@ beforeEach(({ onTestFinished }) => {
.toHaveBeenCalledTimes(0);
expect
.soft(
errorMock,
console.error,
'console.error() was called during the test; please resolve unexpected errors'
)
.toHaveBeenCalledTimes(0);
Expand Down
2 changes: 2 additions & 0 deletions website/routes/MasterDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ function MasterDetail() {
cellClass(row) {
return row.type === 'DETAIL'
? css`
/* allows shrinking the inner grid */
contain: inline-size;
padding: 24px;
`
: undefined;
Expand Down
Loading