Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(next/image): improve warning when fill and sizes="100vw" #61949

Merged
merged 2 commits into from
Feb 12, 2024
Merged

fix(next/image): improve warning when fill and sizes="100vw" #61949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96beaaf
fix(next/image): improve warning when `fill` and `sizes="100vw"`
styfle Feb 12, 2024
cc24ee9
Merge branch 'canary' into styfle/next-2441-fix-warning-sizes-prop
styfle Feb 12, 2024
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
30 changes: 20 additions & 10 deletions packages/next/src/client/image-component.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ type ImageElementProps = ImgProps & {
onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined>
setBlurComplete: (b: boolean) => void
setShowAltText: (b: boolean) => void
sizesInput: string | undefined
}

// See https://stackoverflow.com/q/39777833/266535 for why we use this ref
Expand All @@ -63,7 +64,8 @@ function handleLoading(
onLoadRef: React.MutableRefObject<OnLoad | undefined>,
onLoadingCompleteRef: React.MutableRefObject<OnLoadingComplete | undefined>,
setBlurComplete: (b: boolean) => void,
unoptimized: boolean
unoptimized: boolean,
sizesInput: string | undefined
) {
const src = img?.src
if (!img || img['data-loaded-src'] === src) {
Expand Down Expand Up @@ -115,16 +117,19 @@ function handleLoading(
if (process.env.NODE_ENV !== 'production') {
const origSrc = new URL(src, 'http://n').searchParams.get('url') || src
if (img.getAttribute('data-nimg') === 'fill') {
if (
!unoptimized &&
(!img.getAttribute('sizes') || img.getAttribute('sizes') === '100vw')
) {
if (!unoptimized && (!sizesInput || sizesInput === '100vw')) {
let widthViewportRatio =
img.getBoundingClientRect().width / window.innerWidth
if (widthViewportRatio < 0.6) {
warnOnce(
`Image with src "${origSrc}" has "fill" but is missing "sizes" prop. Please add it to improve page performance. Read more: https://nextjs.org/docs/api-reference/next/image#sizes`
)
if (sizesInput === '100vw') {
warnOnce(
`Image with src "${origSrc}" has "fill" prop and "sizes" prop of "100vw", but image is not rendered at full viewport width. Please adjust "sizes" to improve page performance. Read more: https://nextjs.org/docs/api-reference/next/image#sizes`
)
} else {
warnOnce(
`Image with src "${origSrc}" has "fill" but is missing "sizes" prop. Please add it to improve page performance. Read more: https://nextjs.org/docs/api-reference/next/image#sizes`
)
}
}
}
if (img.parentElement) {
Expand Down Expand Up @@ -197,6 +202,7 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
onLoadingCompleteRef,
setBlurComplete,
setShowAltText,
sizesInput,
onLoad,
onError,
...rest
Expand Down Expand Up @@ -262,7 +268,8 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
onLoadRef,
onLoadingCompleteRef,
setBlurComplete,
unoptimized
unoptimized,
sizesInput
)
}
},
Expand All @@ -274,6 +281,7 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
setBlurComplete,
onError,
unoptimized,
sizesInput,
forwardedRef,
]
)}
Expand All @@ -285,7 +293,8 @@ const ImageElement = forwardRef<HTMLImageElement | null, ImageElementProps>(
onLoadRef,
onLoadingCompleteRef,
setBlurComplete,
unoptimized
unoptimized,
sizesInput
)
}}
onError={(event) => {
Expand Down Expand Up @@ -406,6 +415,7 @@ export const Image = forwardRef<HTMLImageElement | null, ImageProps>(
onLoadingCompleteRef={onLoadingCompleteRef}
setBlurComplete={setBlurComplete}
setShowAltText={setShowAltText}
sizesInput={props.sizes}
ref={forwardedRef}
/>
}
Expand Down
6 changes: 6 additions & 0 deletions test/integration/next-image-new/app-dir/app/fill-warnings/page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ const Page = () => {
>
<Image id="fill-image-3" src="/wide.png" fill />
</div>
<div
id="image-container-4"
style={{ position: 'relative', width: '30vw', height: '30vw' }}
>
<Image id="fill-image-4" src="/test.png" sizes="100vw" fill />
</div>
</div>
)
}
Expand Down
3 changes: 3 additions & 0 deletions test/integration/next-image-new/app-dir/test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1318,6 +1318,9 @@ function runTests(mode) {
expect(warnings).toContain(
'Image with src "/wide.png" has "fill" but is missing "sizes" prop. Please add it to improve page performance. Read more:'
)
expect(warnings).toContain(
'Image with src "/test.png" has "fill" prop and "sizes" prop of "100vw", but image is not rendered at full viewport width. Please adjust "sizes" to improve page performance. Read more:'
)
})
it('should not log warnings when image unmounts', async () => {
browser = await webdriver(appPort, '/should-not-warn-unmount')
Expand Down
6 changes: 6 additions & 0 deletions test/integration/next-image-new/default/pages/fill-warnings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ const Page = () => {
>
<Image id="fill-image-3" src="/wide.png" fill />
</div>
<div
id="image-container-4"
style={{ position: 'relative', width: '30vw', height: '30vw' }}
>
<Image id="fill-image-4" src="/test.png" sizes="100vw" fill />
</div>
</div>
)
}
Expand Down
3 changes: 3 additions & 0 deletions test/integration/next-image-new/default/test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,9 @@ function runTests(mode) {
expect(warnings).toContain(
'Image with src "/wide.png" has "fill" but is missing "sizes" prop. Please add it to improve page performance. Read more:'
)
expect(warnings).toContain(
'Image with src "/test.png" has "fill" prop and "sizes" prop of "100vw", but image is not rendered at full viewport width. Please adjust "sizes" to improve page performance. Read more:'
)
})
it('should not log warnings when image unmounts', async () => {
browser = await webdriver(appPort, '/should-not-warn-unmount')
Expand Down
Loading