Link 组件

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

基本用法：

app/page.tsx

TypeScript

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

参考

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

属性	示例	类型	必需
`href`	`href="/dashboard"`	String 或 Object	是
`replace`	`replace={false}`	Boolean	-
`scroll`	`scroll={false}`	Boolean	-
`prefetch`	`prefetch={false}`	Boolean 或 null	-
`onNavigate`	`onNavigate={(e) => {}}`	Function	-

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

`href`（必需）

要导航到的路径或 URL。

app/page.tsx

TypeScript

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

`replace`

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

app/page.tsx

TypeScript

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

`scroll`

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

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

值得注意的是：Next.js 在管理滚动行为之前会检查 scroll: false。如果启用了滚动，它会识别用于导航的相关 DOM 节点并检查每个顶层元素。所有不可滚动的元素和那些没有渲染 HTML 的元素都会被跳过，这包括粘性或固定定位的元素，以及不可见的元素，如那些用 getBoundingClientRect 计算的元素。Next.js 然后继续遍历兄弟元素，直到识别出一个在视口中可见的可滚动元素。

app/page.tsx

TypeScript

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

`prefetch`

当 <Link /> 组件进入用户的视口（最初或通过滚动）时，会发生预取。Next.js 会在后台预取并加载链接的路由（由 href 表示）及其数据，以提高客户端导航的性能。如果预取的数据在用户悬停在 <Link /> 上时已过期，Next.js 将尝试再次预取它。预取仅在生产环境中启用。

可以将以下值传递给 prefetch 属性：

"auto" 或 null（默认）：预取行为取决于路由是静态还是动态。对于静态路由，将预取完整路由（包括其所有数据）。对于动态路由，将预取到最近的具有 loading.js 边界的部分路由。
true：对于静态和动态路由，都将预取完整路由。
false：无论是进入视口还是悬停时，都不会进行预取。

app/page.tsx

TypeScript

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

`onNavigate`

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

app/page.tsx

TypeScript

import Link from 'next/link'
 
export default function Page() {
  return (
    <Link
      href="/dashboard"
      onNavigate={(e) => {
        // 仅在 SPA 导航期间执行
        console.log('正在导航...')
 
        // 可选择阻止导航
        // e.preventDefault()
      }}
    >
      Dashboard
    </Link>
  )
}

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

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

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

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

示例

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

链接到动态路由段

在链接到动态段时，你可以使用模板字面量和插值来生成链接列表。例如，生成博客文章列表：

app/blog/post-list.tsx

TypeScript

import Link from 'next/link'
 
interface Post {
  id: number
  title: string
  slug: string
}
 
export default function PostList({ posts }: { posts: Post[] }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${post.slug}`}>{post.title}</Link>
        </li>
      ))}
    </ul>
  )
}

检查活动链接

你可以使用 usePathname() 来确定链接是否处于活动状态。例如，要向活动链接添加类，你可以检查当前 pathname 是否与链接的 href 匹配：

app/ui/nav-links.tsx

TypeScript

'use client'
 
import { usePathname } from 'next/navigation'
import Link from 'next/link'
 
export function Links() {
  const pathname = usePathname()
 
  return (
    <nav>
      <Link className={`link ${pathname === '/' ? 'active' : ''}`} href="/">
        Home
      </Link>
 
      <Link
        className={`link ${pathname === '/about' ? 'active' : ''}`}
        href="/about"
      >
        About
      </Link>
    </nav>
  )
}

滚动到 `id`

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

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

值得注意的是：

如果 Page 在导航时在视口中不可见，Next.js 将滚动到该 Page。

替换 URL 而不是推送

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

app/page.js

TypeScript

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

禁用滚动到页面顶部

Next.js 中 <Link> 的默认滚动行为是保持滚动位置，类似于浏览器处理后退和前进导航的方式。当你导航到新的 Page 时，只要该 Page 在视口中可见，滚动位置就会保持不变。

但是，如果 Page 在视口中不可见，Next.js 将滚动到第一个 Page 元素的顶部。如果你想禁用此行为，可以将 scroll={false} 传递给 <Link> 组件，或将 scroll: false 传递给 router.push() 或 router.replace()。

app/page.tsx

TypeScript

import Link from 'next/link'
 
export default function Page() {
  return (
    <Link href="/#hashid" scroll={false}>
      禁用滚动到顶部
    </Link>
  )
}

使用 router.push() 或 router.replace()：

// useRouter
import { useRouter } from 'next/navigation'
 
const router = useRouter()
 
router.push('/dashboard', { scroll: false })

在 Proxy 中预取链接

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

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

proxy.ts

TypeScript

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 /> 组件中使用以下代码：

app/page.tsx

TypeScript

'use client'
 
import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed' // 你的认证钩子
 
export default function Page() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      Dashboard
    </Link>
  )
}

阻止导航

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

app/contexts/navigation-blocker.tsx

TypeScript

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

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

app/components/form.tsx

TypeScript

'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 组件：

app/components/custom-link.tsx

TypeScript

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

创建一个导航组件：

app/components/nav.tsx

TypeScript

'use client'
 
import { CustomLink as Link } from './custom-link'
 
export default function Nav() {
  return (
    <nav>
      <Link href="/">Home</Link>
      <Link href="/about">About</Link>
    </nav>
  )
}

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

app/layout.tsx

TypeScript

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 组件：

app/page.tsx

TypeScript

import Nav from './components/nav'
import Form from './components/form'
 
export default function Page() {
  return (
    <div>
      <Nav />
      <main>
        <h1>Welcome to the Dashboard</h1>
        <Form />
      </main>
    </div>
  )
}

当用户在表单有未保存的更改时尝试使用 CustomLink 导航时，他们将被提示在离开前进行确认。

版本历史

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