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は、1つ以上のビューポートフィールドを含むViewportオブジェクトを返す必要があります。

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

TypeScriptでは、params引数は、generateViewportが定義されている場所に応じて、PageProps<'/route'>またはLayoutProps<'/route'>で型付けできます。

知っておくと良いこと:

ビューポートが実行時情報に依存しない場合は、generateViewportではなく、静的なviewportオブジェクトを使用して定義する必要があります。

Viewport Fields

`themeColor`

theme-colorについてさらに詳しく学ぶtheme-color。

シンプルなテーマカラー

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

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

media属性付き

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についてさらに詳しく学ぶcolor-scheme。

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

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

Types

Viewport型を使用すると、ビューポートオブジェクトに型安全性（type safety）を追加できます。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 Projects

JavaScriptプロジェクトの場合、JSDocを使用して型安全性を追加できます。

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

バージョン履歴

バージョン	変更履歴
`v14.0.0`	`viewport`と`generateViewport`が導入されました。

次のステップ

すべてのメタデータAPIオプションを表示します。

メタデータファイル

メタデータファイル規約のAPIドキュメント。