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