fix(ui): self managed field paths #12290
Closed
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
|
Hey @jacobsfletch can we get this going? This issue will also be fixed by this PR |
|
Closing in favor of #13806. It's possible I can pick back up on this in the future, but it may require some more substantial changes in architecture. @jonathanelmgren I left some notes in that PR on how to move forward for now. |
jacobsfletch
added a commit
that referenced
this pull request
Sep 15, 2025
Fixes #12286. Supersedes #12290. As of [v3.35.0](https://github.com/payloadcms/payload/releases/tag/v3.35.0), you are no longer able to directly pass a `path` prop to a custom field component. For example: ```tsx 'use client' import React from 'react' import { TextField } from '@payloadcms/ui' import type { TextFieldClientComponent } from 'payload' export const MyCustomField: TextFieldClientComponent = (props) => { return ( <TextField {...props} path="path.to.some.other.field" // This will not be respected, because this field's context takes precedence /> ) } ``` This was introduced in #11973 where we began passing a new `potentiallyStalePath` arg to the `useField` hook that takes the path from context as priority. This change was necessary in order to fix stale paths during row manipulation while the server is processing. To ensure field components respect your custom path, you need to wrap your components with their own `FieldPathContext`: ```tsx 'use client' import React from 'react' import { TextField, FieldPathContext } from '@payloadcms/ui' import type { TextFieldClientComponent } from 'payload' export const MyCustomField: TextFieldClientComponent = (props) => { return ( <FieldPathContext path="path.to.some.other.field"> <TextField {...props} /> </FieldPathContext> ) } ``` It's possible we can remove this in the future. I explored this in #12290, but it may require some more substantial changes in architecture. These exports are labeled experimental to allow for any potential changes in behavior that we may need to make in the future. --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1210533177582945
|
@jacobsfletch Thx for context. I raised this PR as a targeted fix for #13764, since it seems consistent with the direction suggested in #13806 (explicitly enforcing field paths). |
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.
Fixes #12286. Self managed fields, i.e. custom fields that define their own path as a prop, consume their parent's path instead of the path that was given to them.
This was introduced in #11973 where we began passing a new
potentiallyStalePatharg to theuseFieldhook that takes the path from context as priority. This change was necessary in order to fix stale paths during row manipulation while the server is processing.This change, however, made it so that custom fields could no longer control their own path.
The fix is to lift the
potentiallyStalePathlogic out of Payload's default fields and pass it as a direct prop. This way thepathprop is still available for direct use.