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: '...',
  }
}

知っておくと便利:

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

ビューポートフィールド

`themeColor`

theme-color の詳細をご覧ください。

シンプルなテーマカラー

import type { Viewport } from 'next'

export const viewport: Viewport = {
  themeColor: 'black',
}

<head> output

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

<head> output

<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 タグは自動的に設定され、デフォルト値で十分なため通常は手動設定は不要です。ただし、完全性のために情報を提供しています。

import type { Viewport } from 'next'

export const viewport: Viewport = {
  width: 'device-width',
  initialScale: 1,
  maximumScale: 1,
  userScalable: false,
  // サポートされていますが、あまり使用されません
  // interactiveWidget: 'resizes-visual',
}

<head> output

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

<head> output

<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 ドキュメント。

メタデータファイル

On this page