コンテンツへスキップ
APIリファレンス関数ImageResponse

ImageResponse

ImageResponseコンストラクタを使用すると、JSXとCSSを用いて動的な画像を生成できます。これは、Open Graph画像、Twitterカードなどのソーシャルメディア画像を生成する際に便利です。

ImageResponseで利用可能なオプションは以下の通りです。

import { ImageResponse } from 'next/og'
 
new ImageResponse(
  element: ReactElement,
  options: {
    width?: number = 1200
    height?: number = 630
    emoji?: 'twemoji' | 'blobmoji' | 'noto' | 'openmoji' = 'twemoji',
    fonts?: {
      name: string,
      data: ArrayBuffer,
      weight: number,
      style: 'normal' | 'italic'
    }[]
    debug?: boolean = false
 
    // Options that will be passed to the HTTP response
    status?: number = 200
    statusText?: string
    headers?: Record<string, string>
  },
)

サポートされるCSSプロパティ

サポートされるHTMLおよびCSS機能のリストについては、Satoriのドキュメントを参照してください。

バージョン履歴

バージョン変更点
v14.0.0ImageResponseはnext/serverからnext/ogに移動しました。
v13.3.0ImageResponseはnext/serverからインポートできます。
v13.0.0ImageResponseは@vercel/ogパッケージを通じて導入されました。