useParams

useParams は、現在の URL によって埋められたルートの動的パラメータ (dynamic params) を読み取ることができる クライアントコンポーネント (Client Component) 用フックです。

'use client'

import { useParams } from 'next/navigation'

export default function ExampleClientComponent() {
  const params = useParams()

  // Route -> /shop/[tag]/[item]
  // URL -> /shop/shoes/nike-air-max-97
  // `params` -> { tag: 'shoes', item: 'nike-air-max-97' }
  console.log(params)

  return <></>
}

'use client'

import { useParams } from 'next/navigation'

export default function ExampleClientComponent() {
  const params = useParams()

  // 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 は、現在のルートの動的パラメータ (dynamic parameters) が埋められたオブジェクトを返します。

オブジェクトの各プロパティはアクティブな動的セグメントです。
プロパティ名はセグメント名、プロパティ値はセグメントに埋め込まれた値です。
プロパティ値は動的セグメントのタイプに応じて string または string の配列になります。
ルートに動的パラメータが含まれていない場合、useParams は空のオブジェクトを返します。
pages で使用した場合、useParams は null を返します。

例:

ルート	URL	`useParams()`
`app/shop/page.js`	`/shop`	`null`
`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.0`	`useParams` が導入されました。

パラメータ

戻り値

バージョン履歴

On this page