Link

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

基本的な使用方法:

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	-

豆知識: className や target="_blank" などの <a> タグ属性は、<Link> にプロパティとして追加でき、基盤の <a> 要素に渡されます。

`href` (必須)

移動先のパスまたはURL。

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

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 プロパティには以下の値を渡せます:

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) => {
        // SPAナビゲーション中のみ実行
        console.log('ナビゲーション中...')

        // 必要に応じてナビゲーションをキャンセル
        // e.preventDefault()
      }}
    >
      Dashboard
    </Link>
  )
}

豆知識: onClick と onNavigate は似ているように見えますが、目的が異なります。onClick はすべてのクリックイベントで実行されますが、onNavigate はクライアントサイドナビゲーション中のみ実行されます。主な違い:

修飾キー（Ctrl/Cmd + クリック）を使用した場合、onClick は実行されますが onNavigate は実行されません（Next.jsが新しいタブのデフォルトナビゲーションを防ぐため）。

外部URLは onNavigate をトリガーしません（クライアントサイドおよび同一オリジンナビゲーション専用のため）。

download 属性を持つリンクは onClick では動作しますが onNavigate では動作しません（ブラウザがリンクURLをダウンロードとして扱うため）。

例

以下の例は、さまざまなシナリオで <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>

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

知っておくと便利:

Next.js は、ナビゲーション時にページがビューポートに表示されていない場合、自動的にスクロールします。

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

動的ルートセグメントの場合、リンクのパスを作成するためにテンプレートリテラルを使用すると便利です。

例えば、動的ルート app/blog/[slug]/page.js へのリンクリストを生成できます：

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> タグをラップするカスタムコンポーネントの場合、Link に passHref を追加する必要があります。これは styled-components のようなライブラリを使用している場合に必要です。これがないと、<a> タグに href 属性が付与されず、サイトのアクセシビリティや SEO に悪影響を与える可能性があります。ESLint を使用している場合、next/link-passhref という組み込みルールがあり、passHref の正しい使用を保証します。

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 プラグマ機能 (@jsx jsx) を使用している場合、<a> タグを直接使用しても passHref が必要です。
コンポーネントはナビゲーションを正しくトリガーするために onClick プロパティをサポートする必要があります。

関数コンポーネントのネスト

Link の子要素が関数コンポーネントの場合、passHref と legacyBehavior に加えて、コンポーネントを React.forwardRef でラップする必要があります：

import Link from 'next/link'
import React from 'react'

// MyButton の props タイプを定義
interface MyButtonProps {
  onClick?: React.MouseEventHandler<HTMLAnchorElement>
  href?: string
}

// 転送された ref を適切に型付けするために React.ForwardRefRenderFunction を使用
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>
  )
}

push ではなく URL を置換

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

import Link from 'next/link'

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

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 を指定します。

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

ミドルウェアでのリンクプリフェッチ

ミドルウェアは、認証や他の目的でユーザーを別のページにリライトする際によく使用されます。ミドルウェア経由でリライトされるリンクを<Link />コンポーネントが適切にプリフェッチするためには、Next.jsに表示するURLとプリフェッチするURLの両方を伝える必要があります。これは、プリフェッチする正しいルートを知るためにミドルウェアへの不要なフェッチを避けるために必要です。

例えば、認証済みビューと訪問者ビューを持つ/dashboardルートを提供したい場合、ミドルウェアに以下を追加してユーザーを正しいページにリダイレクトできます:

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 />コンポーネントで以下のコードを使用します:

'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コンテキストはこのブロック状態を共有するクリーンな方法を提供します。まず、ナビゲーションブロック状態を追跡するコンテキストを作成します:

'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('未保存の変更があります。このまま移動しますか？')
        ) {
          e.preventDefault()
        }
      }}
      {...props}
    >
      {children}
    </Link>
  )
}

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

'use client'

import { CustomLink as Link } from './custom-link'

export default function Nav() {
  return (
    <nav>
      <Link href="/">ホーム</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>ダッシュボードへようこそ</h1>
        <Form />
      </main>
    </div>
  )
}

ユーザーが未保存の変更がある状態でCustomLinkを使用して移動しようとすると、移動前に確認を求められます。

バージョン履歴

バージョン	変更点
`v15.3.0`	`onNavigate` APIを追加
`v13.0.0`	子要素の`<a>`タグが不要になりました。コードモッドが提供され、コードベースを自動的に更新できます。
`v10.0.0`	ダイナミックルートを指す`href`プロパティは自動的に解決され、`as`プロパティが不要になりました。
`v8.0.0`	プリフェッチのパフォーマンスが向上しました。
`v1.0.0`	`next/link`が導入されました。