Skip to content

Commit f23fbf6

Browse files
jacobsfletchjacobsfletch
authored
refactor(ui): remove deprecated ParamsProvider and SearchParamsProvider (#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.
1 parent 725276f commit f23fbf6

4 files changed

Lines changed: 34 additions & 131 deletions

File tree

‎packages/ui/src/exports/client/index.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -421,22 +421,22 @@ export {
421421
export { ListQueryProvider, useListQuery } from '../../providers/ListQuery/index.js'
422422
export { LocaleProvider, useLocale } from '../../providers/Locale/index.js'
423423
export { OperationProvider, useOperation } from '../../providers/Operation/index.js'
424-
export { ParamsProvider, useParams } from '../../providers/Params/index.js'
425424
export { PreferencesProvider, usePreferences } from '../../providers/Preferences/index.js'
426425
export { RootProvider } from '../../providers/Root/index.js'
427426
export {
428427
PayloadLink,
429428
RouterAdapterContext,
429+
useParams,
430430
usePathname,
431431
useRouter,
432+
useSearchParams,
432433
} from '../../providers/RouterAdapter/index.js'
433434
export type { RouterAdapterContextValue } from '../../providers/RouterAdapter/index.js'
434435
export {
435436
RouteCache as RouteCacheProvider,
436437
useRouteCache,
437438
} from '../../providers/RouteCache/index.js'
438439
export { ScrollInfoProvider, useScrollInfo } from '../../providers/ScrollInfo/index.js'
439-
export { SearchParamsProvider, useSearchParams } from '../../providers/SearchParams/index.js'
440440
export { SelectionProvider, useSelection } from '../../providers/Selection/index.js'
441441
export {
442442
DocumentSelectionProvider,

‎packages/ui/src/providers/Params/index.tsx‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎packages/ui/src/providers/Root/index.tsx‎

Lines changed: 32 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,9 @@ import { ConfigProvider } from '../Config/index.js'
3030
import { DocumentEventsProvider } from '../DocumentEvents/index.js'
3131
import { HierarchyProvider } from '../Hierarchy/index.js'
3232
import { LocaleProvider } from '../Locale/index.js'
33-
import { ParamsProvider } from '../Params/index.js'
3433
import { PreferencesProvider } from '../Preferences/index.js'
3534
import { RouteCache } from '../RouteCache/index.js'
3635
import { RouteTransitionProvider } from '../RouteTransition/index.js'
37-
import { SearchParamsProvider } from '../SearchParams/index.js'
3836
import { ServerFunctionsProvider } from '../ServerFunctions/index.js'
3937
import { ThemeProvider } from '../Theme/index.js'
4038
import { ToastContainer } from '../ToastContainer/index.js'
@@ -104,46 +102,38 @@ export const RootProvider: React.FC<Props> = ({
104102
}}
105103
>
106104
<ScrollInfoProvider>
107-
<SearchParamsProvider>
108-
<ModalProvider
109-
classPrefix="payload"
110-
transTime={0}
111-
zIndex="var(--z-modal)"
112-
>
113-
<CloseModalOnRouteChange />
114-
<AuthProvider permissions={permissions} user={user}>
115-
<PreferencesProvider>
116-
<HierarchyProvider>
117-
<ThemeProvider highContrastMode={highContrastMode} theme={theme}>
118-
<ParamsProvider>
119-
<LocaleProvider locale={locale}>
120-
<StepNavProvider>
121-
<LoadingOverlayProvider>
122-
<DocumentEventsProvider>
123-
<NavProvider initialIsOpen={isNavOpen}>
124-
<UploadHandlersProvider>
125-
<DndContext
126-
collisionDetection={pointerWithin}
127-
// Provide stable ID to fix hydration issues: https://github.com/clauderic/dnd-kit/issues/926
128-
id={dndContextID}
129-
>
130-
{children}
131-
</DndContext>
132-
</UploadHandlersProvider>
133-
</NavProvider>
134-
</DocumentEventsProvider>
135-
</LoadingOverlayProvider>
136-
</StepNavProvider>
137-
</LocaleProvider>
138-
</ParamsProvider>
139-
</ThemeProvider>
140-
</HierarchyProvider>
141-
</PreferencesProvider>
142-
<ModalContainer />
143-
<StayLoggedInModal />
144-
</AuthProvider>
145-
</ModalProvider>
146-
</SearchParamsProvider>
105+
<ModalProvider classPrefix="payload" transTime={0} zIndex="var(--z-modal)">
106+
<CloseModalOnRouteChange />
107+
<AuthProvider permissions={permissions} user={user}>
108+
<PreferencesProvider>
109+
<HierarchyProvider>
110+
<ThemeProvider highContrastMode={highContrastMode} theme={theme}>
111+
<LocaleProvider locale={locale}>
112+
<StepNavProvider>
113+
<LoadingOverlayProvider>
114+
<DocumentEventsProvider>
115+
<NavProvider initialIsOpen={isNavOpen}>
116+
<UploadHandlersProvider>
117+
<DndContext
118+
collisionDetection={pointerWithin}
119+
// Provide stable ID to fix hydration issues: https://github.com/clauderic/dnd-kit/issues/926
120+
id={dndContextID}
121+
>
122+
{children}
123+
</DndContext>
124+
</UploadHandlersProvider>
125+
</NavProvider>
126+
</DocumentEventsProvider>
127+
</LoadingOverlayProvider>
128+
</StepNavProvider>
129+
</LocaleProvider>
130+
</ThemeProvider>
131+
</HierarchyProvider>
132+
</PreferencesProvider>
133+
<ModalContainer />
134+
<StayLoggedInModal />
135+
</AuthProvider>
136+
</ModalProvider>
147137
</ScrollInfoProvider>
148138
</WindowInfoProvider>
149139
</TranslationProvider>

‎packages/ui/src/providers/SearchParams/index.tsx‎

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)