Link

<Link> 是一個 React 組件，它擴展了 HTML <a> 元素，以提供預先fetch和用戶端導航在路由之間。它是 Next.js 中路由之間導航的主要方式。

基本用法

pages/index.tsx

import Link from 'next/link'
 
export default function Home() {
  return <Link href="/dashboard">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"`	字串或布林值	-

小提示：<a> 標籤屬性，例如 className 或 target="_blank" 可以作為屬性新增到 <Link>，並將傳遞到基礎的 <a> 元素。

`href` (必填)

要導航的路徑或 URL。

pages/index.tsx

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 將替換目前的歷史狀態，而不是將新的 URL 新增到瀏覽器的歷史堆疊。

pages/index.tsx

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 的元素都會被跳過，這包括 sticky 或 fixed 定位的元素，以及不可見的元素，例如那些使用 getBoundingClientRect 計算的元素。然後 Next.js 會繼續遍歷兄弟元素，直到找到在可視範圍內可捲動的元素。

pages/index.tsx

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

`prefetch`

當 <Link /> 組件進入用戶的可視範圍時（最初或透過捲動），就會發生預先fetch。Next.js 會在背景中預先fetch並載入連結的路由（由 href 表示）和資料，以提高用戶端導航的效能。預先fetch僅在生產環境中啟用。

以下值可以傳遞給 prefetch 屬性

true (預設)：完整的路由及其資料將被預先fetch。
false：當進入可視範圍時不會發生預先fetch，但會在滑鼠懸停時發生。如果您想完全移除滑鼠懸停時的fetch，請考慮使用 <a> 標籤或逐步採用 App Router，App Router 也允許停用滑鼠懸停時的預先fetch。

pages/index.tsx

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

`legacyBehavior`

<a> 元素不再需要作為 <Link> 的子元件。新增 legacyBehavior 屬性以使用舊版行為，或移除 <a> 以升級。有一個 codemod 可用於自動升級您的程式碼。

小提示：當 legacyBehavior 未設定為 true 時，所有 anchor 標籤屬性也可以傳遞給 next/link，例如 className、onClick 等。

`passHref`

強制 Link 將 href 屬性傳遞給其子元件。預設為 false。有關更多資訊，請參閱傳遞功能元件的範例。

`shallow`

更新目前頁面的路徑，而無需重新執行 getStaticProps、getServerSideProps 或 getInitialProps。預設為 false。

pages/index.tsx

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

`locale`

活動的語系會自動前置。locale 允許提供不同的語系。當 false 時，href 必須包含語系，因為預設行為已停用。

pages/index.tsx

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

範例

以下範例示範如何在不同情境中使用 <Link> 組件。

連結到動態路由區段

對於動態路由區段，使用樣板字串來建立連結的路徑可能很方便。

例如，您可以產生連結到動態路由 pages/blog/[slug].js 的清單

pages/blog/index.tsx

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> 標籤的自訂元件，您必須將 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 語法糖功能 (@jsx jsx)，即使您直接使用 <a> 標籤，也必須使用 passHref。
該元件應支援 onClick 屬性以正確觸發導航。

巢狀功能元件

如果 Link 的子元件是一個功能元件，除了使用 passHref 和 legacyBehavior 之外，您還必須將該元件包裝在 React.forwardRef 中

pages/index.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 Home() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

傳遞 URL 物件

Link 也可以接收 URL 物件，它會自動格式化以建立 URL 字串

pages/index.ts

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 屬性來防止新增新的條目，如下例所示

pages/index.js

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

停用捲動到頁面頂端

Link 的預設行為是捲動到頁面頂端。當定義了 hash 時，它將像普通的 <a> 標籤一樣捲動到特定的 id。為了防止捲動到頂端 / hash，可以將 scroll={false} 新增到 Link

pages/index.tsx

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

在 Middleware 中預先fetch連結

常見的做法是使用 Middleware 進行身份驗證或其他涉及將用戶重寫到不同頁面的目的。為了讓 <Link /> 組件透過 Middleware 正確地預先fetch具有重寫的連結，您需要告訴 Next.js 要顯示的 URL 和要預先fetch的 URL。

這是避免不必要的 fetch 到 middleware 以了解要預先fetch的正確路由所必需的。

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 /> 組件中使用以下程式碼

pages/index.tsx

'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] 這樣的動態路由，您想透過 middleware 以不同的方式呈現，您可以這樣寫：<Link href={{ pathname: '/dashboard/authed/[user]', query: { user: username } }} as="/dashboard/[user]">Profile</Link>。

版本歷史

版本	變更
`v13.0.0`	不再需要子 <a> 標籤。提供了一個 codemod 來自動更新您的程式碼。
`v10.0.0`	指向動態路由的 href 屬性會自動解析，不再需要 `as` 屬性。
`v8.0.0`	改進了預先fetch效能。
`v1.0.0`	引入了 next/link。