react-code-dataset
/
next.js
/docs
/01-app
/03-api-reference
/05-config
/01-next-config-js
/images.mdx
| --- | |
| title: images | |
| description: Custom configuration for the next/image loader | |
| --- | |
| {/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */} | |
| If you want to use a cloud provider to optimize images instead of using the Next.js built-in Image Optimization API, you can configure `next.config.js` with the following: | |
| ```js filename="next.config.js" | |
| module.exports = { | |
| images: { | |
| loader: 'custom', | |
| loaderFile: './my/image/loader.js', | |
| }, | |
| } | |
| ``` | |
| This `loaderFile` must point to a file relative to the root of your Next.js application. The file must export a default function that returns a string, for example: | |
| <AppOnly> | |
| ```js filename="my/image/loader.js" | |
| 'use client' | |
| export default function myImageLoader({ src, width, quality }) { | |
| return `https://example.com/${src}?w=${width}&q=${quality || 75}` | |
| } | |
| ``` | |
| Alternatively, you can use the [`loader` prop](/docs/app/api-reference/components/image#loader) to pass the function to each instance of `next/image`. | |
| > **Good to know**: Customizing the image loader file, which accepts a function, requires using [Client Components](/docs/app/getting-started/server-and-client-components) to serialize the provided function. | |
| To learn more about configuring the behavior of the built-in [Image Optimization API](/docs/app/api-reference/components/image) and the [Image Component](/docs/app/api-reference/components/image), see [Image Configuration Options](/docs/app/api-reference/components/image#configuration-options) for available options. | |
| </AppOnly> | |
| <PagesOnly> | |
| ```js filename="my/image/loader.js" | |
| export default function myImageLoader({ src, width, quality }) { | |
| return `https://example.com/${src}?w=${width}&q=${quality || 75}` | |
| } | |
| ``` | |
| Alternatively, you can use the [`loader` prop](/docs/pages/api-reference/components/image#loader) to pass the function to each instance of `next/image`. | |
| To learn more about configuring the behavior of the built-in [Image Optimization API](/docs/pages/api-reference/components/image) and the [Image Component](/docs/pages/api-reference/components/image), see [Image Configuration Options](/docs/pages/api-reference/components/image#configuration-options) for available options. | |
| </PagesOnly> | |
| ## Example Loader Configuration | |
| - [Akamai](#akamai) | |
| - [AWS CloudFront](#aws-cloudfront) | |
| - [Cloudinary](#cloudinary) | |
| - [Cloudflare](#cloudflare) | |
| - [Contentful](#contentful) | |
| - [Fastly](#fastly) | |
| - [Gumlet](#gumlet) | |
| - [ImageEngine](#imageengine) | |
| - [Imgix](#imgix) | |
| - [PixelBin](#pixelbin) | |
| - [Sanity](#sanity) | |
| - [Sirv](#sirv) | |
| - [Supabase](#supabase) | |
| - [Thumbor](#thumbor) | |
| - [Imagekit](#imagekitio) | |
| - [Nitrogen AIO](#nitrogen-aio) | |
| ### Akamai | |
| ```js | |
| // Docs: https://techdocs.akamai.com/ivm/reference/test-images-on-demand | |
| export default function akamaiLoader({ src, width, quality }) { | |
| return `https://example.com/${src}?imwidth=${width}` | |
| } | |
| ``` | |
| ### AWS CloudFront | |
| ```js | |
| // Docs: https://aws.amazon.com/developer/application-security-performance/articles/image-optimization | |
| export default function cloudfrontLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| url.searchParams.set('format', 'auto') | |
| url.searchParams.set('width', width.toString()) | |
| url.searchParams.set('quality', (quality || 75).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### Cloudinary | |
| ```js | |
| // Demo: https://res.cloudinary.com/demo/image/upload/w_300,c_limit,q_auto/turtles.jpg | |
| export default function cloudinaryLoader({ src, width, quality }) { | |
| const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality || 'auto'}`] | |
| return `https://example.com/${params.join(',')}${src}` | |
| } | |
| ``` | |
| ### Cloudflare | |
| ```js | |
| // Docs: https://developers.cloudflare.com/images/transform-images | |
| export default function cloudflareLoader({ src, width, quality }) { | |
| const params = [`width=${width}`, `quality=${quality || 75}`, 'format=auto'] | |
| return `https://example.com/cdn-cgi/image/${params.join(',')}/${src}` | |
| } | |
| ``` | |
| ### Contentful | |
| ```js | |
| // Docs: https://www.contentful.com/developers/docs/references/images-api/ | |
| export default function contentfulLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| url.searchParams.set('fm', 'webp') | |
| url.searchParams.set('w', width.toString()) | |
| url.searchParams.set('q', (quality || 75).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### Fastly | |
| ```js | |
| // Docs: https://developer.fastly.com/reference/io/ | |
| export default function fastlyLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| url.searchParams.set('auto', 'webp') | |
| url.searchParams.set('width', width.toString()) | |
| url.searchParams.set('quality', (quality || 75).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### Gumlet | |
| ```js | |
| // Docs: https://docs.gumlet.com/reference/image-transform-size | |
| export default function gumletLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| url.searchParams.set('format', 'auto') | |
| url.searchParams.set('w', width.toString()) | |
| url.searchParams.set('q', (quality || 75).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### ImageEngine | |
| ```js | |
| // Docs: https://support.imageengine.io/hc/en-us/articles/360058880672-Directives | |
| export default function imageengineLoader({ src, width, quality }) { | |
| const compression = 100 - (quality || 50) | |
| const params = [`w_${width}`, `cmpr_${compression}`)] | |
| return `https://example.com${src}?imgeng=/${params.join('/')` | |
| } | |
| ``` | |
| ### Imgix | |
| ```js | |
| // Demo: https://static.imgix.net/daisy.png?format=auto&fit=max&w=300 | |
| export default function imgixLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| const params = url.searchParams | |
| params.set('auto', params.getAll('auto').join(',') || 'format') | |
| params.set('fit', params.get('fit') || 'max') | |
| params.set('w', params.get('w') || width.toString()) | |
| params.set('q', (quality || 50).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### PixelBin | |
| ```js | |
| // Doc (Resize): https://www.pixelbin.io/docs/transformations/basic/resize/#width-w | |
| // Doc (Optimise): https://www.pixelbin.io/docs/optimizations/quality/#image-quality-when-delivering | |
| // Doc (Auto Format Delivery): https://www.pixelbin.io/docs/optimizations/format/#automatic-format-selection-with-f_auto-url-parameter | |
| export default function pixelBinLoader({ src, width, quality }) { | |
| const name = '<your-cloud-name>' | |
| const opt = `t.resize(w:${width})~t.compress(q:${quality || 75})` | |
| return `https://cdn.pixelbin.io/v2/${name}/${opt}/${src}?f_auto=true` | |
| } | |
| ``` | |
| ### Sanity | |
| ```js | |
| // Docs: https://www.sanity.io/docs/image-urls | |
| export default function sanityLoader({ src, width, quality }) { | |
| const prj = 'zp7mbokg' | |
| const dataset = 'production' | |
| const url = new URL(`https://cdn.sanity.io/images/${prj}/${dataset}${src}`) | |
| url.searchParams.set('auto', 'format') | |
| url.searchParams.set('fit', 'max') | |
| url.searchParams.set('w', width.toString()) | |
| if (quality) { | |
| url.searchParams.set('q', quality.toString()) | |
| } | |
| return url.href | |
| } | |
| ``` | |
| ### Sirv | |
| ```js | |
| // Docs: https://sirv.com/help/articles/dynamic-imaging/ | |
| export default function sirvLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| const params = url.searchParams | |
| params.set('format', params.getAll('format').join(',') || 'optimal') | |
| params.set('w', params.get('w') || width.toString()) | |
| params.set('q', (quality || 85).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### Supabase | |
| ```js | |
| // Docs: https://supabase.com/docs/guides/storage/image-transformations#nextjs-loader | |
| export default function supabaseLoader({ src, width, quality }) { | |
| const url = new URL(`https://example.com${src}`) | |
| url.searchParams.set('width', width.toString()) | |
| url.searchParams.set('quality', (quality || 75).toString()) | |
| return url.href | |
| } | |
| ``` | |
| ### Thumbor | |
| ```js | |
| // Docs: https://thumbor.readthedocs.io/en/latest/ | |
| export default function thumborLoader({ src, width, quality }) { | |
| const params = [`${width}x0`, `filters:quality(${quality || 75})`] | |
| return `https://example.com${params.join('/')}${src}` | |
| } | |
| ``` | |
| ### ImageKit.io | |
| ```js | |
| // Docs: https://imagekit.io/docs/image-transformation | |
| export default function imageKitLoader({ src, width, quality }) { | |
| const params = [`w-${width}`, `q-${quality || 80}`] | |
| return `https://ik.imagekit.io/your_imagekit_id/${src}?tr=${params.join(',')}` | |
| } | |
| ``` | |
| ### Nitrogen AIO | |
| ```js | |
| // Docs: https://docs.n7.io/aio/intergrations/ | |
| export default function aioLoader({ src, width, quality }) { | |
| const url = new URL(src, window.location.href) | |
| const params = url.searchParams | |
| const aioParams = params.getAll('aio') | |
| aioParams.push(`w-${width}`) | |
| if (quality) { | |
| aioParams.push(`q-${quality.toString()}`) | |
| } | |
| params.set('aio', aioParams.join(';')) | |
| return url.href | |
| } | |
| ``` | |