useParams

useParams 是一个客户端组件 (Client Component) 钩子，用于读取当前 URL 填充的动态路由参数。

'use client'

import { useParams } from 'next/navigation'

export default function ExampleClientComponent() {
  const params = useParams<{ tag: string; item: string }>()

  // 路由 -> /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，待路由准备就绪后会按照上述规则更新属性

示例：

路由	URL	`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` 功能。

参数

返回值

版本历史

On this page