useParams
API Reference for the useParams hook in the Pages Router.
useParams is a hook that lets you read a route's dynamic params filled in by the current URL.
Parameters
useParams does not take any parameters.
Returns
useParams returns an object containing the current route's filled in dynamic parameters, or null during pre-rendering.
- Each property in the object is an active dynamic segment.
- The property name is the segment's name, and the property value is what the segment is filled in with.
- The property value will either be a
stringor array ofstrings depending on the type of dynamic segment. - If the route contains no dynamic parameters,
useParamsreturns an empty object.
For example:
| Route | URL | useParams() |
|---|---|---|
pages/shop/page.js | /shop | {} |
pages/shop/[slug].js | /shop/1 | { slug: '1' } |
pages/shop/[tag]/[item].js | /shop/1/2 | { tag: '1', item: '2' } |
pages/shop/[...slug].js | /shop/1/2 | { slug: ['1', '2'] } |
Good to know: useParams is a React Hook and cannot be used with classes.
Behavior
Behavior during pre-rendering
For pages that are statically optimized, useParams will return null on the initial render. After hydration, the value will be updated to the actual params once the router is ready.
This is because params cannot be known during static generation for dynamic routes.
Using with getServerSideProps
When using getServerSideProps, the page is server-rendered on each request and useParams will return the actual params immediately:
Comparison with router.query
useParams only returns the dynamic route parameters, whereas router.query from useRouter includes both dynamic parameters and query string parameters.
Examples
Sharing components with App Router
useParams from next/navigation works in both the Pages Router and App Router. This allows you to create shared components that work in either context:
Good to know: When using this component in the App Router, useParams never returns null, so the fallback branch will not be rendered.
Version History
| Version | Changes |
|---|---|
v13.3.0 | useParams introduced. |