<Link>

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

例として、以下のファイルを持つ pages ディレクトリを考えます:

• pages/index.js
• pages/about.js
• pages/blog/[slug].js

これらのページへのリンクは次のように作成できます:

import Link from 'next/link'

function Home() {
  return (
    <ul>
      <li>
        <Link href="/">ホーム</Link>
      </li>
      <li>
        <Link href="/about">会社概要</Link>
      </li>
      <li>
        <Link href="/blog/hello-world">ブログ記事</Link>
      </li>
    </ul>
  )
}

export default Home

プロパティ

Linkコンポーネントで利用可能なプロパティの概要:

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

href (必須)

移動先のパスまたはURL。

<Link href="/dashboard">ダッシュボード</Link>

href はオブジェクトも受け入れ可能です:

// /about?name=test に移動
<Link
  href={{
    pathname: '/about',
    query: { name: 'test' },
  }}
>
  会社概要
</Link>

replace

デフォルトは false。 true の場合、next/link はブラウザの履歴スタックに新しいURLを追加する代わりに、現在の履歴状態を置き換えます。

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" replace>
      ダッシュボード
    </Link>
  )
}

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" replace>
      ダッシュボード
    </Link>
  )
}

scroll

デフォルトは true。 <Link> のデフォルト動作は、新しいルートのトップにスクロールするか、前後のナビゲーションでスクロール位置を維持します。false の場合、next/link はナビゲーション後にページのトップにスクロールしません。

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" scroll={false}>
      ダッシュボード
    </Link>
  )
}

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" scroll={false}>
      ダッシュボード
    </Link>
  )
}

豆知識:

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

prefetch

<Link /> コンポーネントがユーザーのビューポートに入ると（初期表示時またはスクロール時）、プリフェッチが発生します。Next.jsはリンクされたルート（href で示される）とデータをバックグラウンドでプリフェッチして読み込み、クライアントサイドナビゲーションのパフォーマンスを向上させます。プリフェッチは本番環境でのみ有効です。

• true (デフォルト): ルート全体とそのデータがプリフェッチされます。
• false: ビューポート進入時にはプリフェッチされませんが、ホバー時にはプリフェッチされます。ホバー時のプリフェッチも完全に無効にしたい場合は、<a> タグの使用やApp Routerへの段階的移行を検討してください。

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" prefetch={false}>
      ダッシュボード
    </Link>
  )
}

import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" prefetch={false}>
      ダッシュボード
    </Link>
  )
}

その他のプロパティ

legacyBehavior

<Link> の子要素として <a> 要素はもはや必要ありません。レガシー動作を使用するには legacyBehavior プロパティを追加するか、<a> を削除してアップグレードしてください。コードモッドが利用可能で、コードを自動的にアップグレードできます。

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

passHref

Link に href プロパティを子要素に強制的に渡させます。デフォルトは false

scroll

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

shallow

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

locale

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

使用例

動的ルートへのリンク

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

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

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

export default Posts

子要素が <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'

// `onClick`、`href`、`ref`は適切な処理のために
// DOM要素に渡す必要があります
const MyButton = React.forwardRef(({ onClick, href }, ref) => {
  return (
    <a href={href} onClick={onClick} ref={ref}>
      クリックしてください
    </a>
  )
})

function Home() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <MyButton />
    </Link>
  )
}

export default Home

URLオブジェクトを使用

LinkはURLオブジェクトも受け取り、自動的にフォーマットしてURL文字列を作成します。以下はその方法です:

import Link from 'next/link'

function Home() {
  return (
    <ul>
      <li>
        <Link
          href={{
            pathname: '/about',
            query: { name: 'test' },
          }}
        >
          会社概要
        </Link>
      </li>
      <li>
        <Link
          href={{
            pathname: '/blog/[slug]',
            query: { slug: 'my-post' },
          }}
        >
          ブログ記事
        </Link>
      </li>
    </ul>
  )
}

export default Home

上記の例では次のリンクが作成されます:

• 定義済みルート: /about?name=test
• 動的ルート: /blog/my-post

Node.js URLモジュールドキュメントで定義されているすべてのプロパティを使用できます。

URLをプッシュせずに置換

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

<Link href="/about" replace>
  会社概要
</Link>

ページトップへのスクロールを無効化

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

<Link href="/#hashid" scroll={false}>
  トップへのスクロールを無効化
</Link>

ミドルウェア

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

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

export function middleware(req) {
  const nextUrl = req.nextUrl
  if (nextUrl.pathname === '/dashboard') {
    if (req.cookies.authToken) {
      return NextResponse.rewrite(new URL('/auth/dashboard', req.url))
    } else {
      return NextResponse.rewrite(new URL('/public/dashboard', req.url))
    }
  }
}

この場合、<Link />コンポーネントで次のコードを使用します:

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}>
      ダッシュボード
    </Link>
  )
}

豆知識: 動的ルートを使用している場合、asとhrefプロパティを調整する必要があります。例えば、ミドルウェア経由で異なる方法で表示したい/dashboard/authed/[user]のような動的ルートがある場合、次のように記述します: <Link href={{ pathname: '/dashboard/authed/[user]', query: { user: username } }} as="/dashboard/[user]">プロフィール</Link>。

バージョン履歴