跳到主要内容

opengraph-image 和 twitter-image

opengraph-image 和 twitter-image 文件约定允许你为路由段设置 Open Graph 和 Twitter 图像。

它们对于设置当用户在社交网络和消息应用程序中分享你网站的链接时出现的图像很有用。

有两种设置 Open Graph 和 Twitter 图像的方法：

图像文件 (.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> 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

提示：

  • 默认情况下，生成的图像是静态优化的（在构建时生成并缓存），除非它们使用动态 API或未缓存的数据。
  • 你可以使用 generateImageMetadata 在同一文件中生成多个图像。
  • opengraph-image.js 和 twitter-image.js 是特殊的路由处理器，默认会被缓存，除非它们使用动态 API或动态配置选项。

生成图像最简单的方法是使用来自 next/og 的 ImageResponse API。

app/about/opengraph-image.tsx
import { ImageResponse } from 'next/og'
import { readFile } from 'node:fs/promises'
import { join } from 'node:path'

// 图像元数据
export const alt = 'About Acme'
export const size = {
  width: 1200,
  height: 630,
}

export const contentType = 'image/png'

// 图像生成
export default async function Image() {
  // 字体加载，process.cwd() 是 Next.js 项目目录
  const interSemiBold = await readFile(
    join(process.cwd(), 'assets/Inter-SemiBold.ttf')
  )

  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: 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 (可选)​

一个包含从根段到 opengraph-image 或 twitter-image 所在段的动态路由参数对象的对象。

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' }

返回值​

默认导出函数应该返回 Blob | ArrayBuffer | TypedArray | DataView | ReadableStream | Response。

提示：ImageResponse 满足此返回类型。

配置导出​

你可以通过从 opengraph-image 或 twitter-image 路由导出 alt、size 和 contentType 变量来可选地配置图像的元数据。

选项类型
altstring
size{ width: number; height: number }
contentTypestring - 图像 MIME 类型

alt​

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

export default function Image() {}
opengraph-image.js | twitter-image.js
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() {}
opengraph-image.js | twitter-image.js
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() {}
opengraph-image.js | twitter-image.js
export const contentType = 'image/png'

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

路由段配置​

opengraph-image 和 twitter-image 是专门的路由处理器，可以使用与页面和布局相同的路由段配置选项。

示例​

使用外部数据​

此示例使用 params 对象和外部数据来生成图像。

提示： 默认情况下，此生成的图像将是静态优化的。你可以配置单个 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,
    }
  )
}

使用 Node.js 运行时和本地资源​

此示例使用 Node.js 运行时从文件系统获取本地图像，并将其作为 ArrayBuffer 传递给 <img> 元素的 src 属性。本地资源应该相对于项目的根目录放置，而不是示例源文件的位置。

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.0引入 opengraph-image 和 twitter-image。
最后于 更新