Link

<Link> 是一个扩展了 HTML <a> 元素的 React 组件，提供预加载 (prefetching) 和客户端路由导航功能。它是 Next.js 中在路由之间导航的主要方式。

基本用法：

import Link from 'next/link'

export default function Home() {
  return <Link href="/dashboard">仪表盘</Link>
}

参考

以下是可以传递给 <Link> 组件的属性：

属性	示例	类型	必填
`href`	`href="/dashboard"`	字符串或对象	是
`replace`	`replace={false}`	布尔值	-
`scroll`	`scroll={false}`	布尔值	-
`prefetch`	`prefetch={false}`	布尔值	-
`legacyBehavior`	`legacyBehavior={true}`	布尔值	-
`passHref`	`passHref={true}`	布尔值	-
`shallow`	`shallow={false}`	布尔值	-
`locale`	`locale="fr"`	字符串或布尔值	-
`onNavigate`	`onNavigate={(e) => {}}`	函数	-

须知：<a> 标签属性如 className 或 target="_blank" 可以作为属性添加到 <Link> 中，并将传递给底层的 <a> 元素。

`href` (必填)

要导航到的路径或 URL。

import Link from 'next/link'

// 导航到 /about?name=test
export default function Home() {
  return (
    <Link
      href={{
        pathname: '/about',
        query: { name: 'test' },
      }}
    >
      关于
    </Link>
  )
}

`replace`

默认为 false。 当为 true 时，next/link 将替换当前历史状态，而不是在浏览器历史记录堆栈中添加新 URL。

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/dashboard" replace>
      仪表盘
    </Link>
  )
}

`scroll`

默认为 true。 Next.js 中 <Link> 的默认滚动行为是 保持滚动位置，类似于浏览器处理前进和后退导航的方式。当您导航到一个新的页面 (Page) 时，只要页面在视口中可见，滚动位置将保持不变。但是，如果页面在视口中不可见，Next.js 将滚动到第一个页面元素的顶部。

当 scroll = {false} 时，Next.js 不会尝试滚动到第一个页面元素。

须知：Next.js 在管理滚动行为之前检查 scroll: false。如果启用了滚动，它会识别导航的相关 DOM 节点并检查每个顶级元素。所有不可滚动的元素和那些没有渲染 HTML 的元素都会被绕过，这包括固定或绝对定位的元素，以及通过 getBoundingClientRect 计算不可见的元素。Next.js 然后继续检查同级元素，直到识别出视口中可见的可滚动元素。

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/dashboard" scroll={false}>
      仪表盘
    </Link>
  )
}

`prefetch`

当 <Link /> 组件进入用户的视口（最初或通过滚动）时，预加载会发生。Next.js 在后台预加载并加载链接的路由（由 href 表示）和数据，以提高客户端导航的性能。预加载仅在生产环境中启用。

可以传递给 prefetch 属性的值如下：

true（默认）：将预加载完整路由及其数据。
false：进入视口时不会发生预加载，但悬停时会预加载。如果您还想完全禁用悬停时的预加载，请考虑使用 <a> 标签或逐步采用应用路由器，它也允许禁用悬停时的预加载。

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/dashboard" prefetch={false}>
      仪表盘
    </Link>
  )
}

`legacyBehavior`

警告：legacyBehavior 属性将在 Next.js v16 中移除。要采用新的 <Link> 行为，请移除用作 <Link> 子元素的任何 <a> 标签。提供了一个代码修改工具 (codemod) 来帮助您自动升级代码库。

自版本 13 起，<a> 元素不再需要作为 <Link> 组件的子元素。如果出于兼容性原因仍需要旧行为，可以添加 legacyBehavior 属性。

须知：当 legacyBehavior 未设置为 true 时，所有 anchor 标签属性都可以传递给 next/link，例如 className、onClick 等。

`passHref`

强制 Link 将 href 属性传递给其子元素。默认为 false。有关更多信息，请参阅传递函数组件示例。

`shallow`

更新当前页面的路径而不重新运行 getStaticProps、getServerSideProps 或 getInitialProps。默认为 false。

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/dashboard" shallow={false}>
      仪表盘
    </Link>
  )
}

`locale`

活动语言环境会自动添加前缀。locale 允许提供不同的语言环境。当为 false 时，href 必须包含语言环境，因为默认行为被禁用。

import Link from 'next/link'

export default function Home() {
  return (
    <>
      {/* 默认行为：添加语言环境前缀 */}
      <Link href="/dashboard">仪表盘（带语言环境）</Link>

      {/* 禁用语言环境前缀 */}
      <Link href="/dashboard" locale={false}>
        仪表盘（不带语言环境）
      </Link>

      {/* 指定不同的语言环境 */}
      <Link href="/dashboard" locale="fr">
        仪表盘（法语）
      </Link>
    </>
  )
}

`onNavigate`

