ページとレイアウト

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 (
    /** Your content */
  )
}
 
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は状態を保持する要素を理解できます。

補足: このプロセスは調停と呼ばれ、Reactが変更された要素を理解する方法です。

TypeScriptと共に

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

pages/index.tsx

TypeScript

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

TypeScript

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} />)
}

データフェッチ

レイアウト内では、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>読み込みに失敗しました</div>
  if (!data) return <div>読み込み中...</div>
 
  return (
    <>
      <Navbar links={data.links} />
      <main>{children}</main>
      <Footer />
    </>
  )
}