Menu

カスタムApp

Next.jsはAppコンポーネントを使用してページを初期化します。これをオーバーライドすることで、ページの初期化を制御し、以下のことができます：

使用方法

デフォルトのAppをオーバーライドするには、以下に示すようにpages/_appファイルを作成します：

pages/_app.tsx
TypeScript
import type { AppProps } from 'next/app'
 
export default function MyApp({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />
}

Componentプロップは現在アクティブなpageであり、ルート間を移動するたびにComponentが新しいpageに変更されます。したがって、Componentに送信するすべてのプロップはpageによって受け取られます。

pagePropsは、Next.jsのデータフェッチ方法の1つによってページ用にプリロードされた初期プロップを持つオブジェクトです。それ以外の場合は空のオブジェクトになります。

補足：

  • アプリ実行中にカスタムAppを追加した場合、開発サーバーを再起動する必要があります。これはpages/_app.jsが以前に存在しなかった場合にのみ必要です。
  • Appは、getStaticPropsやgetServerSidePropsなどのNext.jsのデータフェッチ方法をサポートしていません。

AppでのgetInitialProps

AppでgetInitialPropsを使用すると、getStaticPropsのないページに対して自動静的最適化が無効になります。

このパターンは推奨しません。 代わりに、Appルーターへの段階的な移行を検討してください。これにより、ページとレイアウトのデータをより簡単にフェッチできます。

pages/_app.tsx
TypeScript
import App, { AppContext, AppInitialProps, AppProps } from 'next/app'
 
type AppOwnProps = { example: string }
 
export default function MyApp({
  Component,
  pageProps,
  example,
}: AppProps & AppOwnProps) {
  return (
    <>
      <p>データ: {example}</p>
      <Component {...pageProps} />
    </>
  )
}
 
MyApp.getInitialProps = async (
  context: AppContext
): Promise<AppOwnProps & AppInitialProps> => {
  const ctx = await App.getInitialProps(context)
 
  return { ...ctx, example: 'データ' }
}