generateImageMetadata
您可以使用generateImageMetadata
生成同一图像的不同版本,或为一个路由段返回多个图像。当您想要避免硬编码元数据值(例如图标)时,这很有用。
参数
generateImageMetadata
函数接受以下参数
params
(可选)
一个包含从根段到调用generateImageMetadata
的段的动态路由参数对象的物件。
icon.tsx
export function generateImageMetadata({
params,
}: {
params: { slug: string }
}) {
// ...
}
路由 | URL | 参数 |
---|---|---|
app/shop/icon.js | /shop | 未定义 |
app/shop/[slug]/icon.js | /shop/1 | { slug: '1' } |
app/shop/[tag]/[item]/icon.js | /shop/1/2 | { tag: '1', item: '2' } |
返回值
generateImageMetadata
函数应返回一个物件数组,其中包含图像的元数据(例如alt
和size
)。此外,每个项目**必须**包含一个id
值,该值将传递到图像生成函数的 props 中。
图像元数据对象 | 类型 |
---|---|
id | string (必需) |
alt | string |
size | { width: number; height: number } |
contentType | string |
icon.tsx
import { ImageResponse } from 'next/og'
export function generateImageMetadata() {
return [
{
contentType: 'image/png',
size: { width: 48, height: 48 },
id: 'small',
},
{
contentType: 'image/png',
size: { width: 72, height: 72 },
id: 'medium',
},
]
}
export default function Icon({ id }: { id: string }) {
return new ImageResponse(
(
<div
style={{
width: '100%',
height: '100%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
fontSize: 88,
background: '#000',
color: '#fafafa',
}}
>
Icon {id}
</div>
)
)
}
示例
使用外部数据
此示例使用params
对象和外部数据为路由段生成多个Open Graph 图像。
app/products/[id]/opengraph-image.tsx
import { ImageResponse } from 'next/og'
import { getCaptionForImage, getOGImages } from '@/app/utils/images'
export async function generateImageMetadata({
params,
}: {
params: { id: string }
}) {
const images = await getOGImages(params.id)
return images.map((image, idx) => ({
id: idx,
size: { width: 1200, height: 600 },
alt: image.text,
contentType: 'image/png',
}))
}
export default async function Image({
params,
id,
}: {
params: { id: string }
id: number
}) {
const productId = (await params).id
const imageId = id
const text = await getCaptionForImage(productId, imageId)
return new ImageResponse(
(
<div
style={
{
// ...
}
}
>
{text}
</div>
)
)
}
版本历史记录
版本 | 更改 |
---|---|
v13.3.0 | 引入generateImageMetadata 。 |
这有帮助吗?