リンクとナビゲーション

Next.jsのルーターを使用すると、シングルページアプリケーション（SPA）と同様に、ページ間でクライアントサイドのルート遷移を行うことができます。

このクライアントサイドルート遷移を行うために、LinkというReactコンポーネントが提供されています。

import Link from 'next/link'

function Home() {
  return (
    <ul>
      <li>
        <Link href="/">Home</Link>
      </li>
      <li>
        <Link href="/about">About Us</Link>
      </li>
      <li>
        <Link href="/blog/hello-world">Blog Post</Link>
      </li>
    </ul>
  )
}

export default Home

上記の例では複数のリンクを使用しています。各リンクはパス（href）を既知のページにマッピングしています：

/ → pages/index.js
/about → pages/about.js
/blog/hello-world → pages/blog/[slug].js

ビューポート内（初期表示時またはスクロールによる）のすべての<Link />は、静的生成（Static Generation）を使用するページに対して、デフォルトでプリフェッチされます（対応するデータを含む）。サーバーサイドレンダリング（SSR）ルートの対応データは、<Link />がクリックされた時点でのみフェッチされます。

動的パスへのリンク

動的ルートセグメントでは、パスを作成するために文字列補間も使用できます。例えば、コンポーネントにプロップとして渡された投稿のリストを表示する場合：

import Link from 'next/link'

function Posts({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${encodeURIComponent(post.slug)}`}>
            {post.title}
          </Link>
        </li>
      ))}
    </ul>
  )
}

export default Posts

この例では、パスをUTF-8互換に保つためにencodeURIComponentを使用しています。

または、URLオブジェクトを使用する方法：

import Link from 'next/link'

function Posts({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link
            href={{
              pathname: '/blog/[slug]',
              query: { slug: post.slug },
            }}
          >
            {post.title}
          </Link>
        </li>
      ))}
    </ul>
  )
}

export default Posts

この場合、パスを作成するために文字列補間を使用する代わりに、href内でURLオブジェクトを使用しています：

pathnameはpagesディレクトリ内のページ名（この場合は/blog/[slug]）
queryは動的セグメントを持つオブジェクト（この場合はslug）

ルーターの注入

Reactコンポーネント内でrouterオブジェクトにアクセスするには、useRouterまたはwithRouterを使用できます。

一般的にはuseRouterの使用を推奨します。

命令的なルーティング

next/linkでほとんどのルーティングニーズをカバーできますが、それを使用せずにクライアントサイドナビゲーションを行うこともできます。next/routerのドキュメントを参照してください。

以下の例は、useRouterを使用した基本的なページナビゲーションの方法を示しています：

import { useRouter } from 'next/router'

export default function ReadMore() {
  const router = useRouter()

  return (
    <button onClick={() => router.push('/about')}>
      Click here to read more
    </button>
  )
}

シャロー（浅い）ルーティング

例

シャロー・ルーティング

シャロー・ルーティングを使用すると、getServerSideProps、getStaticProps、getInitialPropsなどのデータフェッチングメソッドを再実行せずにURLを変更できます。

useRouterまたはwithRouterによって追加されるrouterオブジェクトから、状態を失うことなく更新されたpathnameとqueryを受け取ります。

シャロー・ルーティングを有効にするには、shallowオプションをtrueに設定します。以下の例を参照してください：

import { useEffect } from 'react'
import { useRouter } from 'next/router'

// 現在のURLは '/'
function Page() {
  const router = useRouter()

  useEffect(() => {
    // 初回レンダリング後にナビゲーションを実行
    router.push('/?counter=10', undefined, { shallow: true })
  }, [])

  useEffect(() => {
    // counterが変更されました！
  }, [router.query.counter])
}

export default Page

URLは/?counter=10に更新されますが、ページは置き換えられず、ルートの状態のみが変更されます。

以下のようにcomponentDidUpdateを使用してURLの変更を監視することもできます：

componentDidUpdate(prevProps) {
  const { pathname, query } = this.props.router
  // 無限ループを避けるためにプロップが変更されたことを確認
  if (query.counter !== prevProps.router.query.counter) {
    // 新しいクエリに基づいてデータをフェッチ
  }
}

注意点

シャロー・ルーティングは現在のページのURL変更に対してのみ機能します。例えば、pages/about.jsという別のページがある場合に以下を実行すると：

router.push('/?counter=10', '/about?counter=10', { shallow: true })

これは新しいページであるため、現在のページをアンロードし、新しいページをロードしてデータフェッチを待機します（シャロー・ルーティングを指定した場合でも）。

シャロー・ルーティングがミドルウェアと共に使用される場合、以前のように新しいページが現在のページと一致することを保証しません。これはミドルウェアが動的に書き換える可能性があり、データフェッチなしではクライアントサイドで検証できないためです（シャロー・ルーティングではスキップされます）。そのため、シャロー・ルート変更は常に浅いものとして扱う必要があります。

リンクとナビゲーション

動的パスへのリンク

ルーターの注入

命令的なルーティング

シャロー（浅い）ルーティング

注意点

On this page