generateImageMetadata
你可以使用 generateImageMetadata
來為一個路由區段產生不同版本的單張圖片或返回多張圖片。當你想要避免硬編碼 metadata 值時,例如用於圖示,這會很有用。
參數
generateImageMetadata
函式接受以下參數
params
(選填)
一個物件,包含從根區段到呼叫 generateImageMetadata
的區段的動態路由參數物件。
icon.tsx
export function generateImageMetadata({
params,
}: {
params: { slug: string }
}) {
// ...
}
路由 | 網址 | params |
---|---|---|
app/shop/icon.js | /shop | undefined |
app/shop/[slug]/icon.js | /shop/1 | { slug: '1' } |
app/shop/[tag]/[item]/icon.js | /shop/1/2 | { tag: '1', item: '2' } |
返回
generateImageMetadata
函式應返回包含圖片 metadata 的物件 array
,例如 alt
和 size
。此外,每個項目**必須**包含一個 id
值,該值將傳遞給圖片產生函式的 props。
圖片 Metadata 物件 | 類型 |
---|---|
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 。 |
下一步
查看所有 Metadata API 選項。
這有幫助嗎?