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
27 changes: 25 additions & 2 deletions modules/react/common/lib/utils/useResizeObserver.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
import useResizeObserver from 'use-resize-observer';
import {RefCallback} from 'react';
import * as resizeObserver from 'use-resize-observer';

export {useResizeObserver};
type ObservedSize = {
width: number | undefined;
height: number | undefined;
};

// Keep our public declaration independent of the installed dependency's export shape.
type ResizeObserverHook = <T extends Element>(opts?: {
// RefObject's generic nullability differs between React 17/18 and React 19.
ref?: {readonly current: T | null} | T | null;
onResize?: (size: ObservedSize) => void;
box?: 'border-box' | 'content-box' | 'device-pixel-content-box';
round?: (n: number) => number;
}) => ObservedSize & {ref: RefCallback<T>};

// Reading through a parameter avoids bundler warnings about exports missing in v9 or v10.
function getUseResizeObserver(module: {
useResizeObserver?: ResizeObserverHook;
default?: ResizeObserverHook;
}): ResizeObserverHook {
return (module.useResizeObserver ?? module.default)!;
}

export const useResizeObserver = getUseResizeObserver(resizeObserver);
40 changes: 40 additions & 0 deletions modules/react/common/spec/useResizeObserver.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
beforeEach(() => {
vi.resetModules();
});

afterEach(() => {
vi.doUnmock('use-resize-observer');
});

describe('useResizeObserver', () => {
it.each(['default', 'useResizeObserver'])('should support the %s export', async exportName => {
const result = {ref: vi.fn(), width: 100, height: 50};
const hook = vi.fn(() => result);
vi.doMock('use-resize-observer', () => ({
default: undefined,
useResizeObserver: undefined,
[exportName]: hook,
}));

const {useResizeObserver} = await import('../lib/utils/useResizeObserver');
const options = {box: 'border-box' as const, round: Math.floor, onResize: vi.fn()};

expect(useResizeObserver<HTMLDivElement>(options)).toBe(result);
expect(hook).toHaveBeenCalledWith(options);
});

it('should prefer the named export when both are present', async () => {
const namedHook = vi.fn(() => ({ref: vi.fn(), width: 0, height: 0}));
const defaultHook = vi.fn();
vi.doMock('use-resize-observer', () => ({
useResizeObserver: namedHook,
default: defaultHook,
}));

const {useResizeObserver} = await import('../lib/utils/useResizeObserver');

expect(useResizeObserver().width).toBe(0);
expect(namedHook).toHaveBeenCalledOnce();
expect(defaultHook).not.toHaveBeenCalled();
});
});
Loading