コンテンツにスキップ
APIリファレンス関数generateViewport

generateViewport

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

知っておくと良いこと:

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

知っておくと良いこと:

  • ビューポートがランタイム情報に依存しない場合、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" />

media属性付き

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

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.0viewport と generateViewport が導入されました。

次のステップ

すべてのメタデータAPIオプションを見る。

メタデータファイル

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

メタデータ

Metadata APIを使用して、任意のレイアウトまたはページでメタデータを定義します。