generateViewport

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

須知:

viewport 物件和 generateViewport 函式僅支援於伺服器元件。

您無法從同一路由區段同時匯出 viewport 物件和 generateViewport 函式。

如果您來自遷移 metadata 匯出的功能，您可以使用 metadata-to-viewport-export codemod 來更新您的變更。

`viewport` 物件

若要定義 viewport 選項，請從 layout.jsx 或 page.jsx 檔案匯出 viewport 物件。

layout.tsx | page.tsx

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

`generateViewport` 函式

generateViewport 應傳回一個包含一個或多個 viewport 欄位的 Viewport 物件。

layout.tsx | page.tsx

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

須知:

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

Viewport 欄位

`themeColor`

深入了解 theme-color。

簡單的主題顏色

layout.tsx | page.tsx

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

<head> 輸出

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

使用媒體屬性

layout.tsx | page.tsx

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

<head> 輸出

<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 meta 標籤會自動設定，通常不需要手動設定，因為預設值就已足夠。不過，我們還是提供這些資訊以求完整。

layout.tsx | page.tsx

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

<head> 輸出

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

`colorScheme`

進一步了解 color-scheme。

layout.tsx | page.tsx

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

<head> 輸出

<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: { id: string }
  searchParams: { [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`。

generateViewport

`viewport` 物件

`generateViewport` 函式

Viewport 欄位

`themeColor`

`width`、`initialScale`、`maximumScale` 和 `userScalable`

`colorScheme`

類型

`viewport` 物件

`generateViewport` 函式

一般函式

使用區段屬性

JavaScript 專

版本歷程記錄

後續步驟

元資料檔案

元資料