コンテンツへスキップ

並列ルート

並列ルートを使用すると、同じレイアウト内で1つ以上のページを同時に、または条件付きでレンダリングできます。これらは、ダッシュボードやソーシャルサイトのフィードなど、アプリの非常に動的なセクションに役立ちます。

たとえば、ダッシュボードを検討すると、並列ルートを使用してteamページとanalyticsページを同時にレンダリングできます。

Parallel Routes Diagram

スロット

並列ルートは、名前付き**スロット**を使用して作成されます。スロットは@folder規則で定義されます。たとえば、次のファイル構造は、@analytics@teamの2つのスロットを定義しています。

Parallel Routes File-system Structure

スロットは、共有親レイアウトのプロップとして渡されます。上記の例では、app/layout.js内のコンポーネントは、@analytics@teamのスロットプロップを受け入れ、childrenプロップとともに並列でレンダリングできます。

app/layout.tsx
export default function Layout({
  children,
  team,
  analytics,
}: {
  children: React.ReactNode
  analytics: React.ReactNode
  team: React.ReactNode
}) {
  return (
    <>
      {children}
      {team}
      {analytics}
    </>
  )
}

ただし、スロットはルートセグメントではなく、URL構造には影響しません。たとえば、/@analytics/viewsの場合、@analyticsはスロットであるため、URLは/viewsになります。スロットは通常のページコンポーネントと組み合わされて、ルートセグメントに関連付けられた最終的なページを形成します。このため、同じルートセグメントレベルで個別の静的スロットと動的スロットを持つことはできません。1つのスロットが動的な場合、そのレベルのすべてのスロットは動的である必要があります。

知っておくと良いこと:

  • childrenプロップは、フォルダーにマップする必要のない暗黙のスロットです。つまり、app/page.jsapp/@children/page.jsと同等です。

アクティブ状態とナビゲーション

デフォルトでは、Next.jsは各スロットのアクティブな状態(またはサブページ)を追跡します。ただし、スロット内でレンダリングされるコンテンツは、ナビゲーションの種類によって異なります。

  • **ソフトナビゲーション**:クライアントサイドナビゲーション中に、Next.jsは部分レンダリングを実行し、スロット内のサブページを変更しますが、現在のURLと一致しなくても、他のスロットのアクティブなサブページは維持されます。
  • **ハードナビゲーション**:フルページロード(ブラウザのリフレッシュ)の後、Next.jsは現在のURLと一致しないスロットのアクティブな状態を判断できません。代わりに、一致しないスロットにdefault.jsファイル、またはdefault.jsが存在しない場合は404をレンダリングします。

知っておくと良いこと:

  • 一致しないルートの404は、意図していないページに並列ルートを誤ってレンダリングしないようにするのに役立ちます。

default.js

初期ロードまたはフルページリロード時にフォールバックとしてレンダリングするdefault.jsファイルを定義できます。

次のフォルダー構造を考えてみましょう。@teamスロットには/settingsページがありますが、@analyticsにはありません。

Parallel Routes unmatched routes

/settingsに移動すると、@teamスロットは/settingsページをレンダリングしますが、@analyticsスロットの現在アクティブなページは維持されます。

更新すると、Next.jsは@analyticsdefault.jsをレンダリングします。default.jsが存在しない場合は、代わりに404がレンダリングされます。

さらに、childrenは暗黙のスロットであるため、Next.jsが親ページのアクティブ状態を復元できない場合のフォールバックをレンダリングするために、default.jsファイルを作成する必要があります。

useSelectedLayoutSegment(s)

useSelectedLayoutSegmentuseSelectedLayoutSegmentsの両方で、parallelRoutesKeyパラメーターを受け入れます。これにより、スロット内にあるアクティブなルートセグメントを読み取ることができます。

app/layout.tsx
'use client'
 
import { useSelectedLayoutSegment } from 'next/navigation'
 
export default function Layout({ auth }: { auth: React.ReactNode }) {
  const loginSegment = useSelectedLayoutSegment('auth')
  // ...
}

ユーザーがapp/@auth/login(またはURLバーの/login)に移動すると、loginSegmentは文字列"login"になります。

条件付きルート

ユーザーロールなどの特定の条件に基づいてルートを条件付きでレンダリングするには、パラレルルートを使用できます。たとえば、/adminまたは/userロールに対して異なるダッシュボードページをレンダリングする場合などです。

Conditional routes diagram
app/dashboard/layout.tsx
import { checkUserRole } from '@/lib/auth'
 
export default function Layout({
  user,
  admin,
}: {
  user: React.ReactNode
  admin: React.ReactNode
}) {
  const role = checkUserRole()
  return <>{role === 'admin' ? admin : user}</>
}

タブグループ

ユーザーがスロットを個別に移動できるように、スロット内にlayoutを追加できます。これは、タブを作成する場合に役立ちます。

たとえば、@analyticsスロットには、/page-views/visitorsの2つのサブページがあります。

Analytics slot with two subpages and a layout

