favicon、icon 與 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）由圖示類型和評估檔案的元數據決定。

例如，一個 32x32 像素的 .png 檔案將具有 type="image/png" 和 sizes="32x32" 屬性。

sizes="any" 被添加到 favicon.ico 輸出中，以避免瀏覽器錯誤，其中 .ico 圖示會優先於 .svg。

使用程式碼生成圖示 (.js, .ts, .tsx)

除了使用圖片檔案外，您還可以通過程式碼生成圖示。

通過創建一個預設導出函數的 icon 或 apple-icon 路由來生成應用程式圖示。

檔案規範	支援的檔案類型
`icon`	`.js`, `.ts`, `.tsx`
`apple-icon`	`.js`, `.ts`, `.tsx`

生成圖示最簡單的方法是使用 next/server 中的 ImageResponse API。

import { ImageResponse } from 'next/server'

// 路由區段配置
export const runtime = 'edge'

// 圖片元數據
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" />

須知事項

預設情況下，生成的圖示是靜態優化的（在構建時生成並緩存），除非它們使用動態函數或未緩存的數據。

您可以使用 generateImageMetadata 在同一個檔案中生成多個圖示。

您無法生成 favicon 圖示。請改用 icon 或 favicon.ico 檔案。

屬性

預設導出函數接收以下屬性：

`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' }`
`app/shop/[...slug]/icon.js`	`/shop/1/2`	`{ slug: ['1', '2'] }`

返回值

須知：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() {}

<head> 輸出

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

`contentType`

export const contentType = 'image/png'

export default function Icon() {}

<head> 輸出

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

路由區段配置

icon 和 apple-icon 是專門的路由處理器，可以使用與頁面和佈局相同的路由區段配置選項。

選項	類型	預設值
`dynamic`	`'auto' \| 'force-dynamic' \| 'error' \| 'force-static'`	`'auto'`
`revalidate`	`false \| 'force-cache' \| 0 \| number`	`false`
`runtime`	`'nodejs' \| 'edge'`	`'nodejs'`
`preferredRegion`	`'auto' \| 'global' \| 'home' \| string \| string[]`	`'auto'`

export const runtime = 'edge'

export default function Icon() {}

版本歷史

版本	變更
`v13.3.0`	引入 `favicon`、`icon` 和 `apple-icon`

On this page