Skip to main content

Link 组件

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

基本用法：

app/page.tsx
import Link from 'next/link'

export default function Page() {
  return <Link href="/dashboard">Dashboard</Link>
}

参考​

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

Prop示例类型必填
hrefhref="/dashboard"String or ObjectYes
replacereplace={false}Boolean-
scrollscroll={false}Boolean-
prefetchprefetch={false}Boolean or null-
onNavigateonNavigate={(e) => {}}Function-

提示： <a> 标签的属性（如 className 或 target="_blank"）可以作为 props 添加到 <Link> 上，并会传递给底层的 <a> 元素。

href (必填)​

要导航到的路径或 URL。

app/page.tsx
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
import Link from 'next/link'

export default function Page() {
  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 然后继续检查兄弟元素，直到识别出在视口中可见的可滚动元素。

app/page.tsx
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 prop：

  • "auto" 或 null（默认）：预取行为取决于路由是静态还是动态。对于静态路由，将预取完整路由（包括所有数据）。对于动态路由，将预取到具有 loading.js 边界的最近段的部分路由。
  • true：对于静态和动态路由都将预取完整路由。
  • false：在进入视口和悬停时都不会发生预取。
app/page.tsx
import Link from 'next/link'

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

onNavigate​

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

app/page.tsx
import Link from 'next/link'

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

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

提示： 虽然 onClick 和 onNavigate 可能看起来很相似，但它们服务于不同的目的。onClick 对所有点击事件执行，而 onNavigate 仅在客户端导航期间运行。一些关键差异：

  • 当使用修饰键（Ctrl/Cmd + Click）时，onClick 执行但 onNavigate 不执行，因为 Next.js 阻止新标签页的默认导航。
  • 外部 URL 不会触发 onNavigate，因为它仅用于客户端和同源导航。
  • 带有 download 属性的链接将与 onClick 一起工作，但与 onNavigate 不工作，因为浏览器会将链接的 URL 视为下载。

示例​

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

链接到动态路由段​

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

app/blog/post-list.tsx
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
'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 prop。这是可能的，因为 <Link> 渲染为 <a> 元素。

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

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

提示：

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

如果子元素是包装 <a> 标签的自定义组件​

如果 Link 的子元素是包装 <a> 标签的自定义组件，你必须向 Link 添加 passHref。如果你使用像 styled-components 这样的库，这是必要的。没有这个，<a> 标签将没有 href 属性，这会损害你网站的可访问性，并可能影响 SEO。如果你使用 ESLint，有一个内置规则 next/link-passhref 来确保正确使用 passHref。

components/nav-link.tsx
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 包装组件：

app/page.tsx
import Link from 'next/link'
import React from 'react'

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

// 使用 React.ForwardRefRenderFunction 来正确类型化转发的 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 Page() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

替换 URL 而不是推送​

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

app/page.js
import Link from 'next/link'

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

禁用滚动到页面顶部​

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

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

app/page.js
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/#hashid" scroll={false}>
      Disables scrolling to the top
    </Link>
  )
}

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

// useRouter
import { useRouter } from 'next/navigation'

const router = useRouter()

router.push('/dashboard', { scroll: false })

在中间件中预取链接​

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

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

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

app/page.tsx
'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 prop 在满足某些条件时阻止导航，例如当表单有未保存的更改时。当你需要在应用中的多个组件之间阻止导航时（比如在编辑表单时阻止从任何链接导航），React Context 提供了一种干净的方式来共享这种阻止状态。首先，创建一个上下文来跟踪导航阻止状态：

app/contexts/navigation-blocker.tsx
'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
'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
'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('You have unsaved changes. Leave anyway?')
        ) {
          e.preventDefault()
        }
      }}
      {...props}
    >
      {children}
    </Link>
  )
}

创建一个导航组件：

app/components/nav.tsx
'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
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
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 props 会自动解析，不再需要 as prop。
v8.0.0改进了预取性能。
v1.0.0引入 next/link。
Last updated on