useParams

useParams 是一個客戶端組件 Hook，可讓您讀取目前 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，並在路由器準備就緒後，依照上述規則更新屬性。

例如

路由	網址	`useParams()`
`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.0`	引入 `useParams`。