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/fix-null-responsive-value.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 26 additions & 1 deletion packages/react/src/hooks/__tests__/useResponsiveValue.test.tsx
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -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<string> | null}) => useResponsiveValue(value, 'fallback'),
{initialProps: {value: {regular: 'regularValue'} as ResponsiveValue<string> | 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<boolean>, true)
Expand Down
6 changes: 5 additions & 1 deletion packages/react/src/hooks/useResponsiveValue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ export type FlattenResponsiveValue<T> =
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function isResponsiveValue(value: any): value is ResponsiveValue<any> {
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))
)
}

/**
Expand Down
Loading