リンクとナビゲート
ルート間のナビゲーションには 3 つの方法があります:
このページではこれらの各オプションの使い方を説明し、ナビゲーションの仕組みについて深く掘り下げていきます。
<Link>
コンポーネント
<Link>
は HTML の <a>
要素を拡張した React コンポーネントで、プリフェッチ とルート間のクライアントサイドナビゲーションを提供します。Next.js でルート間をナビゲートする主要な方法です。
<Link>
を使うには、next/link
からインポートし、href
プロパティをコンポーネントに渡します。
import Link from 'next/link'
export default function Page() {
return <Link href="/dashboard">Dashboard</Link>
}
<Link>
に渡すことができるオプションについて詳しくはAPI リファレンスを参照してください。
例
動的 Segment へのリンク
動的セグメントにリンクするとき、リンクのリストを生成するためにテンプレートリテラルと補間を使うことができます。例えば、ブログ記事のリストを生成するには、次のようにします。
import Link from 'next/link'
export default function PostList({ posts }) {
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 Navigation({ navLinks }) {
const pathname = usePathname()
return (
<>
{navLinks.map((link) => {
const isActive = pathname.startsWith(link.href)
return (
<Link
className={isActive ? 'text-blue' : 'text-black'}
href={link.href}
key={link.name}
>
{link.name}
</Link>
)
})}
</>
)
}
ID
へのスクロール
Next.js App Router のデフォルトの動作は、新しいルートの先頭までスクロールするか、前後方向のナビゲーションのためにスクロール位置を維持します。
ナビゲーションで特定の ID
にスクロールしたい場合は、URL に#
ハッシュリンクを付加するか、href
prop にハッシュリンクを渡します。これは、<Link>
が<a>
要素にレンダリングされるので可能です。
<Link>
のデフォルトの動作は、変更されたルートセグメントの先頭にスクロールするです。href
に id
が定義されている場合、通常の <a>
タグと同様に、特定の id
までスクロールします。
ルート Segment の先頭までスクロールしないようにするには、scroll={false}
を設定して href
にハッシュ化された id
を追加します:
<Link href="/dashboard#settings">Settings</Link>
// Output
<a href="/dashboard#settings">Settings</a>
スクロールの復元を無効にする
Next.js App Router のデフォルトの動作は、新しいルートの先頭にスクロールするか、前後方向のナビゲーションのスクロール位置を維持します。この動作を無効にしたい場合は、<Link>
コンポーネントに scroll={false}
を渡すか、router.push()
または router.replace()
に scroll: false
を渡します。
// next/link
<Link href="/dashboard" scroll={false}>
Dashboard
</Link>
// useRouter
import { useRouter } from 'next/navigation'
const router = useRouter()
router.push('/dashboard', { scroll: false })
useRouter()
フック
useRouter
フックを使うと、Client Components 内のルートをプログラムで変更できます。
Server Components の場合は、代わりに redirect()
を使用します。
'use client'
import { useRouter } from 'next/navigation'
export default function Page() {
const router = useRouter()
return (
<button type="button" onClick={() => router.push('/dashboard')}>
Dashboard
</button>
)
}
useRouter メソッドの全リストはAPI リファレンスを参照してください。
推奨:
useRouter
を使用する特別な要件がない限り、ルート間を移動するには<Link>
コンポーネントを使用してください。
ネイティブ History API
Next.js では、ネイティブの window.history.pushState
メソッドと window.history.replaceState
メソッドを使用して、ページをリロードせずにブラウザの履歴スタックを更新できます。
pushState
および replaceState
の呼び出しは Next.js ルーターに統合され、usePathname
および useSearchParams
と同期できるようになります。
window.history.pushState
ブラウザの履歴スタックに新しいエントリーを追加するために使用します。ユーザーは前の状態に戻ることができます。例えば、商品リストをソートする場合などです:
'use client'
import { useSearchParams } from 'next/navigation'
export default function SortProducts() {
const searchParams = useSearchParams()
function updateSorting(sortOrder: string) {
const params = new URLSearchParams(searchParams.toString())
params.set('sort', sortOrder)
window.history.pushState(null, '', `?${params.toString()}`)
}
return (
<>
<button onClick={() => updateSorting('asc')}>Sort Ascending</button>
<button onClick={() => updateSorting('desc')}>Sort Descending</button>
</>
)
}
window.history.replaceState
ブ ラウザの履歴スタックの現在のエントリを置き換えるために使用します。ユーザーは前の状態に戻ることはできません。例えば、アプリケーションのロケールを切り替える場合などです:
'use client'
import { usePathname } from 'next/navigation'
export function LocaleSwitcher() {
const pathname = usePathname()
function switchLocale(locale: string) {
// e.g. '/en/about' or '/fr/contact'
const newPath = `/${locale}${pathname}`
window.history.replaceState(null, '', newPath)
}
return (
<>
<button onClick={() => switchLocale('en')}>English</button>
<button onClick={() => switchLocale('fr')}>French</button>
</>
)
}
ナビゲーションの仕組み
App Router は、ルーティングとナビゲーションのハイブリッド・アプローチを採用しています。サーバー上では、アプリケーションコード は自動的にルートセグメントによってコード分割されます。そしてクライアントでは、Next.js がルートセグメントをプリフェッチしてキャッシュします。つまり、ユーザーが新しいルートに移動しても、ブラウザはページをリロードせず、変更されたルートセグメントだけが再レンダリングされます。
1. コード分割
コード分割により、アプリケーションコードを小さなバンドルに分割し、ブラウザでダウンロードして実行することができます。これにより、各リクエストのデータ転送量と実行時間が削減され、パフォーマンスが向上します。
Server Components を使用すると、アプリケーションコードをルートセグメントごとに自動的にコード分割することができます。つまり、現在のルートに必要なコードだけがナビゲーション時に読み込まれます。
2. プリフェッチ
プリフェッチはルートが訪問される前にバックグラウンドでプリロードする方法です。
Next.js でルートがプリフェッチされる方法は 2 つあります:
<Link>
コンポーネント: ルートは、ユーザのビューポートに表示 されるようになると、自動的にプリフェッチされます。プリフェッチは、ページが最初にロードされたときや、スクロールによって表示されたときに行われます。router.prefetch()
:useRouter
フックはプログラムでルートをプリフェッチするために使うことができます。
<Link>
のプリフェッチ動作は、静的ルートと動的ルートで異なります:
- 静的ルート:
prefetch
のデフォルトはtrue
です。ルート全体がプリフェッチされ、キャッシュされます。 - 動的ルート:
prefetch
のデフォルトは自動です。最初のloading.js
ファイルまでの共有レイアウトのみがプリフェッチされ、30
秒間キャッシュされます。これは動的なルート全体をフェッチするコストを削減し、ユーザーへの視覚的なフィードバックを改善するためにロード状態を即座に表示できることを意味します。
prefetch
prop をfalse
に設定することで、プリフェッチを無効にすることができます。
詳細は<Link>
API リファレンスを参照。
Good to know:
- プリフェッチは開発では有効ではなく、本番でのみ有効です。
3. キャッシュ
Next.js には、ルーターキャッシュと呼ばれるインメモリーのクライアントサイドキャッシュがあります。ユーザーがアプリ内を移動すると、プリフェッチされたルートセグメントと到達したルートの React Server Component Payload がキャッシュに保存されます。
つまり、ナビゲーションの際、サーバーに新たなリクエストをするのではなく、キャッシュを可能な限り再利用し、リクエストとデータ転送の回数を減らすことでパフォーマンスを向上させます。
ルーターキャッシュの仕組みと設定方法については、こちらをご覧ください。
4. 部分レンダリング
部分レンダリングとは、ナビゲーションで変更されたルートセグメントのみがクライアントで再レンダリングされ、共有セグメントは保存されることを意味します。
たとえば、/dashboard/settings
と /dashboard/analytics
という 2 つのルート間をナビゲートする場合、settings
と analytics
ページがレンダリングされ、共有された dashboard
のレイアウトは保持されます。
部分レンダリングがなければ、ナビゲーションのたびにページ全体がサーバー上で再レンダリングされることになります。変更されたセグメントのみをレンダリングすることで、転送されるデータ量と実行時間が削減され、パフォーマンスの向上につながります。
5. ソフト・ナビゲーション
デフォルトでは、ブラウザはページ間でハードナビゲーションを実行します。これは、ブラウザがページをリロードし、アプリの useState
フックなどの React の状態と、ユーザーのスクロール位置やフォーカスされた要素などのブラウザの状態をリセットすることを意味します。しかし Next.js では、アプリルーターはソフトナビゲーションを使用します。つまり、React とブラウザの状態を保持したまま、React は変更されたセグメントだけをレンダリングし、ページ全体をリロードすることはありません。