跳到内容

并行路由

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

例如,考虑到仪表板,你可以使用并行路由同时渲染 teamanalytics 页面

Parallel Routes Diagram

插槽

并行路由使用命名的 插槽 创建。插槽使用 @folder 约定定义。例如,以下文件结构定义了两个插槽:@analytics@team

Parallel Routes File-system Structure

插槽作为 props 传递给共享的父布局。对于上面的示例,app/layout.js 中的组件现在接受 @analytics@team 插槽 props,并且可以与 children prop 并行渲染它们

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,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 没有。

Parallel Routes unmatched routes

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

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

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

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

Analytics slot with two subpages and a layout

@analytics 中,创建一个 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 共享
  • 在页面刷新时保留上下文,而不是关闭模态框。
  • 在后退导航时关闭模态框,而不是转到上一个路由。
  • 在前进导航时重新打开模态框.

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

Parallel Routes Diagram

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

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

然后,在 @auth 插槽内,添加一个返回 nulldefault.js 文件。这确保了模态框在不活动时不会被渲染。

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

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

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

须知

  • 用于拦截路由的约定,例如 (.),取决于你的文件系统结构。请参阅 拦截路由约定
  • 通过将 <Modal> 功能与模态框内容 (<Login>) 分离,你可以确保模态框内的任何内容(例如 表单)都是服务器组件。有关更多信息,请参阅 交错使用客户端和服务器组件

打开模态框

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

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

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

当使用 Link 组件从不应再渲染 @auth 插槽的页面导航离开时,我们需要确保并行路由匹配到一个返回 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 null
}

或者,如果导航到任何其他页面(例如 /foo/foo/bar 等),你可以使用 catch-all 插槽

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

须知

  • 我们在 @auth 插槽中使用 catch-all 路由来关闭模态框,这是因为 活动状态和导航 中描述的行为。由于客户端导航到不再匹配插槽的路由将保持可见,我们需要将插槽匹配到一个返回 null 的路由以关闭模态框。
  • 其他示例可能包括在画廊中打开照片模态框,同时拥有一个专用的 /photo/[id] 页面,或在侧边模态框中打开购物车。
  • 查看模态框示例,其中使用了拦截路由和并行路由。

加载和错误 UI

并行路由可以独立地进行流式处理,允许你为每个路由定义独立的错误和加载状态

Parallel routes enable custom error and loading states

请参阅 加载 UI错误处理 文档以获取更多信息。