Image
示例
这个 API 参考将帮助你理解如何使用图像组件可用的属性和配置选项。有关功能和用法,请参阅图像组件页面。
import Image from 'next/image'
export default function Page() {
return (
<Image
src="/profile.png"
width={500}
height={500}
alt="Picture of the author"
/>
)
}
属性
以下是图像组件可用属性的摘要:
属性 | 示例 | 类型 | 状态 |
---|---|---|---|
src | src="/profile.png" | String | 必需 |
width | width={500} | Integer (px) | 必需 |
height | height={500} | Integer (px) | 必需 |
alt | alt="Picture of the author" | String | 必需 |
loader | loader={imageLoader} | Function | - |
fill | fill={true} | Boolean | - |
sizes | sizes="(max-width: 768px) 100vw, 33vw" | String | - |
quality | quality={80} | Integer (1-100) | - |
priority | priority={true} | Boolean | - |
placeholder | placeholder="blur" | String | - |
style | style={{objectFit: "contain"}} | Object | - |
onLoadingComplete | onLoadingComplete={img => done()) | Function | 已弃用 |
onLoad | onLoad={event => done()) | Function | - |
onError | onError(event => fail() | Function | - |
loading | loading="lazy" | String | - |
blurDataURL | blurDataURL="data:image/jpeg..." | String | - |
overrideSrc | overrideSrc="/seo.png" | String | - |
必需属性
图像组件需要以下属性:src
、alt
、width
和 height
(或 fill
)。
import Image from 'next/image'
export default function Page() {
return (
<div>
<Image
src="/profile.png"
width={500}
height={500}
alt="Picture of the author"
/>
</div>
)
}
src
必须是以下之一:
当使用默认 loader 时,还要考虑源图像的以下事项:
- 当 src 是外部 URL 时,你还必须配置 remotePatterns
- 当 src 是动画或非已知格式(JPEG、PNG、WebP、AVIF、GIF、TIFF)时,图像将按原样提供
- 当 src 是 SVG 格式时,除非启用了
unoptimized
或dangerouslyAllowSVG
,否则将被阻止
width
width
属性表示图像的_固有_宽度(以像素为单位)。此属性用于推断图像的正确宽高比,并避免在加载过程中发生布局偏移。它不决定图像的渲染大小,渲染大小由 CSS 控制,类似于 HTML <img>
标签中的 width
属性。
除了静态导入的图像或具有 fill
属性 的图像外,都需要此属性。
height
height
属性表示图像的_固有_高度(以像素为单位)。此属性用于推断图像的正确宽高比,并避免在加载过程中发生布局偏移。它不决定图像的渲染大小,渲染大小由 CSS 控制,类似于 HTML <img>
标签中的 height
属性。
除了静态导入的图像或具有 fill
属性 的图像外,都需要此属性。
值得注意的是:
- 结合使用
width
和height
属性可以确定图像的宽高比,浏览器会在图像加载前为其预留空间。- 固有尺寸并不总是意味着在浏览器中的渲染尺寸,后者将由父容器决定。例如,如果父容器小于固有尺寸,图像将被缩小以适应容器。
- 当宽度和高度未知时,你可以使用
fill
属性。
alt
alt
属性用于向屏幕阅读器和搜索引擎描述图像。它也是在图像被禁用或加载图像时发生错误的情况下的后备文本。
它应包含可以替换图像的文本,而不改变页面的含义。它不是用来补充图像的,也不应重复图像上方或下方标题中已提供的信息。
如果图像是纯装饰性的或不面向用户,alt
属性应为空字符串(alt=""
)。
可选属性
<Image />
组件除了必需属性外,还接受许多其他属性。本节描述图像组件最常用的属性。在高级属性部分可以找到关于更少使用的属性的详细信息。
loader
用于解析图像 URL 的自定义函数。
loader
是一个函数,根据以下参数返回图像的 URL 字符串:
以下是使用自定义 loader 的示例:
'use client'
import Image from 'next/image'
const imageLoader = ({ src, width, quality }) => {
return `https://example.com/${src}?w=${width}&q=${quality || 75}`
}
export default function Page() {
return (
<Image
loader={imageLoader}
src="me.png"
alt="Picture of the author"
width={500}
height={500}
/>
)
}
值得注意的是:使用接受函数的属性(如
loader
)需要使用客户端组件来序列化提供的函数。
或者,你可以使用 next.config.js
中的 loaderFile 配置,为应用中的每个 next/image
实例进行配置,而无需传递属性。
fill
fill={true} // {true} | {false}
一个布尔值,使图像填充父元素,当 width
和 height
未知时很有用。
父元素_必须_分配 position: "relative"
、position: "fixed"
或 position: "absolute"
样式。
默认情况下,img 元素将自动分配 position: "absolute"
样式。
如果没有对图像应用样式,图像将拉伸以适应容器。你可能更喜欢设置 object-fit: "contain"
使图像按比例缩放以适应容器并保持宽高比。
或者,object-fit: "cover"
将使图像填充整个容器并裁剪以保持宽高比。
更多信息,另请参阅:
sizes
一个字符串,类似于媒体查询,提供有关图像在不同断点下宽度的信息。对于使用 fill
或样式设置为响应式大小的图像,sizes
的值将极大地影响性能。
sizes
属性有两个与图像性能相关的重要用途:
- 首先,
sizes
的值被浏览器用来确定从next/image
自动生成的srcset
中下载哪个尺寸的图像。当浏览器做出选择时,它还不知道页面上图像的大小,因此会选择与视口大小相同或更大的图像。sizes
属性允许你告诉浏览器,图像实际上会比全屏小。如果你没有在具有fill
属性的图像中指定sizes
值,将使用默认值100vw
(全屏宽度)。 - 其次,
sizes
属性会改变自动生成的srcset
值的行为。如果没有sizes
值,会生成适合固定大小图像(1x/2x/等)的小srcset
。如果定义了sizes
,则会生成适合响应式图像(640w/750w/等)的大srcset
。如果sizes
属性包括表示视口宽度百分比的尺寸(如50vw
),则srcset
会被裁剪,不包括任何太小而永远不需要的值。
例如,如果你知道你的样式会导致图像在移动设备上全宽显示,在平板电脑上采用 2 列布局,在桌面显示器上采用 3 列布局,那么你应该包含类似以下的 sizes 属性:
import Image from 'next/image'
export default function Page() {
return (
<div className="grid-element">
<Image
fill
src="/example.png"
sizes="(max-width: 768px) 100vw, (max-width: 1200px) 50vw, 33vw"
/>
</div>
)
}
这个示例 sizes
可能对性能指标产生巨大影响。如果没有 33vw
的 sizes,从服务器选择的图像将比所需宽度大 3 倍。由于文件大小与宽度的平方成正比,如果没有 sizes
,用户将下载一个比必要大 9 倍的图像。
了解更多关于 srcset
和 sizes
:
quality
quality={75} // {1-100 之间的数字}
优化图像的质量,介于 1
和 100
之间的整数,其中 100
是最佳质量,因此文件最大。默认为 75
。
如果在 next.config.js
中定义了 qualities
配置,则 quality
属性必须匹配配置中定义的值之一。
值得注意的是:如果原始源图像已经是低质量的,将 quality 属性设置得太高可能会导致生成的优化图像比原始源图像更大。
priority
priority={false} // {false} | {true}
当为 true 时,Next.js 将预加载图像。对于使用 priority
的图像,延迟加载会自动禁用。如果也使用了 loading
属性并设置为 lazy
,则不能使用 priority
属性。loading
属性仅用于高级用例。在需要 priority
时移除 loading
。
你应该在检测到的最大内容绘制 (LCP) 元素上使用 priority
属性。对于不同的视口大小,不同的图像可能是 LCP 元素,因此拥有多个优先级图像可能是合适的。
仅当图像在首屏可见时使用。默认为 false
。
placeholder
placeholder = 'empty' // "empty" | "blur" | "data:image/..."
图像加载时使用的占位符。可能的值是 blur
、empty
或 data:image/...
。默认为 empty
。
当为 blur
时,blurDataURL
属性将用作占位符。如果 src
是来自静态导入的对象,并且导入的图像是 .jpg
、.png
、.webp
或 .avif
,则 blurDataURL
将自动填充,除非图像被检测为动画。
对于动态图像,你必须提供 blurDataURL
属性。诸如 Plaiceholder 之类的解决方案可以帮助生成 base64
。
当为 data:image/...
时,数据 URL 将在图像加载时用作占位符。
当为 empty
时,图像加载时将没有占位符,只有空白空间。
尝试一下:
高级属性
在某些情况下,你可能需要更高级的用法。<Image />
组件可选地接受以下高级属性。
style
允许向底层图像元素传递 CSS 样式。
const imageStyle = {
borderRadius: '50%',
border: '1px solid #fff',
}
export default function ProfileImage() {
return <Image src="..." style={imageStyle} />
}
请记住,所需的 width 和 height 属性可能会与你的样式产生交互。如果你使用样式修改图像的宽度,你还应该将其高度样式设置为 auto
,以保持其固有宽高比,否则你的图像将被扭曲。
onLoadingComplete
'use client'
<Image onLoadingComplete={(img) => console.log(img.naturalWidth)} />
警告:自 Next.js 14 起已弃用,改用
onLoad
。
图像完全加载且占位符已删除后调用的回调函数。
回调函数将使用一个参数调用,该参数是对底层 <img>
元素的引用。
值得注意的是:使用接受函数的属性(如
onLoadingComplete
)需要使用客户端组件来序列化提供的函数。
onLoad
<Image onLoad={(e) => console.log(e.target.naturalWidth)} />
图像完全加载且占位符已删除后调用的回调函数。
回调函数将使用一个参数调用,即具有引用底层 <img>
元素的 target
的 Event。
值得注意的是:使用接受函数的属性(如
onLoad
)需要使用客户端组件来序列化提供的函数。
onError
<Image onError={(e) => console.error(e.target.id)} />
图像加载失败时调用的回调函数。
值得注意的是:使用接受函数的属性(如
onError
)需要使用客户端组件来序列化提供的函数。
loading
loading = 'lazy' // {lazy} | {eager}
图像的加载行为。默认为 lazy
。
当为 lazy
时,推迟加载图像,直到它达到与视口的计算距离。
当为 eager
时,立即加载图像。
了解更多关于 loading
属性。
blurDataURL
一个数据 URL,在 src
图像成功加载之前用作占位符图像。只有与 placeholder="blur"
结合使用时才生效。
必须是 base64 编码的图像。它将被放大并模糊处理,因此建议使用非常小的图像(10px 或更小)。包含较大的图像作为占位符可能会损害应用程序性能。
尝试一下:
你还可以生成纯色数据 URL 以匹配图像。
unoptimized
unoptimized = {false} // {false} | {true}
当为 true 时,源图像将按原样从 src
提供,而不改变质量、大小或格式。默认为 false
。
这对于不受优化影响的图像很有用,如小图像(小于 1KB)、矢量图像(SVG)或动画图像(GIF)。
import Image from 'next/image'
const UnoptimizedImage = (props) => {
return <Image {...props} unoptimized />
}
自 Next.js 12.3.0 起,通过在 next.config.js
中更新以下配置,可以将此属性分配给所有图像:
module.exports = {
images: {
unoptimized: true,
},
}
overrideSrc
当向 <Image>
组件提供 src
属性时,会自动为生成的 <img>
生成 srcset
和 src
属性。
<Image src="/me.jpg" />
<img
srcset="
/_next/image?url=%2Fme.jpg&w=640&q=75 1x,
/_next/image?url=%2Fme.jpg&w=828&q=75 2x
"
src="/_next/image?url=%2Fme.jpg&w=828&q=75"
/>
在某些情况下,可能不希望生成 src
属性,你可能希望使用 overrideSrc
属性覆盖它。
例如,在将现有网站从 <img>
升级到 <Image>
时,你可能希望为 SEO 目的(如图像排名或避免重新抓取)保持相同的 src
属性。
<Image src="/me.jpg" overrideSrc="/override.jpg" />
<img
srcset="
/_next/image?url=%2Fme.jpg&w=640&q=75 1x,
/_next/image?url=%2Fme.jpg&w=828&q=75 2x
"
src="/override.jpg"
/>
decoding
向浏览器提示是否应该等待图像解码完成后再呈现其他内容更新。默认为 async
。
可能的值如下:
async
- 异步解码图像,允许在其完成之前渲染其他内容。sync
- 同步解码图像,以便与其他内容一起原子呈现。auto
- 对解码模式没有偏好;浏览器决定什么最好。
了解更多关于 decoding
属性。
其他属性
<Image />
组件上的其他属性将传递给底层 img
元素,但以下属性除外:
srcSet
。请改用 Device Sizes。
配置选项
除了属性外,你还可以在 next.config.js
中配置图像组件。以下选项可用:
localPatterns
你可以选择在 next.config.js
文件中配置 localPatterns
,以允许特定路径被优化并阻止所有其他路径。
module.exports = {
images: {
localPatterns: [
{
pathname: '/assets/images/**',
search: '',
},
],
},
}
值得注意的是:上面的示例将确保
next/image
的src
属性必须以/assets/images/
开头,并且不能有查询字符串。尝试优化任何其他路径将以 400 Bad Request 响应。
remotePatterns
为了保护你的应用免受恶意用户的攻击,需要配置才能使用外部图像。这确保只有你账户中的外部图像才能从 Next.js 图像优化 API 提供服务。这些外部图像可以在 next.config.js
文件中使用 remotePatterns
属性进行配置,如下所示:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: 'example.com',
port: '',
pathname: '/account123/**',
search: '',
},
],
},
}
值得注意的是:上面的示例将确保
next/image
的src
属性必须以https://example.com/account123/
开头,并且不能有查询字符串。任何其他协议、主机名、端口或不匹配的路径将以 400 Bad Request 响应。
以下是在 next.config.js
文件中使用主机名通配符模式的 remotePatterns
属性示例:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: '**.example.com',
port: '',
search: '',
},
],
},
}
值得注意的是:上面的示例将确保
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
属性示例:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: 'assets.example.com',
search: '?v=1727111025337',
},
],
},
}
值得注意的是:上面的示例将确保
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
属性的示例:
module.exports = {
images: {
domains: ['assets.acme.com'],
},
}
loaderFile
如果你想使用云提供商来优化图像,而不是使用 Next.js 内置的图像优化 API,你可以在 next.config.js
中配置 loaderFile
,如下所示:
module.exports = {
images: {
loader: 'custom',
loaderFile: './my/image/loader.js',
},
}
这必须指向相对于 Next.js 应用程序根目录的文件。该文件必须导出一个返回字符串的默认函数,例如:
'use client'
export default function myImageLoader({ src, width, quality }) {
return `https://example.com/${src}?w=${width}&q=${quality || 75}`
}
或者,你可以使用 loader
属性 来配置 next/image
的每个实例。
示例:
值得注意的是:自定义图像加载器文件,它接受一个函数,需要使用客户端组件来序列化提供的函数。
高级
以下配置适用于高级用例,通常不是必需的。如果你选择配置以下属性,将覆盖未来更新中对 Next.js 默认值的任何更改。
deviceSizes
如果你知道用户的预期设备宽度,可以使用 next.config.js
中的 deviceSizes
属性指定设备宽度断点列表。当 next/image
组件使用 sizes
属性时,会使用这些宽度来确保为用户设备提供正确的图像。
如果未提供配置,将使用以下默认值。
module.exports = {
images: {
deviceSizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
},
}
imageSizes
你可以在 next.config.js
文件中使用 images.imageSizes
属性指定图像宽度列表。这些宽度与设备尺寸数组连接,形成用于生成图像 srcset 的完整尺寸数组。
有两个单独列表的原因是,imageSizes 仅用于提供 sizes
属性的图像,这表明图像小于屏幕的全宽。因此,imageSizes 中的尺寸应该都小于 deviceSizes 中的最小尺寸。
如果未提供配置,将使用以下默认值。
module.exports = {
images: {
imageSizes: [16, 32, 48, 64, 96, 128, 256, 384],
},
}
qualities
默认的图像优化 API 将自动允许从 1 到 100 的所有质量。如果你希望限制允许的质量,可以在 next.config.js
中添加配置。
module.exports = {
images: {
qualities: [25, 50, 75],
},
}
在上面的示例中,只允许三种质量:25、50 和 75。如果 quality
属性与此数组中的值不匹配,图像将以 400 Bad Request 失败。
formats
默认的图像优化 API 将通过请求的 Accept
标头自动检测浏览器支持的图像格式,以确定最佳输出格式。
如果 Accept
标头与配置的多个格式匹配,则使用数组中的第一个匹配项。因此,数组顺序很重要。如果没有匹配项(或源图像是动画),图像优化 API 将回退到原始图像的格式。
如果未提供配置,将使用以下默认值。
module.exports = {
images: {
formats: ['image/webp'],
},
}
你可以启用 AVIF 支持,如果浏览器不支持 AVIF,它将回退到 src 图像的原始格式:
module.exports = {
images: {
formats: ['image/avif'],
},
}
值得注意的是:
- 对于大多数用例,我们仍然建议使用 WebP。
- AVIF 通常比 WebP 编码时间长 50%,但压缩后比 WebP 小 20%。这意味着第一次请求图像时,通常会较慢,然后被缓存的后续请求会更快。
- 如果你在 Next.js 前面自托管代理/CDN,你必须配置代理转发
Accept
标头。
缓存行为
以下描述默认 loader 的缓存算法。对于所有其他加载器,请参考你的云提供商的文档。
图像会在请求时动态优化,并存储在 <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 和浏览器。
- 当上游图像不包括
Cache-Control
标头或值非常低时,你可以配置minimumCacheTTL
来增加缓存持续时间。 - 你可以配置
deviceSizes
和imageSizes
来减少可能生成的图像总数。 - 你可以配置 formats 来禁用多种格式,而支持单一图像格式。
minimumCacheTTL
你可以配置优化图像的缓存时间(TTL),单位为秒。在许多情况下,使用静态图像导入会更好,它会自动对文件内容进行哈希处理,并使用 Cache-Control
标头 immutable
永久缓存图像。
module.exports = {
images: {
minimumCacheTTL: 60,
},
}
优化图像的过期时间(或者说最大存活时间)由 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
中禁用静态图像导入:
module.exports = {
images: {
disableStaticImages: true,
},
}
dangerouslyAllowSVG
默认的 loader 不会优化 SVG 图像,原因有几个。首先,SVG 是矢量格式,意味着可以无损调整大小。其次,SVG 具有许多与 HTML/CSS 相同的功能,如果没有适当的内容安全策略 (CSP) 标头,可能会导致漏洞。
因此,当 src
属性已知为 SVG 时,我们建议使用 unoptimized
属性。当 src
以 ".svg"
结尾时,这会自动发生。
然而,如果你需要使用默认的图像优化 API 提供 SVG 图像,可以在 next.config.js
中设置 dangerouslyAllowSVG
:
module.exports = {
images: {
dangerouslyAllowSVG: true,
contentDispositionType: 'attachment',
contentSecurityPolicy: "default-src 'self'; script-src 'none'; sandbox;",
},
}
此外,强烈建议同时设置 contentDispositionType
以强制浏览器下载图像,以及 contentSecurityPolicy
以防止嵌入图像中的脚本执行。
contentDispositionType
默认 loader 设置 Content-Disposition
标头为 attachment
,以增加保护,因为 API 可以提供任意远程图像。
默认值是 attachment
,它强制浏览器在直接访问时下载图像。当 dangerouslyAllowSVG
为 true 时,这一点尤为重要。
你可以选择配置 inline
,以允许浏览器在直接访问时渲染图像,而不下载它。
module.exports = {
images: {
contentDispositionType: 'inline',
},
}
动画图像
默认 loader 将自动绕过动画图像的图像优化,按原样提供图像。
动画文件的自动检测尽力而为,支持 GIF、APNG 和 WebP。如果你想明确绕过给定动画图像的图像优化,请使用 unoptimized 属性。
响应式图像
默认生成的 srcset
包含 1x
和 2x
图像,以支持不同的设备像素比。但是,你可能希望渲染一个随视口拉伸的响应式图像。在这种情况下,你需要设置 sizes
以及 style
(或 className
)。
你可以使用以下方法之一渲染响应式图像。
使用静态导入的响应式图像
如果源图像不是动态的,你可以静态导入来创建响应式图像:
import Image from 'next/image'
import me from '../photos/me.jpg'
export default function Author() {
return (
<Image
src={me}
alt="Picture of the author"
sizes="100vw"
style={{
width: '100%',
height: 'auto',
}}
/>
)
}
尝试一下:
带有宽高比的响应式图像
如果源图像是动态的或远程 URL,你还需要提供 width
和 height
来设置响应式图像的正确宽高比:
import Image from 'next/image'
export default function Page({ photoUrl }) {
return (
<Image
src={photoUrl}
alt="Picture of the author"
sizes="100vw"
style={{
width: '100%',
height: 'auto',
}}
width={500}
height={300}
/>
)
}
尝试一下:
带有 fill
的响应式图像
如果你不知道宽高比,你需要设置 fill
属性并在父元素上设置 position: relative
。可选地,你可以根据所需的拉伸与裁剪行为设置 object-fit
样式:
import Image from 'next/image'
export default function Page({ photoUrl }) {
return (
<div style={{ position: 'relative', width: '300px', height: '500px' }}>
<Image
src={photoUrl}
alt="Picture of the author"
sizes="300px"
fill
style={{
objectFit: 'contain',
}}
/>
</div>
)
}
尝试一下:
主题检测 CSS
如果你想为浅色和深色模式显示不同的图像,你可以创建一个新组件,包装两个 <Image>
组件,并根据 CSS 媒体查询显示正确的一个。
.imgDark {
display: none;
}
@media (prefers-color-scheme: dark) {
.imgLight {
display: none;
}
.imgDark {
display: unset;
}
}
import styles from './theme-image.module.css'
import Image, { ImageProps } from 'next/image'
type Props = Omit<ImageProps, 'src' | 'priority' | 'loading'> & {
srcLight: string
srcDark: string
}
const ThemeImage = (props: Props) => {
const { srcLight, srcDark, ...rest } = props
return (
<>
<Image {...rest} src={srcLight} className={styles.imgLight} />
<Image {...rest} src={srcDark} className={styles.imgDark} />
</>
)
}
值得注意的是:
loading="lazy"
的默认行为确保只加载正确的图像。你不能使用priority
或loading="eager"
,因为这会导致两张图像都被加载。相反,你可以使用fetchPriority="high"
。
尝试一下:
getImageProps
对于更高级的用例,你可以调用 getImageProps()
获取将传递给底层 <img>
元素的属性,然后将它们传递给另一个组件、样式、画布等。
这也避免了调用 React 的 useState()
,因此可以带来更好的性能,但不能与 placeholder
属性一起使用,因为占位符永远不会被移除。
主题检测 Picture
如果你想根据用户的首选颜色方案为浅色和深色模式显示不同的图像,你可以使用 <picture>
元素。
import { getImageProps } from 'next/image'
export default function Page() {
const common = { alt: 'Theme Example', width: 800, height: 400 }
const {
props: { srcSet: dark },
} = getImageProps({ ...common, src: '/dark.png' })
const {
props: { srcSet: light, ...rest },
} = getImageProps({ ...common, src: '/light.png' })
return (
<picture>
<source media="(prefers-color-scheme: dark)" srcSet={dark} />
<source media="(prefers-color-scheme: light)" srcSet={light} />
<img {...rest} />
</picture>
)
}
艺术指导
如果你想为移动设备和桌面显示不同的图像,有时称为艺术指导,你可以为 getImageProps()
提供不同的 src
、width
、height
和 quality
属性。
import { getImageProps } from 'next/image'
export default function Home() {
const common = { alt: 'Art Direction Example', sizes: '100vw' }
const {
props: { srcSet: desktop },
} = getImageProps({
...common,
width: 1440,
height: 875,
quality: 80,
src: '/desktop.jpg',
})
const {
props: { srcSet: mobile, ...rest },
} = getImageProps({
...common,
width: 750,
height: 1334,
quality: 70,
src: '/mobile.jpg',
})
return (
<picture>
<source media="(min-width: 1000px)" srcSet={desktop} />
<source media="(min-width: 500px)" srcSet={mobile} />
<img {...rest} style={{ width: '100%', height: 'auto' }} />
</picture>
)
}
背景 CSS
你甚至可以将 srcSet
字符串转换为 image-set()
CSS 函数来优化背景图像。
import { getImageProps } from 'next/image'
function getBackgroundImage(srcSet = '') {
const imageSet = srcSet
.split(', ')
.map((str) => {
const [url, dpi] = str.split(' ')
return `url("${url}") ${dpi}`
})
.join(', ')
return `image-set(${imageSet})`
}
export default function Home() {
const {
props: { srcSet },
} = getImageProps({ alt: '', width: 128, height: 128, src: '/img.png' })
const backgroundImage = getBackgroundImage(srcSet)
const style = { height: '100vh', width: '100vw', backgroundImage }
return (
<main style={style}>
<h1>Hello World</h1>
</main>
)
}
已知的浏览器 Bug
这个 next/image
组件使用浏览器原生延迟加载,在 Safari 15.4 之前的旧浏览器上可能会回退到立即加载。当使用模糊上升占位符时,Safari 12 之前的旧浏览器将回退到空占位符。当使用带有 width
/height
为 auto
的样式时,可能会在不保留宽高比的 Safari 15 之前的旧浏览器上导致布局偏移。有关更多详细信息,请参阅这个 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
版本历史
版本 | 变更 |
---|---|
v15.0.0 | contentDispositionType 配置默认值改为 attachment 。 |
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 。提供了codemod安全自动重命名导入。移除了 <span> 包装器。移除了 layout 、objectFit 、objectPosition 、lazyBoundary 、lazyRoot 属性。alt 成为必需。onLoadingComplete 接收对 img 元素的引用。移除了内置 loader 配置。 |
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 属性。 |