favicon、icon 和 apple-icon
favicon
、icon
或 apple-icon
文件约定允许你为你的应用程序设置图标。
它们对于添加应用程序图标非常有用,这些图标会出现在诸如 Web 浏览器标签页、手机主屏幕和搜索引擎结果等位置。
有两种方法可以设置应用程序图标
图像文件 (.ico, .jpg, .png)
通过将 favicon
、icon
或 apple-icon
图像文件放置在你的 /app
目录中,使用图像文件来设置应用程序图标。favicon
图像只能位于 app/
的顶层。
Next.js 将评估该文件,并自动将适当的标签添加到你的应用程序的 <head>
元素中。
文件约定 | 支持的文件类型 | 有效位置 |
---|---|---|
favicon | .ico | app/ |
icon | .ico , .jpg , .jpeg , .png , .svg | app/**/* |
apple-icon | .jpg , .jpeg , .png | app/**/* |
favicon
将 favicon.ico
图像文件添加到根 /app
路由段。
<link rel="icon" href="/favicon.ico" sizes="any" />
icon
添加一个 icon.(ico|jpg|jpeg|png|svg)
图像文件。
<link
rel="icon"
href="/icon?<generated>"
type="image/<generated>"
sizes="<generated>"
/>
apple-icon
添加一个 apple-icon.(jpg|jpeg|png)
图像文件。
<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
)由图标类型和评估文件的元数据确定。- 例如,一个 32x32 像素的
.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。
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,
}
)
}
<link rel="icon" href="/icon?<generated>" type="image/png" sizes="32x32" />
须知:
- 默认情况下,生成的图标是静态优化的(在构建时生成并缓存),除非它们使用 动态 API 或未缓存的数据。
- 你可以在同一文件中使用
generateImageMetadata
生成多个图标。- 你无法生成
favicon
图标。请改用icon
或 favicon.ico 文件。- 应用程序图标是特殊的路由处理程序,默认情况下会被缓存,除非它使用动态 API 或 动态配置 选项。
Props
默认导出函数接收以下 props
params
(可选)
一个对象,其中包含从根段到 icon
或 apple-icon
所在段的 动态路由参数 对象,它们位于同一位置。
export default function Icon({ params }: { params: { slug: string } }) {
// ...
}
路由 | URL | params |
---|---|---|
app/shop/icon.js | /shop | undefined |
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 } |
contentType | string - 图像 MIME 类型 |
size
export const size = { width: 32, height: 32 }
export default function Icon() {}
<link rel="icon" sizes="32x32" />
contentType
export const contentType = 'image/png'
export default function Icon() {}
<link rel="icon" type="image/png" />
路由段配置
icon
和 apple-icon
是专门的 路由处理程序,它们可以使用与 Pages 和 Layouts 相同的 路由段配置 选项。
版本历史
版本 | 变更 |
---|---|
v13.3.0 | 引入了 favicon 、icon 和 apple-icon |
此页内容对您有帮助吗?