opengraph-image と twitter-image

opengraph-image と twitter-image のファイル規約を使用すると、ルートセグメントの Open Graph と Twitter の画像を設定できます。

これらは、ユーザーがサイトへのリンクを共有したときに、ソーシャルネットワークやメッセージングアプリに表示される画像を設定するのに便利です。

Open Graph と Twitter の画像を設定する方法は2つあります：

画像ファイル (.jpg, .png, .gif) の使用
コードを使用した画像の生成 (.js, .ts, .tsx)

画像ファイル (.jpg, .png, .gif)

セグメント内に opengraph-image または twitter-image の画像ファイルを配置することで、ルートセグメントの共有画像を設定できます。

Next.jsはファイルを評価し、アプリの <head> 要素に適切なタグを自動的に追加します。

ファイル規約	サポートされるファイルタイプ
`opengraph-image`	`.jpg`, `.jpeg`, `.png`, `.gif`
`twitter-image`	`.jpg`, `.jpeg`, `.png`, `.gif`
`opengraph-image.alt`	`.txt`
`twitter-image.alt`	`.txt`

補足：

twitter-image のファイルサイズは5MBを、opengraph-image のファイルサイズは8MBを超えてはいけません。画像ファイルのサイズがこれらの制限を超えると、ビルドが失敗します。

`opengraph-image`

任意のルートセグメントに opengraph-image.(jpg|jpeg|png|gif) 画像ファイルを追加します。

<head>

<meta property="og:image" content="<generated>" />
<meta property="og:image:type" content="<generated>" />
<meta property="og:image:width" content="<generated>" />
<meta property="og:image:height" content="<generated>" />

`twitter-image`

任意のルートセグメントに twitter-image.(jpg|jpeg|png|gif) 画像ファイルを追加します。

<head>

<meta name="twitter:image" content="<generated>" />
<meta name="twitter:image:type" content="<generated>" />
<meta name="twitter:image:width" content="<generated>" />
<meta name="twitter:image:height" content="<generated>" />

`opengraph-image.alt.txt`

opengraph-image.(jpg|jpeg|png|gif) 画像と同じルートセグメントに、対応する opengraph-image.alt.txt ファイルを追加します。

opengraph-image.alt.txt

Acme について

<head>

<meta property="og:image:alt" content="Acme について" />

`twitter-image.alt.txt`

twitter-image.(jpg|jpeg|png|gif) 画像と同じルートセグメントに、対応する twitter-image.alt.txt ファイルを追加します。

twitter-image.alt.txt

Acme について

<head>

<meta property="twitter:image:alt" content="Acme について" />

コードを使用した画像の生成 (.js, .ts, .tsx)

画像ファイルを使用することに加えて、コードを使用して画像を生成することもできます。

デフォルトのエクスポート関数を作成することで、opengraph-image または twitter-image のルートを通じて、ルートセグメントの共有画像を生成できます。

ファイル規約	サポートされるファイルタイプ
`opengraph-image`	`.js`, `.ts`, `.tsx`
`twitter-image`	`.js`, `.ts`, `.tsx`

補足：

デフォルトでは、生成された画像は静的に最適化されます（ビルド時に生成され、キャッシュされます）。ただし、動的 API またはキャッシュされていないデータを使用する場合は除きます。

generateImageMetadata を使用して、同じファイル内で複数の画像を生成できます。

opengraph-image.js と twitter-image.js は、動的 API または動的設定オプションを使用しない限り、デフォルトでキャッシュされる特殊なルートハンドラです。

画像を生成する最も簡単な方法は、next/og から ImageResponse API を使用することです。

app/about/opengraph-image.tsx

TypeScript

import { ImageResponse } from 'next/og'
 
export const runtime = 'edge'
 
// 画像メタデータ
export const alt = 'Acme について'
export const size = {
  width: 1200,
  height: 630,
}
 
export const contentType = 'image/png'
 
