useParams is a Client Component hook that lets you read a route's dynamic params filled in by the current URL.

'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 '...'
}

'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 '...'
}

Parameters

const params = useParams()

useParams does not take any parameters.

Returns

useParams returns an object containing the current route's filled in dynamic parameters.

• Each property in the object is an active dynamic segment.
• The properties name is the segment's name, and the properties value is what the segment is filled in with.
• The properties value will either be a string or array of string's depending on the type of dynamic segment.
• If the route contains no dynamic parameters, useParams returns an empty object.
• If used in Pages Router, useParams will return null on the initial render and updates with properties following the rules above once the router is ready.

For example:

Behavior

Cache Components

When cacheComponents is enabled, useParams may require a Suspense boundary. This depends on whether the params can be resolved during prerendering.

• Static routes and routes with generateStaticParams: every dynamic param is known at build time. useParams resolves on the server and no Suspense boundary is required.
• Routes with dynamic params not covered by generateStaticParams: the param is not known until request time. useParams suspends. Wrap the component (or a parent) in a Suspense boundary so its fallback can be rendered during prerendering; otherwise, the build fails.

See Next.js encountered URL data in a Client Component outside of Suspense for full fix options and trade-offs.

Version History

Source: docs/01-app/03-api-reference/04-functions/use-params.mdx