Menu

useParams

useParams 是一个 Client Component hook，它允许你读取由当前 URL 填充的路由的动态参数。

app/example-client-component.tsx
TypeScript
'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{ slug: ['1', '2'] }

版本历史

版本变更
v13.3.0引入 useParams。