メインコンテンツまでスキップ

opengraph-image と twitter-image

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

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

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

画像ファイル (.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

Good to know:

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

opengraph-image​

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

<head> output
<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> output
<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
About Acme
<head> output
<meta property="og:image:alt" content="About Acme" />

twitter-image.alt.txt​

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

twitter-image.alt.txt
About Acme
<head> output
<meta property="twitter:image:alt" content="About Acme" />

コードを使用して画像を生成する (.js, .ts, .tsx)​

リテラル画像ファイルを使用することに加えて、コードを使用してプログラム的に画像を生成することができます。

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

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

Good to know:

  • デフォルトでは、生成された画像は 静的に最適化 されています（ビルド時に生成され、キャッシュされます）。ただし、Dynamic APIs またはキャッシュされていないデータを使用する場合を除きます。
  • 同じファイル内で複数の画像を生成するには、generateImageMetadata を使用できます。
  • opengraph-image.js と twitter-image.js は特別な Route Handlers であり、Dynamic API または dynamic config オプションを使用しない限り、デフォルトでキャッシュされます。

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

app/about/opengraph-image.tsx
import { ImageResponse } from 'next/og'

export const runtime = 'edge'

// 画像メタデータ
export const alt = 'About 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',
        }}
      >
        About Acme
      </div>
    ),
    // ImageResponse オプション
    {
      // 便利のため、エクスポートされた opengraph-image
      // サイズ設定を再利用して、ImageResponse の幅と高さも設定できます。
      ...size,
      fonts: [
        {
          name: 'Inter',
          data: await interSemiBold,
          style: 'normal',
          weight: 400,
        },
      ],
    }
  )
}
<head> output
<meta property="og:image" content="<generated>" />
<meta property="og:image:alt" content="About Acme" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

Props​

デフォルトのエクスポート関数は、次の props を受け取ります：

params (オプション)​

root セグメントから opengraph-image または twitter-image が配置されているセグメントまでの dynamic route parameters オブジェクトを含むオブジェクト。

app/shop/[slug]/opengraph-image.tsx
export default function Image({ params }: { params: { slug: string } }) {
  // ...
}
ルートURLparams
app/shop/opengraph-image.js/shopundefined
app/shop/[slug]/opengraph-image.js/shop/1{ slug: '1' }
app/shop/[tag]/[item]/opengraph-image.js/shop/1/2{ tag: '1', item: '2' }

Returns​

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

Good to know: ImageResponse はこの戻り値の型を満たします。

Config exports​

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

オプション型
altstring
size{ width: number; height: number }
contentTypestring - image MIME type

alt​

opengraph-image.tsx | twitter-image.tsx
export const alt = 'My images alt text'

export default function Image() {}
<head> output
<meta property="og:image:alt" content="My images alt text" />

size​

opengraph-image.tsx | twitter-image.tsx
export const size = { width: 1200, height: 630 }

export default function Image() {}
<head> output
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

contentType​

opengraph-image.tsx | twitter-image.tsx
export const contentType = 'image/png'

export default function Image() {}
<head> output
<meta property="og:image:type" content="image/png" />

Route Segment Config​

opengraph-image と twitter-image は、Pages および Layouts と同じ route segment configuration オプションを使用できる特別な Route Handlers です。

例​

外部データを使用する​

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

Good to know: デフォルトでは、この生成された画像は 静的に最適化 されます。個々の fetch options またはルートセグメントの options を設定して、この動作を変更できます。

app/posts/[slug]/opengraph-image.tsx
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 runtime​

この例では、Edge runtime を使用してファイルシステム上のローカル画像を取得し、それを <img> 要素の src 属性に ArrayBuffer として渡します。ローカルアセットは、例のソースファイルの場所に相対的に配置する必要があります。

app/opengraph-image.tsx
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 runtime​

この例では、Node.js runtime を使用してファイルシステム上のローカル画像を取得し、それを <img> 要素の src 属性に ArrayBuffer として渡します。ローカルアセットは、例のソースファイルの場所ではなく、プロジェクトの root に相対的に配置する必要があります。

app/opengraph-image.tsx
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.0opengraph-image と twitter-image が導入されました。