Menu

リンクとナビゲーション

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

クライアントサイドのルート遷移を行うために、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
  • /aboutpages/about.js
  • /blog/hello-worldpages/blog/[slug].js

ビューポート内の任意の<Link />(最初または下にスクロールして)は、静的生成を使用するページのためにデフォルトでプリフェッチされます(対応するデータを含む)。サーバーレンダリングされたルートの対応するデータは、<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オブジェクトを使用しています:

  • pathnamepagesディレクトリ内のページ名です。この場合は /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>
  )
}

シャローRouting

シャローRoutingを使用すると、データ取得メソッドを再実行せずにURLを変更できます。これにはgetServerSidePropsgetStaticPropsgetInitialPropsが含まれます。

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

シャローRoutingを有効にするには、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(() => {
    // カウンターが変更された!
  }, [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) {
    // 新しいクエリに基づいてデータを取得
  }
}

注意点

シャローRoutingは、現在のページのURL変更に対してのみ機能します。例えば、pages/about.jsという別のページがあり、次のコードを実行するとします:

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

これは新しいページであるため、現在のページをアンロードし、新しいページをロードし、シャローRoutingを要求したにもかかわらず、データ取得を待機します。

ミドルウェアでシャローRoutingを使用する場合、以前のミドルウェアなしの動作とは異なり、新しいページが現在のページと一致することを保証できません。これは、ミドルウェアが動的に書き換えることができ、シャローによりスキップされるデータ取得なしではクライアントサイドで検証できないためです。したがって、シャローなルート変更は常にシャローとして扱う必要があります。