Link

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

基本用法

import Link from 'next/link'
 
export default function Home() {
  return <Link href="/dashboard">Dashboard</Link>
}

参考

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

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

值得注意：<a> 标签属性，如 className 或 target="_blank"，可以作为 props 添加到 <Link> 中，并会传递给底层的 <a> 元素。

`href` (必填)

要导航到的路径或 URL。

import Link from 'next/link'
 
// Navigate to /about?name=test
export default function Home() {
  return (
    <Link
      href={{
        pathname: '/about',
        query: { name: 'test' },
      }}
    >
      About
    </Link>
  )
}

`replace`

默认为 false。 当 true 时，next/link 将替换当前的 history 状态，而不是将新的 URL 添加到浏览器的 history 堆栈中。

import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/dashboard" replace>
      Dashboard
    </Link>
  )
}

`scroll`

默认为 true。 Next.js 中 <Link> 的默认滚动行为是保持滚动位置，类似于浏览器处理前进和后退导航的方式。当您导航到新的页面时，只要页面在视口中可见，滚动位置就会保持不变。但是，如果页面在视口中不可见，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}>
      Dashboard
    </Link>
  )
}

`prefetch`

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

以下值可以传递给 prefetch prop

true (默认)：将预取完整的路由及其数据。
false：进入视口时不会发生预取，但会在悬停时发生。如果您想完全移除悬停时的预取，请考虑使用 <a> 标签或逐步采用 App Router，后者也支持禁用悬停时的预取。

import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/dashboard" prefetch={false}>
      Dashboard
    </Link>
  )
}

`shallow`

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

import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/dashboard" shallow={false}>
      Dashboard
    </Link>
  )
}

`locale`

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

import Link from 'next/link'
 
export default function Home() {
  return (
    <>
      {/* Default behavior: locale is prepended */}
      <Link href="/dashboard">Dashboard (with locale)</Link>
 
      {/* Disable locale prepending */}
      <Link href="/dashboard" locale={false}>
        Dashboard (without locale)
      </Link>
 
      {/* Specify a different locale */}
      <Link href="/dashboard" locale="fr">
        Dashboard (French)
      </Link>
    </>
  )
}

`as`

浏览器 URL 地址栏中显示的路径的可选装饰器。在 Next.js 9.5.3 之前，这用于动态路由，请查看我们的以前的文档以了解其工作原理。

当此路径与 href 中提供的路径不同时，将使用以前的 href/as 行为，如以前的文档所示。

`onNavigate`

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

import Link from 'next/link'
 
export default function Page() {
  return (
    <Link
      href="/dashboard"
      onNavigate={(e) => {
        // Only executes during SPA navigation
        console.log('Navigating...')
 
        // Optionally prevent navigation
        // e.preventDefault()
      }}
    >
      Dashboard
    </Link>
  )
}

值得注意：虽然 onClick 和 onNavigate 看起来相似，但它们服务于不同的目的。onClick 为所有点击事件执行，而 onNavigate 仅在客户端导航期间运行。一些关键区别：

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

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

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

示例

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

链接到动态路由段

对于动态路由段，使用模板字面量创建链接路径会很方便。

例如，您可以生成一个指向动态路由 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>
  )
}

滚动到 `id`

如果您希望在导航时滚动到特定的 id，您可以在 URL 后附加 # 哈希链接，或者直接将哈希链接传递给 href 属性。这是因为 <Link> 渲染为 <a> 元素。

<Link href="/dashboard#settings">Settings</Link>
 
// Output
<a href="/dashboard#settings">Settings</a>

传递 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
动态路由：/blog/my-post

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

替换 URL 而不是 push

Link 组件的默认行为是将新的 URL push 到 history 堆栈中。您可以使用 replace prop 来防止添加新条目，如下例所示：

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

禁用滚动到页面顶部

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

import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/#hashid" scroll={false}>
      Disables scrolling to the top
    </Link>
  )
}

在 Proxy 中预取链接

通常使用 Proxy 进行身份验证或其他涉及将用户重写到不同页面的目的。为了使 <Link /> 组件通过 Proxy 正确地预取带有重写功能的链接，您需要告诉 Next.js 要显示的 URL 和要预取的 URL。这是为了避免不必要地获取 Proxy 以了解正确的预取路由。

例如，如果您想提供一个具有已验证和访客视图的 /dashboard 路由，您可以在 Proxy 中添加以下内容以将用户重定向到正确的页面

import { NextResponse } from 'next/server'
 
export function proxy(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' // Your auth hook
 
export default function Home() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      Dashboard
    </Link>
  )
}

值得注意：如果您正在使用动态路由，您需要调整 as 和 href 属性。例如，如果您有一个像 /dashboard/authed/[user] 这样的动态路由，并且您希望通过代理以不同的方式呈现它，您可以这样写：<Link href={{ pathname: '/dashboard/authed/[user]', query: { user: username } }} as="/dashboard/[user]">Profile</Link>。

版本历史

版本	更改
`v15.4.0`	添加 `auto` 作为默认 `prefetch` 行为的别名。
`v15.3.0`	添加 `onNavigate` API
`v13.0.0`	不再需要子 `<a>` 标签。提供了 codemod 以自动更新您的代码库。
`v10.0.0`	指向动态路由的 `href` props 会自动解析，不再需要 `as` prop。
`v8.0.0`	改进了预取性能。
`v1.0.0`	引入 `next/link`。