ページとレイアウト

Pages Routerは、ページの概念に基づいたファイルシステムベースのルーターを提供します。

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

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

例: pages/about.jsを作成し、以下のようにReactコンポーネントをエクスポートすると、/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 (
    /** コンテンツ */
  )
}

Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

pages/_app.js

export default function MyApp({ Component, pageProps }) {
  // ページレベルで定義されたレイアウトを使用（利用可能な場合）
  const getLayout = Component.getLayout || ((page) => page)

  return getLayout(<Component {...pageProps} />)
}

ページ間を移動する際、シングルページアプリケーション（SPA）体験のためにページ状態（入力値、スクロール位置など）を_保持_したい場合があります。

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

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

TypeScriptを使用する場合

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

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

import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'

const Page = () => {
  return <p>hello world</p>
}

Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

export default Page

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) {
  // ページレベルで定義されたレイアウトを使用（利用可能な場合）
  const getLayout = Component.getLayout ?? ((page) => page)

  return getLayout(<Component {...pageProps} />)
}

export default function MyApp({ Component, pageProps }) {
  // ページレベルで定義されたレイアウトを使用（利用可能な場合）
  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 />
    </>
  )
}

On this page