コンテンツにスキップ

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 '...'
}

Parameters

const params = useParams()

useParams は、パラメータを一切受け取りません。

戻り値

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

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

例:

RouteURLuseParams()
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{ slug: ['1', '2'] }

バージョン履歴

バージョン変更履歴
v13.3.0useParams が導入されました。