useRouter

useRouter フックを使用すると、クライアントコンポーネント内でプログラム的にルートを変更できます。

推奨事項: 特に useRouter を使用する必要がない限り、ナビゲーションには <Link> コンポーネントを使用してください。

'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()`

router.push(href: string, { scroll: boolean }): 指定されたルートへクライアントサイドナビゲーションを実行します。ブラウザの履歴スタックに新しいエントリを追加します。
router.replace(href: string, { scroll: boolean }): 指定されたルートへクライアントサイドナビゲーションを実行しますが、ブラウザの履歴スタックに新しいエントリを追加しません。
router.refresh(): 現在のルートを更新します。サーバーに新しいリクエストを送信し、データリクエストを再取得し、サーバーコンポーネントを再レンダリングします。クライアントは影響を受けないクライアントサイドの React（例: useState）やブラウザの状態（例: スクロール位置）を失うことなく、更新された React サーバーコンポーネントのペイロードをマージします。
router.prefetch(href: string): クライアントサイドの遷移を高速化するため、指定されたルートをプリフェッチします。
router.back(): ブラウザの履歴スタックで前のルートに戻ります。
router.forward(): ブラウザの履歴スタックで次のページに進みます。

知っておくと良いこと:

router.push や router.replace に信頼できないまたはサニタイズされていない URL を送信してはいけません。これはサイトをクロスサイトスクリプティング（XSS）の脆弱性にさらす可能性があります。例えば、javascript: URL を router.push や router.replace に送信すると、ページのコンテキストで実行されます。

<Link> コンポーネントは、ビューポート内で表示されたルートを自動的にプリフェッチします。

フェッチリクエストがキャッシュされている場合、refresh() は同じ結果を再生成する可能性があります。cookies や headers などの他の動的 API もレスポンスを変更する可能性があります。

`next/router` からの移行

App Router を使用する場合、useRouter フックは next/router ではなく next/navigation からインポートする必要があります
pathname 文字列は削除され、usePathname() に置き換えられました
query オブジェクトは削除され、useSearchParams() に置き換えられました
router.events は置き換えられました。下記を参照

完全な移行ガイドを参照。

例

ルーターイベント

usePathname や useSearchParams などの他のクライアントコンポーネントフックを組み合わせることで、ページ変更を監視できます。

app/components/navigation-events.js

'use client'

import { useEffect } from 'react'
import { usePathname, useSearchParams } from 'next/navigation'

export function NavigationEvents() {
  const pathname = usePathname()
  const searchParams = useSearchParams()

  useEffect(() => {
    const url = `${pathname}?${searchParams}`
    console.log(url)
    // 現在の URL を使用できます
    // ...
  }, [pathname, searchParams])

  return '...'
}

これはレイアウトにインポートできます。

app/layout.js

import { Suspense } from 'react'
import { NavigationEvents } from './components/navigation-events'

export default function Layout({ children }) {
  return (
    <html lang="en">
      <body>
        {children}

        <Suspense fallback={null}>
          <NavigationEvents />
        </Suspense>
      </body>
    </html>
  )
}

知っておくと良いこと: useSearchParams() は静的レンダリング中に、最も近い Suspense バウンダリまでクライアントサイドレンダリングを引き起こすため、<NavigationEvents> は Suspense バウンダリでラップされています。詳細はこちら。

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

デフォルトでは、Next.js は新しいルートにナビゲートする際にページのトップにスクロールします。この動作を無効にするには、router.push() または router.replace() に scroll: false を渡します。

'use client'

import { useRouter } from 'next/navigation'

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

  return (
    <button
      type="button"
      onClick={() => router.push('/dashboard', { scroll: false })}
    >
      Dashboard
    </button>
  )
}

バージョン履歴

バージョン	変更内容
`v13.0.0`	`next/navigation` からの `useRouter` が導入されました。

useRouter()

next/router からの移行

例

ルーターイベント

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

バージョン履歴

On this page

`useRouter()`

`next/router` からの移行