// 画像生成
export default async function Image() {
  // フォント
  const interSemiBold = fetch(
    new URL('./Inter-SemiBold.ttf', import.meta.url)
  ).then((res) => res.arrayBuffer())
 
  return new ImageResponse(
    (
      // ImageResponse JSX 要素
      <div
        style={{
          fontSize: 128,
          background: 'white',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        Acme について
      </div>
    ),
    // ImageResponse オプション
    {
      // 便宜上、エクスポートされた opengraph-image の
      // サイズ設定を ImageResponse の幅と高さの設定にも再利用できます。
      ...size,
      fonts: [
        {
          name: 'Inter',
          data: await interSemiBold,
          style: 'normal',
          weight: 400,
        },
      ],
    }
  )
}

<head>

<meta property="og:image" content="<generated>" />
<meta property="og:image:alt" content="Acme について" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

Props

デフォルトのエクスポート関数は、以下のプロップを受け取ります：

`params`（オプション）

opengraph-image または twitter-image が配置されているセグメントから、ルートセグメントまでの動的ルートパラメータオブジェクト。

app/shop/[slug]/opengraph-image.tsx

TypeScript

export default function Image({ params }: { params: { slug: string } }) {
  // ...
}

ルート	URL	`params`
`app/shop/opengraph-image.js`	`/shop`	`undefined`
`app/shop/[slug]/opengraph-image.js`	`/shop/1`	`{ slug: '1' }`
`app/shop/[tag]/[item]/opengraph-image.js`	`/shop/1/2`	`{ tag: '1', item: '2' }`
`app/shop/[...slug]/opengraph-image.js`	`/shop/1/2`	`{ slug: ['1', '2'] }`

Returns

デフォルトのエクスポート関数は、Blob、ArrayBuffer、TypedArray、DataView、ReadableStream、Response のいずれかを返す必要があります。

補足: ImageResponse はこの戻り値の型を満たします。

設定のエクスポート

opengraph-image または twitter-image ルートから alt、size、contentType 変数をエクスポートすることで、画像のメタデータをオプションで設定できます。

オプション	型
`alt`	`string`
`size`	`{ width: number; height: number }`
`contentType`	`string` - 画像のMIMEタイプ

`alt`

opengraph-image.tsx

TypeScript

export const alt = 'My images alt text'
 
export default function Image() {}

<head>

<meta property="og:image:alt" content="My images alt text" />

`size`

opengraph-image.tsx

TypeScript

export const size = { width: 1200, height: 630 }
 
export default function Image() {}

<head>

<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

`contentType`

opengraph-image.tsx

TypeScript

export const contentType = 'image/png'
 
export default function Image() {}

<head>

<meta property="og:image:type" content="image/png" />

ルートセグメント設定

opengraph-image と twitter-image は、ページとレイアウトと同じルートセグメント設定オプションを使用できる特殊なルートハンドラーです。

例

外部データの使用

この例では、params オブジェクトと外部データを使用して画像を生成します。

補足: デフォルトでは、この生成された画像は静的に最適化されます。個々の fetch オプションまたはルートセグメントオプションを変更することで、この動作を変更できます。

app/posts/[slug]/opengraph-image.tsx

TypeScript

import { ImageResponse } from 'next/og'
 
export const alt = 'About Acme'
export const size = {
  width: 1200,
  height: 630,
}
export const contentType = 'image/png'
 
export default async function Image({ params }: { params: { slug: string } }) {
  const post = await fetch(`https://.../posts/${params.slug}`).then((res) =>
    res.json()
  )
 
  return new ImageResponse(
    (
      <div
        style={{
          fontSize: 48,
          background: 'white',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        {post.title}
      </div>
    ),
    {
      ...size,
    }
  )
}

Edgeランタイムとローカルアセットの使用

この例では、Edgeランタイムを使用してファイルシステム上のローカル画像をフェッチし、<img> 要素の src 属性に ArrayBuffer として渡します。ローカルアセットは、サンプルソースファイルの場所を基準に配置する必要があります。

app/opengraph-image.tsx

TypeScript

import { ImageResponse } from 'next/og'
 
export const runtime = 'edge'
 
export default async function Image() {
  const logoSrc = await fetch(new URL('./logo.png', import.meta.url)).then(
    (res) => res.arrayBuffer()
  )
 
  return new ImageResponse(
    (
      <div
        style={{
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        <img src={logoSrc} height="100" />
      </div>
    )
  )
}

Node.jsランタイムとローカルアセットの使用

この例では、Node.jsランタイムを使用してファイルシステム上のローカル画像をフェッチし、<img> 要素の src 属性に ArrayBuffer として渡します。ローカルアセットは、サンプルソースファイルの場所ではなく、プロジェクトのルートを基準に配置する必要があります。

app/opengraph-image.tsx

TypeScript

import { ImageResponse } from 'next/og'
import { join } from 'node:path'
import { readFile } from 'node:fs/promises'
 
export default async function Image() {
  const logoData = await readFile(join(process.cwd(), 'logo.png'))
  const logoSrc = Uint8Array.from(logoData).buffer
 
  return new ImageResponse(
    (
      <div
        style={{
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        <img src={logoSrc} height="100" />
      </div>
    )
  )
}

バージョン履歴

バージョン	変更点
`v13.3.0`	`opengraph-image` と `twitter-image` が導入。