Menu

<Link>

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

基本的な使用方法：

pages/index.tsx
TypeScript
import Link from 'next/link'
 
export default function Home() {
  return <Link href="/dashboard">Dashboard</Link>
}

リファレンス

<Link> コンポーネントには、以下のプロパティを渡すことができます：

プロパティ例タイプ必須
hrefhref="/dashboard"文字列またはオブジェクトはい
replacereplace={false}論理値-
scrollscroll={false}論理値-
prefetchprefetch={false}論理値-
legacyBehaviorlegacyBehavior={true}論理値-
passHrefpassHref={true}論理値-
shallowshallow={false}論理値-
localelocale="fr"文字列または論理値-

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

href (必須)

移動先のパスまたはURL。

pages/index.tsx
TypeScript
import Link from 'next/link'
 
// /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
TypeScript
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は最初のページ要素へのスクロールを試みません。

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

prefetch

プリフェッチは、<Link /> コンポーネントがユーザーのビューポート内に入ったとき（最初またはスクロール中）に発生します。Next.jsは、クライアントサイドのナビゲーション性能を向上させるために、リンクされたルート（hrefで示される）とそのデータをバックグラウンドでプリフェッチおよび読み込みます。プリフェッチは本番環境でのみ有効になります。

prefetch プロップには、以下の値を渡すことができます：

  • true（デフォルト）: 完全なルートとそのデータがプリフェッチされます。
  • false: ビューポート内に入っても、プリフェッチは行われませんが、ホバー時にプリフェッチが発生します。ホバー時のフェッチを完全に無効にしたい場合は、<a> タグを使用するか、段階的に App Router を採用することを検討してください。これにより、ホバー時のプリフェッチも無効にできます。
pages/index.tsx
TypeScript
import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/dashboard" prefetch={false}>
      Dashboard
    </Link>
  )
}

legacyBehavior

<Link> の子として <a> 要素は不要になりました。従来の動作を使用する場合は legacyBehavior プロップを追加するか、アップグレードするために <a> を削除してください。コードを自動的にアップグレードするための codemod が利用可能です。

補足: legacyBehavior が true に設定されていない場合、className、onClick などのすべての anchor タグのプロパティを next/link に渡すこともできます。

passHref

Link に href プロパティを子に強制的に送信させます。デフォルトは false です。詳細は関数コンポーネントの入れ子の例を参照してください。

scroll

ナビゲーション後にページの先頭にスクロールします。デフォルトは true です。

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

shallow

getStaticProps、getServerSideProps、または getInitialProps を再実行せずに、現在のページのパスを更新します。デフォルトは false です。

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

locale

アクティブなロケールは自動的に先頭に付加されます。locale は異なるロケールを指定できます。false の場合、デフォルトの動作が無効になるため、href にロケールを含める必要があります。

pages/index.tsx
TypeScript
import Link from 'next/link'
 
export default function Home() {
  return (
    <>
      {/* デフォルトの動作: ロケールが先頭に付加される */}
      <Link href="/dashboard">Dashboard (with locale)</Link>
 
      {/* ロケールの先頭付加を無効化 */}
      <Link href="/dashboard" locale={false}>
        Dashboard (without locale)
      </Link>
 
      {/* 異なるロケールを指定 */}
      <Link href="/dashboard" locale="fr">
        Dashboard (French)
      </Link>
    </>
  )
}

例

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

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

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

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

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

components/nav-link.tsx
TypeScript
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でラップする必要があります：

pages/index.tsx
TypeScript
import Link from 'next/link'
import React from 'react'
 
// MyButtonのプロップスの型を定義
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 Home() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

URLオブジェクトの受け渡し

LinkはURLオブジェクトも受け取ることができ、自動的にURL文字列を作成します：

pages/index.ts
TypeScript
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を置き換える代わりにプッシュ

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

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

ページ上部へのスクロール無効化

Linkのデフォルトの動作は、ページ上部にスクロールすることです。ハッシュが定義されている場合、通常の<a>タグのように、特定のIDにスクロールします。上部/ハッシュへのスクロールを防ぐには、Linkにscroll={false}を追加できます:

pages/index.tsx
TypeScript
import Link from 'next/link'
 
export default function Home() {
  return (
    <Link href="/#hashid" scroll={false}>
      ページ上部へのスクロールを無効化
    </Link>
  )
}

Middlewareでのリンクプリフェッチ

Middlewareを認証やその他の目的で使用して、ユーザーを別のページに書き換えることは一般的です。<Link />コンポーネントが中間件を介したリライト付きのリンクを適切にプリフェッチするには、表示するURLとプリフェッチするURLの両方をNext.jsに伝える必要があります。これは、プリフェッチする正しいルートを知るために、中間件への不要なフェッチを避けるために必要です。

例えば、認証済みとゲスト用のビューを持つ/dashboardルートを提供する場合、以下のようにMiddlewareでユーザーを正しいページにリダイレクトできます:

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

pages/index.tsx
TypeScript
'use client'
 
import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed' // 認証フック
 
export default function Home() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href href={path}>
      ダッシュボード
    </Link>
  )
}
pages/index.js
'use client'
 
import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed' // 認証フック
 
export default function Home() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      ダッシュボード
    </Link>
  )
}

補足: 動的ルートを使用している場合、asとhrefのプロップを適応させる必要があります。たとえば、中間件を介して異なるように表示したい/dashboard/authed/[user]のような動的ルートがある場合、<Link href={{ pathname: '/dashboard/authed/[user]', query: { user: username } }} as="/dashboard/[user]">プロフィール</Link>と記述します。

バージョン履歴

バージョン変更点
v13.0.0子<a>タグが不要になりました。コードベースを自動的に更新するためのcodemodが提供されています。
v10.0.0動的ルートを指すhrefプロップは自動的に解決され、asプロップが不要になりました。
v8.0.0プリフェッチのパフォーマンスが改善されました。
v1.0.0next/linkが導入されました。