在客户端导航期间调用的事件处理程序。处理程序接收一个包含 preventDefault() 方法的事件对象，允许您在需要时取消导航。

import Link from 'next/link'

export default function Page() {
  return (
    <Link
      href="/dashboard"
      onNavigate={(e) => {
        // 仅在 SPA 导航期间执行
        console.log('正在导航...')

        // 可选地阻止导航
        // e.preventDefault()
      }}
    >
      仪表盘
    </Link>
  )
}

须知：虽然 onClick 和 onNavigate 看起来相似，但它们有不同的用途。onClick 对所有点击事件执行，而 onNavigate 仅在客户端导航期间运行。一些关键区别：

当使用修饰键（Ctrl/Cmd + 点击）时，onClick 会执行但 onNavigate 不会，因为 Next.js 阻止了新标签页的默认导航。

外部 URL 不会触发 onNavigate，因为它仅用于客户端和同源导航。

带有 download 属性的链接将与 onClick 一起工作，但不会与 onNavigate 一起工作，因为浏览器会将链接的 URL 视为下载。

示例

以下示例演示了如何在不同场景中使用 <Link> 组件。

链接到动态路由段

对于动态路由段 (dynamic route segments)，使用模板字面量来创建链接路径会非常方便。

例如，您可以生成一个指向动态路由 pages/blog/[slug].js 的链接列表：

import Link from 'next/link'

