并行路由

并行路由允许你在同一个布局中同时或有条件地渲染一个或多个页面。它们对于应用程序中高度动态的部分非常有用，比如仪表板和社交网站上的信息流。

例如，考虑一个仪表板，你可以使用并行路由同时渲染 team 和 analytics 页面：

插槽

并行路由是通过命名插槽创建的。插槽使用 @folder 约定来定义。例如，以下文件结构定义了两个插槽：@analytics 和 @team：

插槽作为 props 传递给共享的父级布局。对于上面的示例，app/layout.js 中的组件现在接收 @analytics 和 @team 插槽 props，并可以与 children prop 一起并行渲染：

app/layout.tsx

TypeScript

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

但是，插槽不是路由段，也不会影响 URL 结构。例如，对于 /@analytics/views，URL 将是 /views，因为 @analytics 是一个插槽。插槽与常规的 Page 组件结合，形成与路由段关联的最终页面。因此，在同一路由段级别上，你不能同时拥有静态和动态插槽。如果一个插槽是动态的，那么该级别的所有插槽都必须是动态的。

值得注意的是：

children prop 是一个隐式插槽，不需要映射到文件夹。这意味着 app/page.js 等同于 app/@children/page.js。

活动状态和导航

默认情况下，Next.js 会跟踪每个插槽的活动_状态_（或子页面）。但是，插槽中渲染的内容将取决于导航类型：

软导航：在客户端导航期间，Next.js 将执行局部渲染，更改插槽内的子页面，同时保持其他插槽的活动子页面，即使它们与当前 URL 不匹配。
硬导航：在完整页面加载（浏览器刷新）后，Next.js 无法确定与当前 URL 不匹配的插槽的活动状态。相反，它将渲染不匹配插槽的 default.js 文件，如果 default.js 不存在，则渲染 404。

值得注意的是：

不匹配路由的 404 有助于确保你不会意外地在不适当的页面上渲染并行路由。

`default.js`

你可以定义一个 default.js 文件作为初始加载或完整页面重载期间未匹配插槽的回退渲染。

考虑以下文件夹结构。@team 插槽有一个 /settings 页面，但 @analytics 没有。

当导航到 /settings 时，@team 插槽将渲染 /settings 页面，同时保持 @analytics 插槽的当前活动页面。

在刷新时，Next.js 将为 @analytics 渲染一个 default.js。如果 default.js 不存在，则渲染 404。

此外，由于 children 是一个隐式插槽，当 Next.js 无法恢复父页面的活动状态时，你还需要创建一个 default.js 文件来为 children 渲染回退内容。

`useSelectedLayoutSegment(s)`

useSelectedLayoutSegment 和 useSelectedLayoutSegments 都接受一个 parallelRoutesKey 参数，允许你读取插槽内的活动路由段。

app/layout.tsx

TypeScript

'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 角色渲染不同的仪表板页面：

app/dashboard/layout.tsx

TypeScript

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。

在 @analytics 中，创建一个 layout 文件来在两个页面之间共享标签：

app/@analytics/layout.tsx

TypeScript

import Link from 'next/link'
 
export default function Layout({ children }: { children: React.ReactNode }) {
  return (
    <>
      <nav>
        <Link href="/page-views">页面浏览量</Link>
        <Link href="/visitors">访问者</Link>
      </nav>
      <div>{children}</div>
    </>
  )
}

模态框

并行路由可以与拦截路由一起使用来创建支持深层链接的模态框。这允许你解决构建模态框时常见的挑战，例如：

使模态框内容可以通过 URL 分享。
在页面刷新时保留上下文，而不是关闭模态框。
在后退导航时关闭模态框，而不是返回到上一个路由。
在前进导航时重新打开模态框。

考虑以下 UI 模式，用户可以通过客户端导航从布局中打开登录模态框，或访问单独的 /login 页面：

要实现这种模式，首先创建一个 /login 路由来渲染你的主要登录页面。

app/login/page.tsx

TypeScript

import { Login } from '@/app/ui/login'
 
export default function Page() {
  return <Login />
}

然后，在 @auth 插槽内添加一个 default.js 文件，返回 null。这确保在模态框未激活时不会被渲染。

app/@auth/default.tsx

TypeScript

export default function Default() {
  return '...'
}

在你的 @auth 插槽中，通过更新 /(.)login 文件夹来拦截 /login 路由。将 <Modal> 组件及其子组件导入到 /(.)login/page.tsx 文件中：

app/@auth/(.)login/page.tsx

TypeScript

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

值得注意的是：

用于拦截路由的约定 (例如 (.)) 取决于你的文件系统结构。参见拦截路由约定。

通过将 <Modal> 功能与模态框内容 (<Login>) 分开，你可以确保模态框内的任何内容 (例如表单) 都是服务器组件。有关更多信息，请参阅交错客户端和服务器组件。

打开模态框

现在，你可以利用 Next.js 路由器来打开和关闭模态框。这确保当模态框打开时以及在后退和前进导航时 URL 正确更新。

要打开模态框，将 @auth 插槽作为 prop 传递给父级布局，并与 children prop 一起渲染。

app/layout.tsx

TypeScript

import Link from 'next/link'
 
export default function Layout({
  auth,
  children,
}: {
  auth: React.ReactNode
  children: React.ReactNode
}) {
  return (
    <>
      <nav>
        <Link href="/login">打开模态框</Link>
      </nav>
      <div>{auth}</div>
      <div>{children}</div>
    </>
  )
}

当用户点击 <Link> 时，模态框将打开，而不是导航到 /login 页面。然而，在刷新或初始加载时，导航到 /login 会将用户带到主登录页面。

关闭模态框

你可以通过调用 router.back() 或使用 Link 组件来关闭模态框。

app/ui/modal.tsx

TypeScript

'use client'
 
import { useRouter } from 'next/navigation'
 
export function Modal({ children }: { children: React.ReactNode }) {
  const router = useRouter()
 
  return (
    <>
      <button
        onClick={() => {
          router.back()
        }}
      >
        关闭模态框
      </button>
      <div>{children}</div>
    </>
  )
}

当使用 Link 组件导航到不应该再渲染 @auth 插槽的页面时，我们需要确保并行路由匹配到一个返回 null 的组件。例如，当导航回根页面时，我们创建一个 @auth/page.tsx 组件：

app/ui/modal.tsx

TypeScript

import Link from 'next/link'
 
export function Modal({ children }: { children: React.ReactNode }) {
  return (
    <>
      <Link href="/">关闭模态框</Link>
      <div>{children}</div>
    </>
  )
}

app/@auth/page.tsx

TypeScript

export default function Page() {
  return '...'
}

或者如果导航到任何其他页面（如 /foo、/foo/bar 等），你可以使用一个全捕获插槽：

app/@auth/[...catchAll]/page.tsx

TypeScript

export default function CatchAll() {
  return '...'
}

值得注意的是：

我们在 @auth 插槽中使用捕获所有路由来关闭模态框，是因为活动状态和导航中描述的行为。由于客户端导航到不再匹配插槽的路由时会保持可见，我们需要将插槽匹配到一个返回 null 的路由来关闭模态框。

其他示例可能包括在图库中打开照片模态框，同时也有一个专门的 /photo/[id] 页面，或者在侧边模态框中打开购物车。

查看一个示例，了解使用拦截和并行路由的模态框。

加载和错误 UI

并行路由可以独立流式传输，允许你为每个路由定义独立的错误和加载状态：

查看加载 UI和错误处理文档了解更多信息。

并行路由

下一步

default.js