@analytics内で、2つのページ間でタブを共有するためのlayoutファイルを作成します。

app/@analytics/layout.tsx
import Link from 'next/link'
 
export default function Layout({ children }: { children: React.ReactNode }) {
  return (
    <>
      <nav>
        <Link href="/page-views">Page Views</Link>
        <Link href="/visitors">Visitors</Link>
      </nav>
      <div>{children}</div>
    </>
  )
}

モーダル

パラレルルートは、ルートのインターセプトと組み合わせて使用して、ディープリンクに対応したモーダルを作成できます。これにより、モーダルの構築における一般的な課題(以下のような課題)を解決できます。

  • モーダルコンテンツをURLで共有可能にする。
  • ページが更新された場合でも、モーダルを閉じずにコンテキストを保持する。
  • 前のルートに移動するのではなく、戻るナビゲーションでモーダルを閉じる
  • 進むナビゲーションでモーダルを再度開く。.

ユーザーがクライアント側のナビゲーションを使用してレイアウトからログインモーダルを開いたり、個別の/loginページにアクセスしたりできるUIパターンを考えてみましょう。

Parallel Routes Diagram

このパターンを実装するには、まず、**メイン**のログインページをレンダリングする/loginルートを作成します。

Parallel Routes Diagram
app/login/page.tsx
import { Login } from '@/app/ui/login'
 
export default function Page() {
  return <Login />
}

次に、@authスロット内に、nullを返すdefault.jsファイルを追加します。これにより、モーダルがアクティブでないときにモーダルがレンダリングされなくなります。

app/@auth/default.tsx
export default function Default() {
  return '...'
}

@authスロット内で、/(.)loginフォルダーを更新して/loginルートをインターセプトします。/(.)login/page.tsxファイルに<Modal>コンポーネントとその子コンポーネントをインポートします。

app/@auth/(.)login/page.tsx
import { Modal } from '@/app/ui/modal'
import { Login } from '@/app/ui/login'
 
export default function Page() {
  return (
    <Modal>
      <Login />
    </Modal>
  )
}

知っておくと良いこと

モーダルの開く

これで、Next.jsルーターを利用してモーダルを開閉できます。これにより、モーダルが開いている場合と、前後に移動する場合に、URLが正しく更新されます。

モーダルを開くには、@authスロットをプロップとして親レイアウトに渡し、childrenプロップと一緒にレンダリングします。

app/layout.tsx
import Link from 'next/link'
 
export default function Layout({
  auth,
  children,
}: {
  auth: React.ReactNode
  children: React.ReactNode
}) {
  return (
    <>
      <nav>
        <Link href="/login">Open modal</Link>
      </nav>
      <div>{auth}</div>
      <div>{children}</div>
    </>
  )
}

ユーザーが<Link>をクリックすると、/loginページに移動する代わりにモーダルが開きます。ただし、更新時または最初の読み込み時には、/loginに移動すると、ユーザーはメインのログインページに移動します。

モーダルの閉じる

router.back()を呼び出すか、Linkコンポーネントを使用してモーダルを閉じることができます。

app/ui/modal.tsx
'use client'
 
import { useRouter } from 'next/navigation'
 
export function Modal({ children }: { children: React.ReactNode }) {
  const router = useRouter()
 
  return (
    <>
      <button
        onClick={() => {
          router.back()
        }}
      >
        Close modal
      </button>
      <div>{children}</div>
    </>
  )
}

@authスロットをレンダリングする必要がなくなったページから離れるためにLinkコンポーネントを使用する場合、パラレルルートがnullを返すコンポーネントと一致するようにする必要があります。たとえば、ルートページに戻る場合は、@auth/page.tsxコンポーネントを作成します。

app/ui/modal.tsx
import Link from 'next/link'
 
export function Modal({ children }: { children: React.ReactNode }) {
  return (
    <>
      <Link href="/">Close modal</Link>
      <div>{children}</div>
    </>
  )
}
app/@auth/page.tsx
export default function Page() {
  return '...'
}

または、他のページ(/foo/foo/barなど)に移動する場合は、キャッチオールスロットを使用できます。

app/@auth/[...catchAll]/page.tsx
export default function CatchAll() {
  return '...'
}

知っておくと良いこと

  • アクティブ状態とナビゲーションで説明されている動作のため、@authスロットでキャッチオールルートを使用しています。スロットに一致しなくなったルートへのクライアント側のナビゲーションは表示されたままになるため、モーダルを閉じるには、スロットをnullを返すルートに一致させる必要があります。
  • ギャラリーでフォトモーダルを開き、専用の/photo/[id]ページも持つこと、またはサイドモーダルでショッピングカートを開くことなどが、他の例として挙げられます。
  • インターセプトされたルートとパラレルルートを使用したモーダルの例をご覧ください。

読み込み中UIとエラーUI

パラレルルートは個別にストリーミングできるため、各ルートに独立したエラー状態と読み込み状態を定義できます。

Parallel routes enable custom error and loading states

読み込みUIエラー処理のドキュメントで詳細を確認してください。