Skip to content
Open
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
5 changes: 5 additions & 0 deletions .changeset/resize-observer-fallback-deduplication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Avoid duplicate resize notifications and renders when the `useResizeObserver` fallback measures unchanged dimensions.
30 changes: 30 additions & 0 deletions packages/react/src/hooks/__tests__/useResizeObserver.test.tsx
Original file line number Diff line number Diff line change
@@ -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)
})
15 changes: 6 additions & 9 deletions packages/react/src/hooks/useResizeObserver.ts
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -15,7 +15,6 @@ export function useResizeObserver<T extends HTMLElement>(
depsArray: unknown[] = [],
enabled: boolean = true,
) {
const [targetClientRect, setTargetClientRect] = useState<DOMRect | null>(null)
const savedCallback = useRef(callback)

useLayoutEffect(() => {
Expand All @@ -42,17 +41,15 @@ export function useResizeObserver<T extends HTMLElement>(
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)
Expand Down
Loading