<Image>
示例
须知:如果您使用的是 Next.js 13 之前的版本,请查阅 next/legacy/image 文档,因为该组件已重命名。
本 API 参考将帮助您理解如何使用图片组件的 属性 和 配置选项。关于功能和用法,请参阅 图片组件 页面。
属性
以下是图片组件可用的属性概览:
属性 | 示例 | 类型 | 状态 |
---|---|---|---|
src | src="/profile.png" | 字符串 | 必填 |
width | width={500} | 整数 (px) | 必填 |
height | height={500} | 整数 (px) | 必填 |
alt | alt="作者照片" | 字符串 | 必填 |
loader | loader={imageLoader} | 函数 | - |
fill | fill={true} | 布尔值 | - |
sizes | sizes="(max-width: 768px) 100vw, 33vw" | 字符串 | - |
quality | quality={80} | 整数 (1-100) | - |
priority | priority={true} | 布尔值 | - |
placeholder | placeholder="blur" | 字符串 | - |
style | style={{objectFit: "contain"}} | 对象 | - |
onLoadingComplete | onLoadingComplete={img => done())} | 函数 | 已弃用 |
onLoad | onLoad={event => done())} | 函数 | - |
onError | onError(event => fail()} | 函数 | - |
loading | loading="lazy" | 字符串 | - |
blurDataURL | blurDataURL="data:image/jpeg..." | 字符串 | - |
overrideSrc | overrideSrc="/seo.png" | 字符串 | - |
必填属性
图片组件需要以下属性:src
、width
、height
和 alt
。
src
必须是以下之一:
使用外部 URL 时,必须将其添加到 next.config.js
中的 remotePatterns。
width
width
属性表示以像素为单位的 渲染 宽度,因此会影响图片显示的大小。
必填,除非是 静态导入的图片 或使用了 fill
属性 的图片。
height
height
属性表示以像素为单位的 渲染 高度,因此会影响图片显示的大小。
必填,除非是 静态导入的图片 或使用了 fill
属性 的图片。
alt
alt
属性用于为屏幕阅读器和搜索引擎描述图片。如果图片被禁用或加载出错,它也是回退文本。
应包含可以替代图片 而不改变页面含义 的文本。它不应补充图片信息,也不应重复图片上方或下方标题中已提供的信息。
如果图片是 纯装饰性 或 非用户意图 的,alt
属性应为空字符串 (alt=""
)。
可选属性
<Image />
组件接受许多除必填属性外的附加属性。本节介绍图片组件最常用的属性。更多不常用的属性详情请参阅 高级属性 部分。
loader
用于解析图片 URL 的自定义函数。
loader
是一个返回图片 URL 字符串的函数,接受以下参数:
以下是使用自定义加载器的示例:
或者,您可以在 next.config.js
中使用 loaderFile 配置来配置应用程序中的每个 next/image
实例,而无需传递属性。
fill
一个布尔值,使图片填充父元素,这在 width
和 height
未知时非常有用。
父元素 必须 设置 position: "relative"
、position: "fixed"
或 position: "absolute"
样式。
默认情况下,img 元素将自动分配 position: "absolute"
样式。
如果没有对图片应用样式,图片将拉伸以填充容器。您可能更喜欢设置 object-fit: "contain"
以使图片适应容器并保留宽高比。
或者,object-fit: "cover"
将使图片填充整个容器并裁剪以保留宽高比。为了使此效果正确,应将 overflow: "hidden"
样式分配给父元素。
更多信息,请参阅:
sizes
一个类似于媒体查询的字符串,提供有关图片在不同断点下的宽度信息。sizes
的值将极大地影响使用 fill
或 设置为响应式大小 的图片的性能。
sizes
属性有两个与图片性能相关的重要用途:
- 首先,浏览器使用
sizes
的值从next/image
自动生成的srcset
中选择要下载的图片大小。当浏览器选择时,它还不知道页面上图片的大小,因此它会选择与视口相同或更大的图片。sizes
属性允许您告诉浏览器图片实际上会比全屏小。如果在具有fill
属性的图片中未指定sizes
值,则使用默认值100vw
(全屏宽度)。 - 其次,
sizes
属性改变了自动生成的srcset
值的行为。如果没有sizes
值,则生成一个小的srcset
,适合固定大小的图片(1x/2x 等)。如果定义了sizes
,则生成一个大的srcset
,适合响应式图片(640w/750w 等)。如果sizes
属性包含诸如50vw
这样的值,表示视口宽度的百分比,则srcset
会被修剪,不包含任何可能永远不需要的小值。
例如,如果您知道您的样式会使图片在移动设备上全宽,在平板电脑上为 2 列布局,在桌面显示器上为 3 列布局,则应包含如下 sizes
属性:
这个 sizes
示例可能会对性能指标产生巨大影响。如果没有 33vw
大小,从服务器选择的图片宽度将是所需宽度的 3 倍。由于文件大小与宽度的平方成正比,没有 sizes
时,用户将下载比必要大 9 倍的图片。
了解更多关于 srcset
和 sizes
:
quality
优化图片的质量,介于 1
和 100
之间的整数,其中 100
是质量最好且文件最大的。默认为 75
。
如果在 next.config.js
中定义了 qualities
配置,quality
属性必须与配置中定义的值之一匹配。
须知:如果原始源图片质量已经很低,将
quality
属性设置得太高可能会导致优化后的图片比原始源图片更大。
priority
当为 true 时,图片将被视为高优先级并 预加载。使用 priority
的图片会自动禁用懒加载。
您应在检测为 最大内容绘制 (LCP) 元素的任何图片上使用 priority
属性。可能有多个优先级图片是合适的,因为不同的图片可能是不同视口大小的 LCP 元素。
仅当图片在首屏可见时使用。默认为 false
。
placeholder
图片加载时使用的占位符。可能的值为 blur
、empty
或 data:image/...
。默认为 empty
。
当为 blur
时,将使用 blurDataURL
属性作为占位符。如果 src
是 静态导入 的对象且导入的图片是 .jpg
、.png
、.webp
或 .avif
,则 blurDataURL
将自动填充,除非检测到图片是动画的。
对于动态图片,您必须提供 blurDataURL
属性。诸如 Plaiceholder 的解决方案可以帮助生成 base64
。
当为 data:image/...
时,Data URL 将用作图片加载时的占位符。
当为 empty
时,图片加载时将没有占位符,只有空白空间。
尝试一下:
高级属性
在某些情况下,您可能需要更高级的用法。<Image />
组件可选地接受以下高级属性。
style
允许将 CSS 样式传递给底层图片元素。
请记住,必填的 width 和 height 属性可能与您的样式交互。如果您使用样式修改图片的宽度,还应将其高度样式设置为 auto
以保留其固有宽高比,否则图片会变形。
onLoadingComplete
警告:自 Next.js 14 起已弃用,推荐使用
onLoad
。
图片完全加载且 占位符 移除后调用的回调函数。
回调函数将使用一个参数调用,即底层 <img>
元素的引用。
onLoad
图片完全加载且 占位符 移除后调用的回调函数。
回调函数将使用一个参数调用,即事件,其 target
引用底层 <img>
元素。
onError
图片加载失败时调用的回调函数。
loading
推荐:此属性仅适用于高级用例。将图片加载方式切换为
eager
通常会损害性能。我们建议改用priority
属性,该属性会主动预加载图片。
图片的加载行为。默认为 lazy
。
当设置为 lazy
时,延迟加载图片,直到其到达与视口的计算距离。
当设置为 eager
时,立即加载图片。
了解更多关于 loading
属性。
blurDataURL
一个 Data URL,用于在 src
图片成功加载前作为占位图片。仅在与 placeholder="blur"
结合使用时生效。
必须是一个 base64 编码的图片。它会被放大并模糊处理,因此建议使用非常小的图片(10px 或更小)。包含较大的图片作为占位符可能会损害应用性能。
尝试以下示例:
你也可以生成纯色 Data URL 以匹配图片颜色。
unoptimized
当为 true 时,源图片将按原样提供,不会改变质量、大小或格式。默认为 false
。
自 Next.js 12.3.0 起,可以通过更新 next.config.js
配置将此属性应用于所有图片:
overrideSrc
当向 <Image>
组件提供 src
属性时,生成的 <img>
会自动生成 srcset
和 src
属性。
在某些情况下,可能不希望生成 src
属性,而希望通过 overrideSrc
属性覆盖它。
例如,当从 <img>
升级到 <Image>
时,可能希望保持相同的 src
属性以用于 SEO 目的,如图片排名或避免重新抓取。
decoding
提示浏览器是否应等待图片解码完成后再呈现其他内容更新。默认为 async
。
可能的取值如下:
async
- 异步解码图片,允许其他内容在解码完成前渲染。sync
- 同步解码图片,与其他内容一起原子性呈现。auto
- 不指定解码模式,由浏览器决定最佳方式。
了解更多关于 decoding
属性。
其他属性
<Image />
组件的其他属性将传递给底层的 img
元素,以下属性除外:
srcSet
。请改用 设备尺寸。
配置选项
除了属性外,还可以在 next.config.js
中配置图片组件。以下是可用的选项:
localPatterns
可以在 next.config.js
文件中可选地配置 localPatterns
,以允许优化特定路径并阻止所有其他路径。
须知:以上示例确保
next/image
的src
属性必须以/assets/images/
开头且不能有查询字符串。尝试优化任何其他路径将返回 400 Bad Request。
remotePatterns
为了保护应用免受恶意用户攻击,使用外部图片需要配置。这确保只有来自你账户的外部图片可以通过 Next.js 图片优化 API 提供。这些外部图片可以在 next.config.js
文件中通过 remotePatterns
属性配置,如下所示:
须知:以上示例确保
next/image
的src
属性必须以https://example.com/account123/
开头且不能有查询字符串。任何其他协议、主机名、端口或不匹配的路径将返回 400 Bad Request。
以下是 next.config.js
文件中使用 hostname
通配符模式的 remotePatterns
属性示例:
须知:以上示例确保
next/image
的src
属性必须以https://img1.example.com
或https://me.avatar.example.com
或任意数量的子域名开头。不能有端口或查询字符串。任何其他协议或不匹配的主机名将返回 400 Bad Request。
通配符模式可用于 pathname
和 hostname
,语法如下:
*
匹配单个路径段或子域名**
匹配任意数量的路径段(末尾)或子域名(开头)
**
语法不能在模式中间使用。
须知:当省略
protocol
、port
、pathname
或search
时,默认为通配符**
。这不推荐,因为它可能允许恶意用户优化你不希望优化的 URL。
以下是 next.config.js
文件中使用 search
的 remotePatterns
属性示例:
须知:以上示例确保
next/image
的src
属性必须以https://assets.example.com
开头且必须有精确的查询字符串?v=1727111025337
。任何其他协议或查询字符串将返回 400 Bad Request。
domains
警告:自 Next.js 14 起已弃用,推荐使用严格的
remotePatterns
以保护应用免受恶意用户攻击。仅在你拥有该域名下所有内容时使用domains
。
类似于 remotePatterns
,domains
配置可用于提供允许的外部图片主机名列表。
然而,domains
配置不支持通配符模式匹配,也无法限制协议、端口或路径名。
以下是 next.config.js
文件中 domains
属性的示例:
loaderFile
如果你想使用云提供商优化图片而非 Next.js 内置的图片优化 API,可以在 next.config.js
中配置 loaderFile
,如下所示:
此路径必须相对于 Next.js 应用的根目录。该文件必须导出一个默认函数,返回字符串,例如:
或者,你可以使用 loader
属性 为每个 next/image
实例单独配置。
示例:
高级配置
以下配置适用于高级用例,通常不需要。如果选择配置以下属性,将覆盖未来更新中 Next.js 默认的任何更改。
deviceSizes
如果知道用户的预期设备宽度,可以在 next.config.js
中使用 deviceSizes
属性指定设备宽度断点列表。当 next/image
组件使用 sizes
属性时,这些宽度用于确保为用户设备提供正确的图片。
如果未提供配置,则使用以下默认值。
imageSizes
可以在 next.config.js
文件中使用 images.imageSizes
属性指定图片宽度列表。这些宽度与 设备尺寸 数组连接,形成用于生成图片 srcset 的完整尺寸数组。
之所以有两个单独的列表,是因为 imageSizes
仅用于提供 sizes
属性的图片,表示图片小于屏幕的完整宽度。因此,imageSizes
中的尺寸都应小于 deviceSizes
中的最小尺寸。
如果未提供配置,则使用以下默认值。
qualities
默认的 图片优化 API 会自动允许 1 到 100 的所有质量值。如果希望限制允许的质量值,可以在 next.config.js
中添加配置。
在上面的示例中,仅允许三种质量值:25、50 和 75。如果 quality
属性不匹配此数组中的值,图片将返回 400 Bad Request。
formats
默认的 图片优化 API 会通过请求的 Accept
头自动检测浏览器支持的图片格式。
如果 Accept
头匹配多个配置的格式,则使用数组中的第一个匹配项。因此,数组顺序很重要。如果没有匹配项(或源图片是 动画图片),图片优化 API 将回退到原始图片的格式。
如果未提供配置,则使用以下默认值。
可以通过以下配置启用 AVIF 支持。
须知:
- AVIF 通常编码时间比 WebP 长 20%,但压缩率比 WebP 高 20%。这意味着首次请求图片时通常较慢,但后续缓存的请求会更快。
- 如果在 Next.js 前使用代理/CDN 自托管,必须配置代理转发
Accept
头。
缓存行为
以下描述了默认 加载器 的缓存算法。对于其他加载器,请参考云提供商的文档。
图片在请求时动态优化并存储在 <distDir>/cache/images
目录中。优化后的图片文件将用于后续请求,直到过期。当请求匹配缓存但已过期的文件时,立即返回过期的图片。然后在后台重新优化图片(也称为重新验证)并使用新的过期日期保存到缓存中。
可以通过读取 x-nextjs-cache
响应头的值确定图片的缓存状态。可能的值如下:
MISS
- 路径不在缓存中(最多发生一次,首次访问时)STALE
- 路径在缓存中但已超过重新验证时间,将在后台更新HIT
- 路径在缓存中且未超过重新验证时间
过期时间(或最大年龄)由 minimumCacheTTL
配置或上游图片的 Cache-Control
头决定,取较大值。具体来说,使用 Cache-Control
头的 max-age
值。如果同时找到 s-maxage
和 max-age
,则优先使用 s-maxage
。max-age
也会传递给任何下游客户端,包括 CDN 和浏览器。
- 可以配置
minimumCacheTTL
在上游图片不包含Cache-Control
头或值非常低时增加缓存时间。 - 可以配置
deviceSizes
和imageSizes
以减少可能生成的图片总数。 - 可以配置 formats 禁用多种格式,仅使用单一图片格式。
minimumCacheTTL
可以配置缓存优化图片的生存时间(TTL,秒)。在许多情况下,最好使用 静态图片导入,它会自动哈希文件内容并使用 Cache-Control
头 immutable
永久缓存图片。
优化图片的过期时间(或最大年龄)由 minimumCacheTTL
或上游图片的 Cache-Control
头决定,取较大值。
如果需要按图片更改缓存行为,可以配置 headers
在上游图片(例如 /some-asset.jpg
,而非 /_next/image
本身)上设置 Cache-Control
头。
目前没有机制可以手动使缓存失效,因此最好将 minimumCacheTTL
设置为较低值。否则可能需要手动更改 src
属性或删除 <distDir>/cache/images
。
disableStaticImages
默认行为允许导入静态文件,如 import icon from './icon.png'
,然后将其传递给 src
属性。
在某些情况下,如果与其他期望导入行为不同的插件冲突,可能希望禁用此功能。
可以在 next.config.js
中禁用静态图片导入:
dangerouslyAllowSVG
默认的 loader 出于几个原因不会优化 SVG 图像。首先,SVG 是一种矢量格式,意味着它可以无损调整大小。其次,SVG 具有许多与 HTML/CSS 相同的特性,若没有正确的 内容安全策略 (CSP) 标头,可能会导致安全漏洞。
因此,当已知 src
属性为 SVG 时,我们建议使用 unoptimized
属性。当 src
以 ".svg"
结尾时,此操作会自动执行。
但如果您需要使用默认的图像优化 API 提供 SVG 图像,可以在 next.config.js
中设置 dangerouslyAllowSVG
:
此外,强烈建议同时设置 contentDispositionType
以强制浏览器下载图像,并设置 contentSecurityPolicy
以防止嵌入在图像中的脚本执行。
动画图像
默认的 loader 会自动绕过动画图像的图像优化,并按原样提供图像。
对动画文件的自动检测是尽力而为的,支持 GIF、APNG 和 WebP。如果您想明确绕过特定动画图像的图像优化,请使用 unoptimized 属性。
响应式图像
默认生成的 srcset
包含 1x
和 2x
图像,以支持不同的设备像素密度。然而,您可能希望渲染一个随视口拉伸的响应式图像。在这种情况下,您需要设置 sizes
以及 style
(或 className
)。
您可以使用以下方法之一渲染响应式图像。
使用静态导入的响应式图像
如果源图像不是动态的,您可以静态导入以创建响应式图像:
尝试一下:
带有宽高比的响应式图像
如果源图像是动态的或远程 URL,您还需要提供 width
和 height
以设置响应式图像的正确宽高比:
尝试一下:
使用 fill
的响应式图像
如果您不知道宽高比,则需要设置 fill
属性并在父元素上设置 position: relative
。可选地,您可以根据所需的拉伸或裁剪行为设置 object-fit
样式:
尝试一下:
主题检测 CSS
如果您希望在浅色和深色模式下显示不同的图像,可以创建一个新组件,包装两个 <Image>
组件,并根据 CSS 媒体查询显示正确的图像。
须知:
loading="lazy"
的默认行为确保仅加载正确的图像。您不能使用priority
或loading="eager"
,因为这会导致两个图像都加载。相反,您可以使用fetchPriority="high"
。
尝试一下:
getImageProps
对于更高级的用例,您可以调用 getImageProps()
来获取将传递给底层 <img>
元素的属性,然后将它们传递给另一个组件、样式、画布等。
这也避免了调用 React useState()
,因此可以提高性能,但不能与 placeholder
属性一起使用,因为占位符永远不会被移除。
主题检测 Picture
如果您希望在浅色和深色模式下显示不同的图像,可以使用 <picture>
元素根据用户的 首选配色方案 显示不同的图像。
艺术指导
如果您希望为移动设备和桌面设备显示不同的图像(有时称为 艺术指导),可以为 getImageProps()
提供不同的 src
、width
、height
和 quality
属性。
背景 CSS
您甚至可以将 srcSet
字符串转换为 image-set()
CSS 函数,以优化背景图像。
已知浏览器问题
此 next/image
组件使用浏览器原生的 懒加载,对于 Safari 15.4 之前的旧浏览器可能会回退到急切加载。当使用模糊占位符时,Safari 12 之前的旧浏览器会回退到空占位符。当使用 width
/height
为 auto
的样式时,可能会导致 Safari 15 之前不支持 保留宽高比 的旧浏览器出现 布局偏移 (Layout Shift)。更多详情,请参阅 此 MDN 视频。
- Safari 15 - 16.3 在加载时显示灰色边框。Safari 16.4 修复了此问题。可能的解决方案:
- 使用 CSS
@supports (font: -apple-system-body) and (-webkit-appearance: none) { img[loading="lazy"] { clip-path: inset(0.6px) } }
- 如果图像位于首屏,使用
priority
- 使用 CSS
- Firefox 67+ 在加载时显示白色背景。可能的解决方案:
- 启用 AVIF
formats
- 使用
placeholder
- 启用 AVIF
版本历史
版本 | 变更内容 |
---|---|
v14.2.23 | 新增 qualities 配置项。 |
v14.2.15 | 新增 decoding 属性及 localPatterns 配置项。 |
v14.2.14 | 新增 remotePatterns.search 属性。 |
v14.2.0 | 新增 overrideSrc 属性。 |
v14.1.0 | getImageProps() 转为稳定版。 |
v14.0.0 | 弃用 onLoadingComplete 属性及 domains 配置项。 |
v13.4.14 | placeholder 属性支持 data:/image... 格式。 |
v13.2.0 | 新增 contentDispositionType 配置项。 |
v13.0.6 | 新增 ref 属性。 |
v13.0.0 | next/image 导入路径更名为 next/legacy/image ,next/future/image 导入路径更名为 next/image 。提供 自动化迁移工具 安全重命名导入路径。移除 <span> 包裹层。移除 layout 、objectFit 、objectPosition 、lazyBoundary 、lazyRoot 属性。alt 变为必填项。onLoadingComplete 回调接收 img 元素引用。移除内置加载器配置。 |
v12.3.0 | remotePatterns 和 unoptimized 配置项转为稳定版。 |
v12.2.0 | 新增实验性 remotePatterns 和 unoptimized 配置项。移除 layout="raw" 布局模式。 |
v12.1.1 | 新增 style 属性。实验性支持 layout="raw" 布局模式。 |
v12.1.0 | 新增 dangerouslyAllowSVG 和 contentSecurityPolicy 配置项。 |
v12.0.9 | 新增 lazyRoot 属性。 |
v12.0.0 | 新增 formats 配置项。支持 AVIF 格式。 外层 <div> 改为 <span> 。 |
v11.1.0 | 新增 onLoadingComplete 和 lazyBoundary 属性。 |
v11.0.0 | src 属性支持静态导入。新增 placeholder 属性。新增 blurDataURL 属性。 |
v10.0.5 | 新增 loader 属性。 |
v10.0.1 | 新增 layout 属性。 |
v10.0.0 | 引入 next/image 组件。 |