From 01c9ce554613755ec46629c5ac31f3562ac844c4 Mon Sep 17 00:00:00 2001 From: nemo-crypto <34638540+nemo-crypto@users.noreply.github.com> Date: Sun, 22 Nov 2026 10:58:32 +0800 Subject: [PATCH] fix: deduplicate fallback resize notifications --- .../resize-observer-fallback-deduplication.md | 5 ++++ .../__tests__/useResizeObserver.test.tsx | 30 +++++++++++++++++++ packages/react/src/hooks/useResizeObserver.ts | 15 ++++------ 3 files changed, 41 insertions(+), 9 deletions(-) create mode 100644 .changeset/resize-observer-fallback-deduplication.md create mode 100644 packages/react/src/hooks/__tests__/useResizeObserver.test.tsx diff --git a/.changeset/resize-observer-fallback-deduplication.md b/.changeset/resize-observer-fallback-deduplication.md new file mode 100644 index 00000000000..7e181d7746c --- /dev/null +++ b/.changeset/resize-observer-fallback-deduplication.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Avoid duplicate resize notifications and renders when the `useResizeObserver` fallback measures unchanged dimensions. diff --git a/packages/react/src/hooks/__tests__/useResizeObserver.test.tsx b/packages/react/src/hooks/__tests__/useResizeObserver.test.tsx new file mode 100644 index 00000000000..f8599088e7d --- /dev/null +++ b/packages/react/src/hooks/__tests__/useResizeObserver.test.tsx @@ -0,0 +1,30 @@ +import {renderHook} from '@testing-library/react' +import {afterEach, expect, it, vi} from 'vitest' +import {useResizeObserver} from '../useResizeObserver' + +afterEach(() => { + vi.unstubAllGlobals() + vi.restoreAllMocks() +}) + +it('only notifies about dimension changes in the window resize fallback', () => { + vi.stubGlobal('ResizeObserver', undefined) + const element = document.createElement('div') + const rect = vi.spyOn(element, 'getBoundingClientRect').mockReturnValue(new DOMRect(0, 0, 100, 50)) + const onResize = vi.fn() + const {unmount} = renderHook(() => useResizeObserver(onResize, {current: element})) + + window.dispatchEvent(new Event('resize')) + window.dispatchEvent(new Event('resize')) + expect(onResize).toHaveBeenCalledTimes(1) + + const resized = new DOMRect(0, 0, 100, 75) + rect.mockReturnValue(resized) + window.dispatchEvent(new Event('resize')) + expect(onResize).toHaveBeenCalledTimes(2) + expect(onResize).toHaveBeenLastCalledWith([{contentRect: resized}]) + + unmount() + window.dispatchEvent(new Event('resize')) + expect(onResize).toHaveBeenCalledTimes(2) +}) diff --git a/packages/react/src/hooks/useResizeObserver.ts b/packages/react/src/hooks/useResizeObserver.ts index 20636071b8a..eaa75c54ae4 100644 --- a/packages/react/src/hooks/useResizeObserver.ts +++ b/packages/react/src/hooks/useResizeObserver.ts @@ -1,5 +1,5 @@ import type {RefObject} from 'react' -import {useRef, useState} from 'react' +import {useRef} from 'react' import useLayoutEffect from '../utils/useIsomorphicLayoutEffect' // https://gist.github.com/strothj/708afcf4f01dd04de8f49c92e88093c3 @@ -15,7 +15,6 @@ export function useResizeObserver( depsArray: unknown[] = [], enabled: boolean = true, ) { - const [targetClientRect, setTargetClientRect] = useState(null) const savedCallback = useRef(callback) useLayoutEffect(() => { @@ -42,17 +41,15 @@ export function useResizeObserver( observer.disconnect() } } else { + let targetClientRect: DOMRect | undefined const saveTargetDimensions = () => { const currTargetRect = targetEl.getBoundingClientRect() - if (currTargetRect.width !== targetClientRect?.width || currTargetRect.height !== targetClientRect.height) { - savedCallback.current([ - { - contentRect: currTargetRect, - }, - ]) + if (currTargetRect.width === targetClientRect?.width && currTargetRect.height === targetClientRect.height) { + return } - setTargetClientRect(currTargetRect) + targetClientRect = currTargetRect + savedCallback.current([{contentRect: currTargetRect}]) } // eslint-disable-next-line github/prefer-observers window.addEventListener('resize', saveTargetDimensions)