コンテンツへスキップ

useParams

useParamsは、現在のURLによって入力されたルートの動的パラメータを読み取るための、**クライアントコンポーネント**フックです。

app/example-client-component.tsx
'use client'
 
import { useParams } from 'next/navigation'
 
export default function ExampleClientComponent() {
  const params = useParams<{ tag: string; item: string }>()
 
  // Route -> /shop/[tag]/[item]
  // URL -> /shop/shoes/nike-air-max-97
  // `params` -> { tag: 'shoes', item: 'nike-air-max-97' }
  console.log(params)
 
  return '...'
}

パラメータ

const params = useParams()

useParamsはパラメータを取りません。

戻り値

useParamsは、現在のルートに入力された動的パラメータを含むオブジェクトを返します。

  • オブジェクト内の各プロパティは、アクティブな動的セグメントです。
  • プロパティ名はセグメントの名前であり、プロパティの値はセグメントに入力されている値です。
  • プロパティの値は、動的セグメントの種類に応じて、stringまたはstringの配列になります。
  • ルートに動的パラメータが含まれていない場合、useParamsは空のオブジェクトを返します。
  • Pages Routerで使用した場合、useParamsは最初のレンダリング時にnullを返し、ルーターの準備が整うと上記のルールに従ってプロパティが更新されます。

例:

ルートURLuseParams()
app/shop/page.js/shop{}
app/shop/[slug]/page.js/shop/1{ slug: '1' }
app/shop/[tag]/[item]/page.js/shop/1/2{ tag: '1', item: '2' }
app/shop/[...slug]/page.js/shop/1/2/shop/1/2

{ slug: ['1', '2'] }

バージョン履歴 バージョン
変更v13.3.0