generateViewport

你可以使用静态 viewport 对象或动态 generateViewport 函数自定义页面的初始视口。

须知:

viewport 对象和 generateViewport 函数导出仅在服务器组件中受支持。

你不能从同一路由段导出 viewport 对象和 generateViewport 函数。

如果你是从迁移 metadata 导出而来，你可以使用 metadata-to-viewport-export 代码模组来更新你的更改。

`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 对象，其中包含一个或多个视口字段。

layout.tsx | page.tsx

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

须知:

如果视口不依赖于运行时信息，则应使用静态 viewport 对象而不是 generateViewport 来定义它。

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 but 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',
  }
}

使用分段 props

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`。

generateViewport

`viewport` 对象

`generateViewport` 函数

Viewport 字段

`themeColor`

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

`colorScheme`

类型

`viewport` 对象

`generateViewport` 函数

常规函数

使用分段 props

JavaScript 项目

版本历史

下一步

Metadata 文件

Metadata