Link Component

<Link> は、React コンポーネントであり、HTML の <a> 要素を拡張して、プリフェッチとクライアントサイドナビゲーションをルート間で提供します。これは Next.js でルート間をナビゲートする主要な方法です。

基本的な使い方

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

リファレンス

<Link> コンポーネントに渡すことができるプロパティは次のとおりです。

プロパティ	例	タイプ	必須
`href`	`href="/dashboard"`	文字列またはオブジェクト	はい
`replace`	`replace={false}`	ブーリアン	-
`scroll`	`scroll={false}`	ブーリアン	-
`prefetch`	`prefetch={false}`	ブール値または null	-
`onNavigate`	`onNavigate={(e) => {}}`	関数	-

知っておくと良いこと: className や target="_blank" のような <a> タグの属性は、<Link> にプロパティとして追加でき、内部の <a> 要素に渡されます。

`href` (必須)

移動先のパスまたはURL。

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 をブラウザの履歴スタックに追加する代わりに、現在の履歴状態を置き換えます。

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

デフォルトは true です。Next.js での <Link> のデフォルトのスクロール動作は、ブラウザが戻る・進むナビゲーションを処理する方法と同様に、スクロール位置を維持することです。新しい Page にナビゲートすると、Page がビューポート内に表示されている限り、スクロール位置は同じままです。ただし、Page がビューポート内に表示されていない場合、Next.js は最初の Page 要素の先頭にスクロールします。

scroll = {false} の場合、Next.js は最初の Page 要素へのスクロールを試みません。

知っておくと良いこと: Next.js は、スクロールの動作を管理する前に scroll: false であるかどうかを確認します。スクロールが有効な場合、ナビゲーションに関連する DOM ノードを特定し、各トップレベル要素を検査します。スクロール不可能な要素やレンダリングされた HTML がない要素はすべてスキップされます。これには、固定または固定配置の要素、および getBoundingClientRect で計算された非表示の要素などが含まれます。Next.js は、ビューポート内で表示されているスクロール可能な要素を特定するまで、兄弟要素を調べ続けます。

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: ビューポートに入るときもホバー時も、プリフェッチは行われません。

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

`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 は実行されますが、Next.js が新しいタブへのデフォルトナビゲーションを防止するため、onNavigate は実行されません。

外部 URL は onNavigate をトリガーしません。これはクライアントサイドおよび同一オリジンナビゲーションにのみ適用されるためです。

download 属性を持つリンクは onClick で機能しますが、ブラウザがリンクされた URL をダウンロードとして扱うため、onNavigate では機能しません。

例

以下の例は、さまざまなシナリオで <Link> コンポーネントを使用する方法を示しています。

動的ルートセグメントへのリンク

動的セグメントのリンクに、テンプレートリテラルと補間を使用して、リンクのリストを生成できます。たとえば、ブログ投稿のリストを生成するには

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 と一致するかどうかを確認できます。

'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 は、ナビゲーション時にビューポートに表示されていない場合、Page にスクロールします。

URL をプッシュではなく置き換える

Link コンポーネントのデフォルトの動作は、URL を history スタックに push することです。次の例のように、新しいエントリを追加しないように replace プロパティを使用できます。

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 要素の先頭にスクロールします。この動作を無効にしたい場合は、<Link> コンポーネントに scroll={false} を渡すか、router.push() または router.replace() に scroll: false を渡すことができます。

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

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 Page() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      Dashboard
    </Link>
  )
}

onNavigate プロパティを使用して、フォームに未保存の変更がある場合など、特定の条件が満たされたときにナビゲーションをブロックできます。アプリ内の複数のコンポーネント（フォーム編集中にリンクからのナビゲーションを防止するなど）でナビゲーションをブロックする必要がある場合、React Context はこのブロック状態を共有するためのクリーンな方法を提供します。まず、ナビゲーションブロッキング状態を追跡するためのコンテキストを作成します。

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

コンテキストを使用するフォームコンポーネントを作成します。

'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 コンポーネントを作成します。

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

ナビゲーションコンポーネントを作成します。

'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 でラップし、ページでコンポーネントを使用します。

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 コンポーネントを使用します。

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`	デフォルトの `prefetch` 動作のエイリアスとして `auto` を追加します。
`v15.3.0`	`onNavigate` API を追加
`v13.0.0`	子 `<a>` タグは不要になりました。コードベースを自動的に更新するための codemod が提供されています。
`v10.0.0`	動的ルートを指す `href` プロパティは自動的に解決され、`as` プロパティは不要になりました。
`v8.0.0`	プリフェッチパフォーマンスが向上しました。
`v1.0.0`	`next/link` が導入されました。