跳到主要内容

favicon、icon 和 apple-icon

favicon、icon 或 apple-icon 文件约定允许你为应用程序设置图标。

它们对于添加出现在网页浏览器标签页、手机主屏幕和搜索引擎结果等位置的应用程序图标很有用。

有两种设置应用程序图标的方法：

图像文件 (.ico, .jpg, .png)​

通过在 /app 目录中放置 favicon、icon 或 apple-icon 图像文件来设置应用程序图标。 favicon 图像只能位于 app/ 的顶层。

Next.js 将评估文件并自动将适当的标签添加到应用程序的 <head> 元素中。

文件约定支持的文件类型有效位置
favicon.icoapp/
icon.ico、.jpg、.jpeg、.png、.svgapp/**/*
apple-icon.jpg、.jpeg、.pngapp/**/*

favicon​

在根 /app 路由段中添加 favicon.ico 图像文件。

<head> output
<link rel="icon" href="/favicon.ico" sizes="any" />

icon​

添加 icon.(ico|jpg|jpeg|png|svg) 图像文件。

<head> output
<link
  rel="icon"
  href="/icon?<generated>"
  type="image/<generated>"
  sizes="<generated>"
/>

apple-icon​

添加 apple-icon.(jpg|jpeg|png) 图像文件。

<head> output
<link
  rel="apple-touch-icon"
  href="/apple-icon?<generated>"
  type="image/<generated>"
  sizes="<generated>"
/>

提示：

  • 你可以通过在文件名中添加数字后缀来设置多个图标。例如，icon1.png、icon2.png 等。编号文件将按字典序排序。
  • Favicon 只能在根 /app 段中设置。如果你需要更细粒度的控制，可以使用 icon。
  • 适当的 <link> 标签和属性（如 rel、href、type 和 sizes）由图标类型和评估文件的元数据确定。
  • 例如，32 x 32px 的 .png 文件将具有 type="image/png" 和 sizes="32x32" 属性。
  • 当扩展名为 .svg 或无法确定文件的图像大小时，会向图标添加 sizes="any"。更多详细信息请参阅这个 favicon 手册。

使用代码生成图标 (.js, .ts, .tsx)​

除了使用字面图像文件外，你还可以使用代码生成图标。

通过创建默认导出函数的 icon 或 apple-icon 路由来生成应用程序图标。

文件约定支持的文件类型
icon.js、.ts、.tsx
apple-icon.js、.ts、.tsx

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

app/icon.tsx
import { ImageResponse } from 'next/og'

// 图像元数据
export const size = {
  width: 32,
  height: 32,
}
export const contentType = 'image/png'

// 图像生成
export default function Icon() {
  return new ImageResponse(
    (
      // ImageResponse JSX 元素
      <div
        style={{
          fontSize: 24,
          background: 'black',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
          color: 'white',
        }}
      >
        A
      </div>
    ),
    // ImageResponse 选项
    {
      // 为了方便，我们可以重用导出的图标大小元数据
      // 配置来设置 ImageResponse 的宽度和高度。
      ...size,
    }
  )
}
<head> output
<link rel="icon" href="/icon?<generated>" type="image/png" sizes="32x32" />

提示：

  • 默认情况下，生成的图标是静态优化的（在构建时生成并缓存），除非它们使用动态 API或未缓存的数据。
  • 你可以使用 generateImageMetadata 在同一文件中生成多个图标。
  • 你无法生成 favicon 图标。请使用 icon 或 favicon.ico 文件代替。
  • 应用程序图标是特殊的路由处理器，默认会被缓存，除非它们使用动态 API或动态配置选项。

Props​

默认导出函数接收以下 props：

params (可选)​

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

app/shop/[slug]/icon.tsx
export default function Icon({ 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' }

返回值​

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

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

配置导出​

你可以通过从 icon 或 apple-icon 路由导出 size 和 contentType 变量来可选地配置图标的元数据。

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

size​

icon.tsx | apple-icon.tsx
export const size = { width: 32, height: 32 }

export default function Icon() {}
icon.js | apple-icon.js
export const size = { width: 32, height: 32 }

export default function Icon() {}
<head> output
<link rel="icon" sizes="32x32" />

contentType​

icon.tsx | apple-icon.tsx
export const contentType = 'image/png'

export default function Icon() {}
icon.js | apple-icon.js
export const contentType = 'image/png'

export default function Icon() {}
<head> output
<link rel="icon" type="image/png" />

路由段配置​

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

版本历史​

版本变更
v13.3.0引入 favicon、icon 和 apple-icon
最后于 更新