generateImageMetadata

您可以使用 generateImageMetadata 来生成同一图片的不同版本,或为一个路由段返回多张图片。当您希望避免硬编码元数据值(例如图标)时,这非常有用。

参数

generateImageMetadata 函数接受以下参数:

params (可选)

一个包含动态路由参数的对象,该参数从根段向下传递到调用 generateImageMetadata 的段。

export function generateImageMetadata({
  params,
}: {
  params: { slug: string }
}) {
  // ...
}
路由URLparams
app/shop/icon.js/shopundefined
app/shop/[slug]/icon.js/shop/1{ slug: '1' }
app/shop/[tag]/[item]/icon.js/shop/1/2{ tag: '1', item: '2' }
app/shop/[...slug]/icon.js/shop/1/2{ slug: ['1', '2'] }

返回值

generateImageMetadata 函数应返回一个包含图片元数据(如 altsize)的对象数组。此外,每个对象必须包含一个 id 值,该值将传递给图片生成函数的 props。

图片元数据对象类型
idstring (必填)
altstring
size{ width: number; height: number }
contentTypestring
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 图片

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 = params.id
  const imageId = id
  const text = await getCaptionForImage(productId, imageId)

  return new ImageResponse(
    (
      <div
        style={
          {
            // ...
          }
        }
      >
        {text}
      </div>
    )
  )
}

版本历史

版本变更
v13.3.0引入 generateImageMetadata

On this page