function Posts({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${post.slug}`}>{post.title}</Link>
        </li>
      ))}
    </ul>
  )
}

如果 Link 的子元素是一个包裹 <a> 标签的自定义组件，您必须为 Link 添加 passHref 属性。这在您使用类似 styled-components 的库时是必需的。如果不这样做，<a> 标签将不会有 href 属性，这会影响您网站的可访问性，并可能影响 SEO。如果您使用 ESLint，有一个内置规则 next/link-passhref 可以确保正确使用 passHref。

import Link from 'next/link'
import styled from 'styled-components'

// 创建一个包裹 <a> 标签的自定义组件
const RedLink = styled.a`
  color: red;
`

function NavLink({ href, name }) {
  return (
    <Link href={href} passHref legacyBehavior>
      <RedLink>{name}</RedLink>
    </Link>
  )
}

export default NavLink

如果您使用 emotion 的 JSX pragma 功能 (@jsx jsx)，即使直接使用 <a> 标签，也必须使用 passHref。
组件应支持 onClick 属性以正确触发导航。

嵌套函数式组件

如果 Link 的子元素是一个函数式组件，除了使用 passHref 和 legacyBehavior 外，还必须使用 React.forwardRef 包裹组件：

import Link from 'next/link'
import React from 'react'

// 定义 MyButton 的 props 类型
interface MyButtonProps {
  onClick?: React.MouseEventHandler<HTMLAnchorElement>
  href?: string
}

// 使用 React.ForwardRefRenderFunction 正确类型化 forwarded ref
const MyButton: React.ForwardRefRenderFunction<
  HTMLAnchorElement,
  MyButtonProps
> = ({ onClick, href }, ref) => {
  return (
    <a href={href} onClick={onClick} ref={ref}>
      Click Me
    </a>
  )
}

// 使用 React.forwardRef 包裹组件
const ForwardedMyButton = React.forwardRef(MyButton)

export default function Home() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

传递 URL 对象

Link 也可以接收一个 URL 对象，它会自动格式化生成 URL 字符串：

import Link from 'next/link'

function Home() {
  return (
    <ul>
      <li>
        <Link
          href={{
            pathname: '/about',
            query: { name: 'test' },
          }}
        >
          About us
        </Link>
      </li>
      <li>
        <Link
          href={{
            pathname: '/blog/[slug]',
            query: { slug: 'my-post' },
          }}
        >
          Blog Post
        </Link>
      </li>
    </ul>
  )
}

export default Home

上面的例子包含以下链接：

预定义路由：/about?name=test
动态路由 (dynamic route)：/blog/my-post

您可以使用 Node.js URL 模块文档中定义的任何属性。

替换 URL 而非推送

Link 组件的默认行为是将新 URL 推入 history 栈。您可以使用 replace 属性来阻止添加新条目，如下例所示：

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/about" replace>
      About us
    </Link>
  )
}

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/about" replace>
      About us
    </Link>
  )
}

禁用滚动到页面顶部

Link 的默认行为是滚动到页面顶部。当定义了哈希时，它会滚动到特定的 id，就像普通的 <a> 标签一样。要阻止滚动到顶部/哈希，可以向 Link 添加 scroll={false}：

import Link from 'next/link'

export default function Home() {
  return (
    <Link href="/#hashid" scroll={false}>
      禁用滚动到顶部
    </Link>
  )
}

在中间件 (Middleware) 中进行链接预取 (Prefetching)

通常我们会使用中间件 (Middleware) 来处理身份验证或其他需要重写用户到不同页面的场景。为了让 <Link /> 组件能正确预取通过中间件重写的链接，你需要同时告知 Next.js 要显示的 URL 和要预取的 URL。这是为了避免不必要的中间件请求来获取正确的预取路由。

例如，如果你想提供一个同时包含认证用户和访客视图的 /dashboard 路由，可以在中间件中添加以下代码来将用户重定向到正确的页面：

import { NextResponse } from 'next/server'

export function middleware(request: Request) {
  const nextUrl = request.nextUrl
  if (nextUrl.pathname === '/dashboard') {
    if (request.cookies.authToken) {
      return NextResponse.rewrite(new URL('/auth/dashboard', request.url))
    } else {
      return NextResponse.rewrite(new URL('/public/dashboard', request.url))
    }
  }
}

在这种情况下，你需要在 <Link /> 组件中使用以下代码：

'use client'

import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed' // 你的认证钩子

export default function Home() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      Dashboard
    </Link>
  )
}

须知：如果你使用动态路由 (Dynamic Routes)，你需要调整 as 和 href 属性。例如，如果你有一个动态路由 /dashboard/authed/[user] 想通过中间件以不同方式呈现，可以这样写：<Link href={{ pathname: '/dashboard/authed/[user]', query: { user: username } }} as="/dashboard/[user]">Profile</Link>。

阻止导航

你可以使用 onNavigate 属性在满足某些条件时阻止导航，例如表单有未保存的更改时。当需要在应用中跨多个组件阻止导航时（如在表单编辑期间阻止任何链接的导航），React Context 提供了一种清晰的方式来共享这个阻止状态。首先，创建一个上下文来跟踪导航阻止状态：

'use client'

import { createContext, useState, useContext } from 'react'

interface NavigationBlockerContextType {
  isBlocked: boolean
  setIsBlocked: (isBlocked: boolean) => void
}

export const NavigationBlockerContext =
  createContext<NavigationBlockerContextType>({
    isBlocked: false,
    setIsBlocked: () => {},
  })

export function NavigationBlockerProvider({
  children,
}: {
  children: React.ReactNode
}) {
  const [isBlocked, setIsBlocked] = useState(false)

  return (
    <NavigationBlockerContext.Provider value={{ isBlocked, setIsBlocked }}>
      {children}
    </NavigationBlockerContext.Provider>
  )
}

export function useNavigationBlocker() {
  return useContext(NavigationBlockerContext)
}

创建一个使用该上下文的表单组件：

'use client'

import { useNavigationBlocker } from '../contexts/navigation-blocker'

export default function Form() {
  const { setIsBlocked } = useNavigationBlocker()

  return (
    <form
      onSubmit={(e) => {
        e.preventDefault()
        setIsBlocked(false)
      }}
      onChange={() => setIsBlocked(true)}
    >
      <input type="text" name="name" />
      <button type="submit">Save</button>
    </form>
  )
}

创建一个自定义的 Link 组件来阻止导航：

'use client'

import Link from 'next/link'
import { useNavigationBlocker } from '../contexts/navigation-blocker'

interface CustomLinkProps extends React.ComponentProps<typeof Link> {
  children: React.ReactNode
}

export function CustomLink({ children, ...props }: CustomLinkProps) {
  const { isBlocked } = useNavigationBlocker()

  return (
    <Link
      onNavigate={(e) => {
        if (
          isBlocked &&
          !window.confirm('有未保存的更改，确定要离开吗？')
        ) {
          e.preventDefault()
        }
      }}
      {...props}
    >
      {children}
    </Link>
  )
}

创建一个导航组件：

'use client'

import { CustomLink as Link } from './custom-link'

export default function Nav() {
  return (
    <nav>
      <Link href="/">首页</Link>
      <Link href="/about">关于</Link>
    </nav>
  )
}

最后，在根布局中用 NavigationBlockerProvider 包裹你的应用，并在页面中使用这些组件：

import { NavigationBlockerProvider } from './contexts/navigation-blocker'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>
        <NavigationBlockerProvider>{children}</NavigationBlockerProvider>
      </body>
    </html>
  )
}

然后，在页面中使用 Nav 和 Form 组件：

import Nav from './components/nav'
import Form from './components/form'

export default function Page() {
  return (
    <div>
      <Nav />
      <main>
        <h1>欢迎来到仪表盘</h1>
        <Form />
      </main>
    </div>
  )
}

当用户尝试在表单有未保存更改时使用 CustomLink 导航离开，系统会提示确认是否离开。

版本历史

版本	变更内容
`v15.3.0`	新增 `onNavigate` API
`v13.0.0`	不再需要子 `<a>` 标签。提供了代码修改工具 (codemod) 来自动更新代码库。
`v10.0.0`	指向动态路由的 `href` 属性会自动解析，不再需要 `as` 属性。
`v8.0.0`	改进了预取性能。
`v1.0.0`	引入 `next/link`。

参考