メインコンテンツまでスキップ

generateViewport

ページの初期ビューポートをカスタマイズするには、静的な viewport オブジェクトまたは動的な generateViewport 関数を使用できます。

Good to know:

  • viewport オブジェクトと generateViewport 関数のエクスポートは、Server Components のみでサポートされています。
  • 同じルートセグメントから viewport オブジェクトと generateViewport 関数の両方をエクスポートすることはできません。
  • metadata エクスポートから移行している場合、metadata-to-viewport-export codemod を使用して変更を更新できます。

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

layout.tsx | page.tsx
export function generateViewport({ params }) {
  return {
    themeColor: '...',
  }
}

Good to know:

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

ビューポートフィールド​

themeColor​

theme-color について詳しく学びましょう。

シンプルなテーマカラー

layout.tsx | page.tsx
import type { Viewport } from 'next'

export const viewport: Viewport = {
  themeColor: 'black',
}
<head> output
<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> 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​

Good to know: viewport メタタグは自動的に設定されており、手動での設定は通常不要です。デフォルトで十分ですが、完全性のために情報を提供しています。

layout.tsx | page.tsx
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 について詳しく学びましょう。

layout.tsx | page.tsx
import type { Viewport } from 'next'

export const viewport: Viewport = {
  colorScheme: 'dark',
}
<head> output
<meta name="color-scheme" content="dark" />

型​

Viewport 型を使用して、ビューポートオブジェクトに型安全性を追加できます。組み込みの TypeScript プラグインを IDE で使用している場合は、手動で型を追加する必要はありませんが、望む場合は明示的に追加できます。

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: { 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.0viewport と generateViewport を導入。