diff --git a/.changeset/fix-null-responsive-value.md b/.changeset/fix-null-responsive-value.md new file mode 100644 index 00000000000..4ab106b11b9 --- /dev/null +++ b/.changeset/fix-null-responsive-value.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Fix `useResponsiveValue` throwing when passed `null` as a non-responsive value. The hook now returns `null` unchanged, just like other non-responsive values. diff --git a/packages/react/src/hooks/__tests__/useResponsiveValue.test.tsx b/packages/react/src/hooks/__tests__/useResponsiveValue.test.tsx index 84a0217889f..4a48fae58aa 100644 --- a/packages/react/src/hooks/__tests__/useResponsiveValue.test.tsx +++ b/packages/react/src/hooks/__tests__/useResponsiveValue.test.tsx @@ -1,4 +1,4 @@ -import {act, render} from '@testing-library/react' +import {act, render, renderHook} from '@testing-library/react' import {expect, it} from 'vitest' import type {ResponsiveValue} from '../../hooks/useResponsiveValue' import {useResponsiveValue} from '../../hooks/useResponsiveValue' @@ -15,6 +15,31 @@ it('accepts non-responsive values', () => { expect(getByText('test')).toBeInTheDocument() }) +it('preserves null as a non-responsive value instead of using the fallback', () => { + const {result} = renderHook(() => useResponsiveValue(null, 'fallback')) + + expect(result.current).toBeNull() +}) + +it('can switch between responsive values and null', async () => { + await act(async () => { + await page.viewport(1000, 600) + }) + + const {result, rerender} = renderHook( + ({value}: {value: ResponsiveValue | null}) => useResponsiveValue(value, 'fallback'), + {initialProps: {value: {regular: 'regularValue'} as ResponsiveValue | null}}, + ) + + expect(result.current).toBe('regularValue') + + rerender({value: null}) + expect(result.current).toBeNull() + + rerender({value: {regular: 'updatedValue'}}) + expect(result.current).toBe('updatedValue') +}) + it('returns narrow value when viewport is narrow', async () => { const Component = () => { const value = useResponsiveValue({narrow: false, regular: true} as ResponsiveValue, true) diff --git a/packages/react/src/hooks/useResponsiveValue.ts b/packages/react/src/hooks/useResponsiveValue.ts index 446c9cf343e..9be6a794e7d 100644 --- a/packages/react/src/hooks/useResponsiveValue.ts +++ b/packages/react/src/hooks/useResponsiveValue.ts @@ -34,7 +34,11 @@ export type FlattenResponsiveValue = */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export function isResponsiveValue(value: any): value is ResponsiveValue { - return typeof value === 'object' && Object.keys(value).some(key => ['narrow', 'regular', 'wide'].includes(key)) + return ( + value !== null && + typeof value === 'object' && + Object.keys(value).some(key => ['narrow', 'regular', 'wide'].includes(key)) + ) } /**