refactor: deprecates params and search params contexts#9581
Merged
Conversation
… unneeded, and cause stale state
Contributor
|
🚀 This is included in version v3.3.0 |
kendelljoseph
pushed a commit
that referenced
this pull request
Feb 21, 2025
As described in #9576, the `SearchParamsProvider` can become stale when navigating routes and relying on search params during initial render. This is because this context, along with the `ParamsProvider`, is duplicative to the internal lifecycle of `useSearchParams` and `useParams` from `next/navigation`– but always one render behind. Instead, we need to use the hooks directly from `next/navigation` as described in the jsdocs. This will also remove any abstraction over top the web standard for `URLSearchParams`. For this reason, these providers and their corresponding hooks have been marked with the deprecated flag and will continue to behave as they do now, but will be removed in the next major release. This PR replaces all internal reliance on these hooks with `next/navigation` as suggested, except for the `useParams` hook, which was never used in the first place. ```diff 'use client' - import { useSearchParams } from '@payloadcms/ui' + import { useSearchParams } from 'next/navigation' + import { parseSearchParams } from '@payloadcms/ui' export function MyClientComponent() { - const { searchParams } = useSearchParams() + const searchParams = useSearchParams() + const parsedParams = parseSearchParams(searchParams) // ... } ``` _MyClientComponent.tsx_
jacobsfletch
added a commit
that referenced
this pull request
Jun 4, 2026
…er (#16884) Removes the `ParamsProvider` and `SearchParamsProvider` from `@payloadcms/ui`, which were deprecated in #9581 since [v3.3.0](https://github.com/payloadcms/payload/releases/tag/v3.3.0). The `useParams` and `useSearchParams` hooks remain available from `@payloadcms/ui` with identical usage — they now originate from the new [Router Adapter](#16763) instead of these dedicated context providers. No migration steps are needed.
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
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.
As described in #9576, the
SearchParamsProvidercan become stale when navigating routes and relying on search params during initial render. This is because this context, along with theParamsProvider, is duplicative to the internal lifecycle ofuseSearchParamsanduseParamsfromnext/navigation– but always one render behind. Instead, we need to use the hooks directly fromnext/navigationas described in the jsdocs. This will also remove any abstraction over top the web standard forURLSearchParams.For this reason, these providers and their corresponding hooks have been marked with the deprecated flag and will continue to behave as they do now, but will be removed in the next major release. This PR replaces all internal reliance on these hooks with
next/navigationas suggested, except for theuseParamshook, which was never used in the first place.MyClientComponent.tsx