ページとレイアウト

Pages Routerは、ページの概念に基づいて構築されたファイルシステムベースのルーターを備えています。

ファイルがpagesディレクトリに追加されると、自動的にルートとして利用可能になります。

Next.jsでは、ページはpagesディレクトリ内の.js、.jsx、.ts、または.tsxファイルからエクスポートされたReactコンポーネントです。各ページは、そのファイル名に基づいてルートと関連付けられます。

例: 以下のReactコンポーネントをエクスポートするpages/about.jsを作成すると、/aboutでアクセスできるようになります。

export default function About() {
  return <div>About</div>
}

インデックスルート

ルーターは、indexという名前のファイルを自動的にディレクトリのルートにルーティングします。

pages/index.js → /
pages/blog/index.js → /blog

ネストされたルート

ルーターはネストされたファイルをサポートしています。ネストされたフォルダ構造を作成した場合でも、ファイルは自動的に同じ方法でルーティングされます。

pages/blog/first-post.js → /blog/first-post
pages/dashboard/settings/username.js → /dashboard/settings/username

動的ルーティングを含むページ

Next.jsは動的ルートを持つページをサポートしています。例えば、pages/posts/[id].jsというファイルを作成すると、posts/1、posts/2などでアクセスできるようになります。

動的ルーティングについて詳しくは、動的ルーティングのドキュメントを確認してください。

レイアウトパターン

Reactモデルでは、ページを一連のコンポーネントに分解できます。これらのコンポーネントの多くは、ページ間で頻繁に再利用されます。例えば、すべてのページで同じナビゲーションバーとフッターを使用する場合があります。

components/layout.js

import Navbar from './navbar'
import Footer from './footer'
 
export default function Layout({ children }) {
  return (
    <>
      <Navbar />
      <main>{children}</main>
      <Footer />
    </>
  )
}

例

カスタムAppを使用した単一の共有レイアウト

アプリケーション全体で1つのレイアウトしかない場合、カスタムAppを作成し、アプリケーションをそのレイアウトでラップできます。<Layout />コンポーネントはページ変更時に再利用されるため、そのコンポーネントの状態（例えば、入力値）は保持されます。

pages/_app.js

import Layout from '../components/layout'
 
export default function MyApp({ Component, pageProps }) {
  return (
    <Layout>
      <Component {...pageProps} />
    </Layout>
  )
}

ページごとのレイアウト

複数のレイアウトが必要な場合、ページにgetLayoutプロパティを追加して、レイアウト用のReactコンポーネントを返すことができます。これにより、レイアウトをページごとに定義できます。関数を返すため、必要に応じて複雑なネストされたレイアウトを持つことができます。

pages/index.js

 
import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'
 
export default function Page() {
  return (
    /** Your content */
  )
}
 
Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

pages/_app.js

export default function MyApp({ Component, pageProps }) {
  // Use the layout defined at the page level, if available
  const getLayout = Component.getLayout ?? ((page) => page)
 
  return getLayout(<Component {...pageProps} />)
}

ページ間をナビゲートする際、シングルページアプリケーション（SPA）のエクスペリエンスのために、ページのステート（入力値、スクロール位置など）を保持したいと考えます。

このレイアウトパターンは、ページ遷移間でReactコンポーネントツリーが維持されるため、ステートの永続化を可能にします。コンポーネントツリーにより、Reactはどの要素が変更されたかを理解し、ステートを保持できます。

豆知識: このプロセスはreconciliation（調整）と呼ばれ、Reactがどの要素が変更されたかを理解する方法です。

TypeScriptを使用する場合

TypeScriptを使用する場合、まずgetLayout関数を含むページの新しい型を作成する必要があります。次に、以前作成した型を使用するようにComponentプロパティをオーバーライドするAppPropsの新しい型を作成する必要があります。

pages/index.tsx

import type { ReactElement } from 'react'
import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'
import type { NextPageWithLayout } from './_app'
 
const Page: NextPageWithLayout = () => {
  return <p>hello world</p>
}
 
Page.getLayout = function getLayout(page: ReactElement) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}
 
export default Page

pages/_app.tsx

import type { ReactElement, ReactNode } from 'react'
import type { NextPage } from 'next'
import type { AppProps } from 'next/app'
 
export type NextPageWithLayout<P = {}, IP = P> = NextPage<P, IP> & {
  getLayout?: (page: ReactElement) => ReactNode
}
 
type AppPropsWithLayout = AppProps & {
  Component: NextPageWithLayout
}
 
export default function MyApp({ Component, pageProps }: AppPropsWithLayout) {
  // Use the layout defined at the page level, if available
  const getLayout = Component.getLayout ?? ((page) => page)
 
  return getLayout(<Component {...pageProps} />)
}

データ取得

レイアウト内では、useEffectやSWRのようなライブラリを使用してクライアントサイドでデータを取得できます。このファイルはページではないため、現時点ではgetStaticPropsやgetServerSidePropsを使用できません。

components/layout.js

import useSWR from 'swr'
import Navbar from './navbar'
import Footer from './footer'
 
export default function Layout({ children }) {
  const { data, error } = useSWR('/api/navigation', fetcher)
 
  if (error) return <div>Failed to load</div>
  if (!data) return <div>Loading...</div>
 
  return (
    <>
      <Navbar links={data.links} />
      <main>{children}</main>
      <Footer />
    </>
  )
}