favicon, icon, and apple-icon

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

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

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

使用图像文件（.ico、.jpg、.png）
使用代码生成图标（.js、.ts、.tsx）

图像文件（.ico、.jpg、.png）

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

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

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

`favicon`

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

<head>

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

`icon`

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

<head>

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

`apple-icon`

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

<head>

<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）由图标类型和评估文件的元数据决定。

例如，一个 32x32px 的 .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

TypeScript

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>

<link rel="icon" href="/icon?<generated>" type="image/png" sizes="32x32" />

值得注意的是：

默认情况下，生成的图标是静态优化的（在构建时生成并缓存），除非它们使用 Dynamic APIs 或未缓存的数据。

你可以使用 generateImageMetadata 在同一文件中生成多个图标。

你无法生成 favicon 图标。请使用 icon 或 favicon.ico 文件代替。

应用图标是特殊的 Route Handlers，默认情况下会被缓存，除非它们使用 Dynamic API 或动态配置选项。

Props

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

`params`（可选）

一个 promise，它解析为一个对象，该对象包含从根段到 icon 或 apple-icon 所在段的动态路由参数对象。

值得注意的是：如果你使用 generateImageMetadata，该函数还将接收一个 id prop，它是一个 promise，解析为 generateImageMetadata 返回的项之一的 id 值。

app/shop/[slug]/icon.tsx

TypeScript

export default async function Icon({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  // ...
}

路由	URL	`params`
`app/shop/icon.js`	`/shop`	`undefined`
`app/shop/[slug]/icon.js`	`/shop/1`	`Promise<{ slug: '1' }>`
`app/shop/[tag]/[item]/icon.js`	`/shop/1/2`	`Promise<{ tag: '1', item: '2' }>`

返回值

值得注意的是：ImageResponse 满足此返回类型。

配置导出

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

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

`size`

icon.tsx

TypeScript

export const size = { width: 32, height: 32 }
 
export default function Icon() {}

<head>

<link rel="icon" sizes="32x32" />

`contentType`

icon.tsx

TypeScript

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

<head>

<link rel="icon" type="image/png" />

Route Segment Config

icon 和 apple-icon 是专门的 Route Handlers，可以使用与 Pages 和 Layouts 相同的路由段配置选项。

版本历史

版本	变更
`v16.0.0`	`params` 现在是一个解析为对象的 promise
`v13.3.0`	引入 `favicon`、`icon` 和 `apple-icon`