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

属性	示例	类型	必填
`href`	`href="/dashboard"`	字符串或对象	是
`替换`	`replace={false}`	布尔值	-
`滚动`	`scroll={false}`	布尔值	-
`预取`	`prefetch={false}`	布尔值或 null	-

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

`href`（必填）

要导航到的路径或 URL。

app/page.tsx

import Link from 'next/link'
 
// Navigate to /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 不会尝试滚动到第一个页面元素。

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 属性

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

示例

以下示例演示了如何在不同场景中使用<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属性。这是可能的，因为<Link>呈现为<a>元素。

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

需要了解:

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

链接到动态路由段

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

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

app/blog/page.tsx

import Link from 'next/link'
 
export default function Page({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${post.slug}`}>{post.title}</Link>
        </li>
      ))}
    </ul>
  )
}

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

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

components/nav-link.tsx

import Link from 'next/link'
import styled from 'styled-components'
 
// This creates a custom component that wraps an <a> tag
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'
 
// Define the props type for MyButton
interface MyButtonProps {
  onClick?: React.MouseEventHandler<HTMLAnchorElement>
  href?: string
}
 
// Use React.ForwardRefRenderFunction to properly type the forwarded ref
const MyButton: React.ForwardRefRenderFunction<
  HTMLAnchorElement,
  MyButtonProps
> = ({ onClick, href }, ref) => {
  return (
    <a href={href} onClick={onClick} ref={ref}>
      Click Me
    </a>
  )
}
 
// Use React.forwardRef to wrap the component
const ForwardedMyButton = React.forwardRef(MyButton)
 
export default function Page() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

替换 URL 而不是推送

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

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 将滚动到第一个页面元素的顶部。如果您想禁用此行为，可以将scroll={false}传递给<Link>组件，或将scroll: false传递给router.push()或router.replace()。

app/page.tsx

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

middleware.js

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

版本历史

版本	更改
`v13.0.0`	不再需要子`<a>`标签。codemod 提供用于自动更新您的代码库。
`v10.0.0`	指向动态路由的`href`属性会自动解析，不再需要`as`属性。
`v8.0.0`	改进了预取性能。
`v1.0.0`	引入了`next/link`。