跳至内容
文件约定元数据文件favicon、icon 和 apple-icon

favicon、icon 和 apple-icon

faviconiconapple-icon 文件约定允许您为应用程序设置图标。

它们可用于添加出现在网页浏览器选项卡、手机主屏幕和搜索引擎结果等位置的应用图标。

有两种方法可以设置应用图标

图像文件(.ico、.jpg、.png)

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

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

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

favicon

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

<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.pngicon2.png 等。编号文件将按字典顺序排序。
  • Favicon 只能在根 /app 段中设置。如果您需要更细粒度的控制,可以使用 icon
  • 适当的 <link> 标签和属性(例如 relhreftypesizes)由评估文件的图标类型和元数据确定。
  • 例如,一个 32x32 像素的 .png 文件将具有 type="image/png"sizes="32x32" 属性。
  • 当扩展名为 .svg 或无法确定文件图像大小时,会将 sizes="any" 添加到图标中。更多详细信息请参阅此 favicon 手册

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

除了使用文字图像文件,您还可以使用代码以编程方式生成图标。

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

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

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

app/icon.tsx
import { ImageResponse } from 'next/og'
 
// Image metadata
export const size = {
  width: 32,
  height: 32,
}
export const contentType = 'image/png'
 
// Image generation
export default function Icon() {
  return new ImageResponse(
    (
      // ImageResponse JSX element
      <div
        style={{
          fontSize: 24,
          background: 'black',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
          color: 'white',
        }}
      >
        A
      </div>
    ),
    // ImageResponse options
    {
      // For convenience, we can re-use the exported icons size metadata
      // config to also set the ImageResponse's width and height.
      ...size,
    }
  )
}
<head> 输出
<link rel="icon" href="/icon?<generated>" type="image/png" sizes="32x32" />

值得注意的是:

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

属性

默认导出函数接收以下属性

params(可选)

包含从根段到与iconapple-icon共存的段的动态路由参数对象的包含对象。

app/shop/[slug]/icon.tsx
export default function Icon({ params }: { params: { slug: string } }) {
  // ...
}
路由URLparams
app/shop/icon.js/shop未定义
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满足此返回类型。

配置导出

您可以选择通过从iconapple-icon路由导出sizecontentType变量来配置图标的元数据。

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

size

icon.tsx | apple-icon.tsx
export const size = { width: 32, height: 32 }
 
export default function Icon() {}
<head> 输出
<link rel="icon" sizes="32x32" />

contentType

icon.tsx | apple-icon.tsx
export const contentType = 'image/png'
 
export default function Icon() {}
<head> 输出
<link rel="icon" type="image/png" />

路由段配置

iconapple-icon是专门的路由处理程序,它们可以使用与页面和布局相同的路由段配置选项。

版本历史

版本更改
v13.3.0引入了faviconiconapple-icon