generateViewport

您可以使用靜態的 viewport 物件或動態的 generateViewport 函式自定義頁面的初始視口。

須知:

viewport 物件和 generateViewport 函式匯出僅在伺服器元件中受支援。

您不能從同一個路由段同時匯出 viewport 物件和 generateViewport 函式。

如果您是從遷移 metadata 匯出過來的，可以使用 metadata-to-viewport-export codemod 來更新您的更改。

`viewport` 物件

要定義視口選項，從 layout.jsx 或 page.jsx 檔案匯出一個 viewport 物件。

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  themeColor: 'black',
}
 
export default function Page() {}

`generateViewport` 函式

generateViewport 應該返回一個包含一個或多個視口欄位的 Viewport 物件。

export function generateViewport({ params }) {
  return {
    themeColor: '...',
  }
}

在 TypeScript 中，params 引數可以透過 PageProps<'/route'> 或 LayoutProps<'/route'> 進行型別定義，具體取決於 generateViewport 的定義位置。

須知:

如果視口不依賴於執行時資訊，則應使用靜態 viewport 物件而不是 generateViewport 來定義。

視口欄位

`themeColor`

瞭解更多關於 theme-color 的資訊。

簡單主題顏色

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  themeColor: 'black',
}

<meta name="theme-color" content="black" />

帶媒體屬性

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  themeColor: [
    { media: '(prefers-color-scheme: light)', color: 'cyan' },
    { media: '(prefers-color-scheme: dark)', color: 'black' },
  ],
}

<meta name="theme-color" media="(prefers-color-scheme: light)" content="cyan" />
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />

`width`, `initialScale`, `maximumScale` 和 `userScalable`

須知：viewport 元標籤是自動設定的，通常不需要手動配置，因為預設值已足夠。但是，為了完整性，這裡提供了相關資訊。

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  width: 'device-width',
  initialScale: 1,
  maximumScale: 1,
  userScalable: false,
  // Also supported but less commonly used
  // interactiveWidget: 'resizes-visual',
}

<meta
  name="viewport"
  content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"
/>

`colorScheme`

瞭解更多關於 color-scheme 的資訊。

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  colorScheme: 'dark',
}

<meta name="color-scheme" content="dark" />

型別

您可以使用 Viewport 型別為您的視口物件新增型別安全。如果您在 IDE 中使用內建的 TypeScript 外掛，則無需手動新增型別，但如果您願意，仍然可以顯式新增。

`viewport` 物件

import type { Viewport } from 'next'
 
export const viewport: Viewport = {
  themeColor: 'black',
}

`generateViewport` 函式

常規函式

import type { Viewport } from 'next'
 
export function generateViewport(): Viewport {
  return {
    themeColor: 'black',
  }
}

帶分段屬性

import type { Viewport } from 'next'
 
type Props = {
  params: Promise<{ id: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}
 
export function generateViewport({ params, searchParams }: Props): Viewport {
  return {
    themeColor: 'black',
  }
}
 
export default function Page({ params, searchParams }: Props) {}

JavaScript 專案

對於 JavaScript 專案，您可以使用 JSDoc 新增型別安全。

/** @type {import("next").Viewport} */
export const viewport = {
  themeColor: 'black',
}

版本歷史

版本	更改
`v14.0.0`	`viewport` 和 `generateViewport` 已引入。

下一步

檢視所有元資料 API 選項。

元資料檔案

元資料檔案約定的 API 文件。