Skip to content

feat(next/image): add support for images.qualities in next.config #74257

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.

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

Merged
merged 13 commits into from
Jan 3, 2025
Prev Previous commit
Next Next commit
adjust default to config value closest to 75
  • Loading branch information
styfle committed Jan 2, 2025
commit faf1a99fa5695da9fe7229897b22fca05f34996f
3 changes: 2 additions & 1 deletion packages/next/src/client/image-component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,8 @@ export const Image = forwardRef<HTMLImageElement | null, ImageProps>(
const c = configEnv || configContext || imageConfigDefault
const allSizes = [...c.deviceSizes, ...c.imageSizes].sort((a, b) => a - b)
const deviceSizes = c.deviceSizes.sort((a, b) => a - b)
return { ...c, allSizes, deviceSizes }
const qualities = c.qualities?.sort((a, b) => a - b)
return { ...c, allSizes, deviceSizes, qualities }
}, [configContext])

const { onLoad, onLoadingComplete } = props
Expand Down
3 changes: 2 additions & 1 deletion packages/next/src/client/legacy/image.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,8 @@ export default function Image({
const c = configEnv || configContext || imageConfigDefault
const allSizes = [...c.deviceSizes, ...c.imageSizes].sort((a, b) => a - b)
const deviceSizes = c.deviceSizes.sort((a, b) => a - b)
return { ...c, allSizes, deviceSizes }
const qualities = c.qualities?.sort((a, b) => a - b)
return { ...c, allSizes, deviceSizes, qualities }
}, [configContext])

let rest: Partial<ImageProps> = all
Expand Down
3 changes: 2 additions & 1 deletion packages/next/src/shared/lib/get-img-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,8 @@ export function getImgProps(
} else {
const allSizes = [...c.deviceSizes, ...c.imageSizes].sort((a, b) => a - b)
const deviceSizes = c.deviceSizes.sort((a, b) => a - b)
config = { ...c, allSizes, deviceSizes }
const qualities = c.qualities?.sort((a, b) => a - b)
config = { ...c, allSizes, deviceSizes, qualities }
}

if (typeof defaultLoader === 'undefined') {
Expand Down
14 changes: 10 additions & 4 deletions packages/next/src/shared/lib/image-loader.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import type { ImageLoaderPropsWithConfig } from './image-config'

const DEFAULT_Q = 75

function defaultLoader({
config,
src,
Expand Down Expand Up @@ -81,10 +83,14 @@ function defaultLoader({
}
}

return `${config.path}?url=${encodeURIComponent(src)}&w=${width}&q=${
// TODO: switch from .slice(-1)[0] to .at(-1) when we drop old Safari (pre 15.4)
quality || config.qualities?.slice(-1)[0] || 75
}${
const q =
quality ||
config.qualities?.reduce((prev, cur) =>
Math.abs(cur - DEFAULT_Q) < Math.abs(prev - DEFAULT_Q) ? cur : prev
) ||
DEFAULT_Q

return `${config.path}?url=${encodeURIComponent(src)}&w=${width}&q=${q}${
src.startsWith('/_next/static/media/') && process.env.NEXT_DEPLOYMENT_ID
? `&dpl=${process.env.NEXT_DEPLOYMENT_ID}`
: ''
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const Page = () => {
<Image alt="q-undefined" id="q-undefined" src={src} />
<Image alt="q-42" id="q-42" quality={42} src={src} />
<Image alt="q-69" id="q-69" quality={69} src={src} />
<Image alt="q-88" id="q-88" quality={88} src={src} />
<Image alt="q-100" id="q-100" quality={100} src={src} />
</main>
)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
images: {
qualities: [42, 69],
qualities: [42, 69, 88],
},
}
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ function runTests(mode: 'dev' | 'server') {
expect(res.status).toStrictEqual(200)
})

it('should load img when quality 88', async () => {
const browser = await webdriver(appPort, '/')
if (mode === 'dev') {
await assertNoRedbox(browser)
}
const url = await getSrc(browser, 'q-88')
const res = await fetchViaHTTP(appPort, url)
expect(res.status).toStrictEqual(200)
})

it('should fail to load img when quality is 100', async () => {
const page = '/invalid-quality'
const browser = await webdriver(appPort, page)
Expand Down Expand Up @@ -99,7 +109,7 @@ function runTests(mode: 'dev' | 'server') {
localPatterns: undefined,
minimumCacheTTL: 60,
path: '/_next/image',
qualities: [42, 69],
qualities: [42, 69, 88],
sizes: [
640, 750, 828, 1080, 1200, 1920, 2048, 3840, 16, 32, 48, 64, 96,
128, 256, 384,
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy