useParams

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

'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) 的对象。

  • 对象中的每个属性都是一个活跃的动态段 (dynamic segment)
  • 属性名对应段的名称,属性值对应段被填充的内容
  • 属性值可能是 stringstring 数组,具体取决于动态段的类型
  • 如果路由不包含动态参数,useParams 返回空对象
  • pages 中使用时,useParams 会返回 null

例如:

路由URLuseParams()
app/shop/page.js/shopnull
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