docs: add useSearchParams and useParams documentation for Pages Router #88429
+560
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
samselikoff
reviewed
Jan 14, 2026
| const router = useRouter() | ||
| const searchParams = useSearchParams() | ||
|
|
||
| const createQueryString = useCallback( |
Contributor
There was a problem hiding this comment.
Don't think we need useCallback here?
Member
Author
There was a problem hiding this comment.
It's the same in the existing documentation: https://github.com/vercel/next.js/blob/canary/docs/01-app/03-api-reference/04-functions/use-search-params.mdx#L292
samselikoff
requested changes
Jan 14, 2026
Contributor
samselikoff
left a comment
There was a problem hiding this comment.
Think the useCallback is premature, should we remove it?
Member
Author
|
Yeah it doesn't make sense in that context 👍 |
Member
Author
|
Actually it's the same as the current useSearchParams documentation |
samselikoff
approved these changes
Jan 14, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds dedicated documentation pages for
useSearchParamsanduseParamshooks in the Pages Router documentation.Changes
docs/02-pages/04-api-reference/03-functions/use-search-params.mdxdocs/02-pages/04-api-reference/03-functions/use-params.mdxWhy
Both
useSearchParamsanduseParamsfromnext/navigationwork in the Pages Router, but this was not well documented. The only mention was a brief note in the App Router docs and a migration section in the Pages RouteruseRouterdocs.What's Documented
For both hooks:
nullduring pre-renderinggetServerSideProps(where params are immediately available)For
useParamsspecifically:router.query(which includes both dynamic params and query string params)Related Test
The existing test at
test/e2e/app-dir/params-hooks-compatvalidates that these hooks work in both routers.